Merged V2.2 to HEAD

7260: Basic JMX sys admin - to manage session/tickets and server modes such as read-only and single-user git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@8242 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2025-07-24 17:32:48 +00:00 · 2008-02-11 11:07:46 +00:00
parent 1041c6ceb0
commit 17b806c6c0
12 changed files with 603 additions and 14 deletions
--- a/source/java/org/alfresco/repo/admin/RepoServerMgmtMBean.java
+++ b/source/java/org/alfresco/repo/admin/RepoServerMgmtMBean.java
@@ -0,0 +1,139 @@
+/*
+ * Copyright (C) 2005-2007 Alfresco Software Limited.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+ * As a special exception to the terms and conditions of version 2.0 of
+ * the GPL, you may redistribute this Program in connection with Free/Libre
+ * and Open Source Software ("FLOSS") applications as described in Alfresco's
+ * FLOSS exception.  You should have recieved a copy of the text describing
+ * the FLOSS exception, and it is also available here:
+ * http://www.alfresco.com/legal/licensing"
+ */
+package org.alfresco.repo.admin;
+
+
+public interface RepoServerMgmtMBean
+{
+	/**
+	 * Set whether Repository allows writes or not
+	 * 
+	 * Note: This operation can be clustered (ie. all servers in the cluster will be affected)
+	 * 
+	 * @param readOnly  true is READONLY, false is WRITEABLE
+	 */
+	public void setReadOnly(boolean readOnly);
+	
+	/**
+	 * Does the Repository allows writes or not ?
+	 * 
+	 * Note: This operation can be clustered (ie. all servers in the cluster will be affected)
+	 * 
+	 * @return boolean  true is READONLY, false is WRITEABLE
+	 */
+	public boolean isReadOnly();
+	
+	/**
+	 * Get count of non-expired tickets
+	 * 
+	 * This may be higher than the user count, since a user can have more than one ticket/session
+	 * 
+	 * Note: This operation can be clustered (ie. all servers in the cluster will be affected)
+	 * 
+	 * @return int  number of non-expired tickets
+	 */
+	public int getTicketCountNonExpired();
+	
+	/**
+	 * Get count of all tickets
+	 * 
+	 * This may be higher than the user count, since a user can have more than one ticket/session
+	 * 
+	 * Note: This operation can be clustered (ie. all servers in the cluster will be affected)
+	 * 
+	 * @return int  number of tickets (non-expired and expired)
+	 */
+	public int getTicketCountAll();
+
+	/**
+	 * Get count of non-expired users
+	 * 
+	 * This may be lower than the ticket count, since a user can have more than one ticket/session
+	 * 
+	 * Note: This operation can be clustered (ie. all servers in the cluster will be affected)
+	 * 
+	 * @return int  number of non-expired users
+	 */
+	public int getUserCountNonExpired();
+	
+	/**
+	 * Get count of all users
+	 * 
+	 * This may be lower than the ticket count, since a user can have more than one ticket/session
+	 * 
+	 * Note: This operation can be clustered (ie. all servers in the cluster will be affected)
+	 * 
+	 * @return int  number of users (non-expired and expired)
+	 */
+	public int getUserCountAll();
+	
+	/**
+	 * Get set of unique non-expired usernames
+	 *
+	 * Note: This operation can be clustered (ie. all servers in the cluster will be affected)
+	 * 
+	 * @return String[] array of non-expired usernames
+	 */
+	public String[] listUserNamesNonExpired();
+	
+	/**
+	 * Get set of all unique usernames
+	 *
+	 * Note: This operation can be clustered (ie. all servers in the cluster will be affected)
+	 *
+	 * @return String[] array of all usernames (non-expired and expired)
+	 */
+	public String[] listUserNamesAll();
+	
+	/**
+	 * Invalidate expired tickets
+	 *
+	 * Note: This operation can be clustered (ie. all servers in the cluster will be affected)
+	 * 
+	 * @return int  count of expired invalidated tickets
+	 */
+	public int invalidateTicketsExpired();
+	
+	/**
+	 * Invalidate all tickets
+	 *
+	 * Note: This operation can be clustered (ie. all servers in the cluster will be affected)
+	 * 
+	 * @return int  count of all invalidated tickets (non-expired and expired)
+	 */
+	public int invalidateTicketsAll();
+	
+	/**
+	 * Set whether Repository allows single user mode or not
+	 * 
+	 * If single user mode is set then all tickets will be invalidated first before allowing the
+	 * named user to login (with one or more sessions)
+	 *
+	 * Note: This operation can be clustered (ie. all servers in the cluster will be affected)
+	 * 
+	 * @param String  allowed username (eg. 'admin') or null to unset (ie. allow all users)
+	 */
+	public void allowSingleUserOnly(String allowedUsername);
+}