org.apache.qpid.server.security.auth.management
Class AMQUserManagementMBean

java.lang.Object
  extended by javax.management.StandardMBean
      extended by org.apache.qpid.server.management.DefaultManagedObject
          extended by org.apache.qpid.server.management.AMQManagedObject
              extended by org.apache.qpid.server.security.auth.management.AMQUserManagementMBean
All Implemented Interfaces:
DynamicMBean, MBeanRegistration, NotificationBroadcaster, org.apache.qpid.management.common.mbeans.UserManagement, ManagedObject

public class AMQUserManagementMBean
extends AMQManagedObject
implements org.apache.qpid.management.common.mbeans.UserManagement

MBean class for AMQUserManagementMBean. It implements all the management features exposed for managing users.


Field Summary
(package private) static CompositeType _userDataType
           
(package private) static TabularType _userlistDataType
           
 
Fields inherited from class org.apache.qpid.server.management.AMQManagedObject
_broadcaster, _logActor, _mbeanInfo, _notificationSequenceNumber
 
Fields inherited from interface org.apache.qpid.management.common.mbeans.UserManagement
COMPOSITE_ITEM_DESCRIPTIONS, COMPOSITE_ITEM_NAMES, RIGHTS_ADMIN, RIGHTS_READ_ONLY, RIGHTS_READ_WRITE, TABULAR_UNIQUE_INDEX, TYPE, USERNAME
 
Fields inherited from interface org.apache.qpid.server.management.ManagedObject
DOMAIN
 
Constructor Summary
AMQUserManagementMBean()
           
 
Method Summary
 boolean createUser(String username, char[] password, boolean read, boolean write, boolean admin)
           
 boolean createUser(String username, String password, boolean read, boolean write, boolean admin)
           
 boolean deleteUser(String username)
           
 String getObjectInstanceName()
           
 boolean reloadData()
           
 void setAccessFile(String accessFile)
          setAccessFile
 boolean setPassword(String username, char[] password)
           
 boolean setPassword(String username, String password)
           
 void setPrincipalDatabase(PrincipalDatabase database)
          setPrincipalDatabase
 boolean setRights(String username, boolean read, boolean write, boolean admin)
           
 TabularData viewUsers()
           
 
Methods inherited from class org.apache.qpid.server.management.AMQManagedObject
addNotificationListener, getMBeanInfo, getNotificationInfo, removeNotificationListener
 
Methods inherited from class org.apache.qpid.server.management.DefaultManagedObject
getHierarchicalName, getHierarchicalType, getManagedObjectRegistry, getManagementInterface, getObjectName, getObjectNameForSingleInstanceMBean, getParentObject, getType, jmxEncode, register, toString, unregister
 
Methods inherited from class javax.management.StandardMBean
cacheMBeanInfo, getAttribute, getAttributes, getCachedMBeanInfo, getClassName, getConstructors, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getImpact, getImplementation, getImplementationClass, getMBeanInterface, getParameterName, getParameterName, invoke, postDeregister, postRegister, preDeregister, preRegister, setAttribute, setAttributes, setImplementation
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

_userlistDataType

static TabularType _userlistDataType

_userDataType

static CompositeType _userDataType
Constructor Detail

AMQUserManagementMBean

public AMQUserManagementMBean()
                       throws JMException
Throws:
JMException
Method Detail

getObjectInstanceName

public String getObjectInstanceName()
Specified by:
getObjectInstanceName in interface ManagedObject
Returns:
the name that uniquely identifies this object instance. It must be unique only among objects of this type at this level in the hierarchy so the uniqueness should not be too difficult to ensure.

setPassword

public boolean setPassword(String username,
                           String password)
Specified by:
setPassword in interface org.apache.qpid.management.common.mbeans.UserManagement

setPassword

public boolean setPassword(String username,
                           char[] password)
Specified by:
setPassword in interface org.apache.qpid.management.common.mbeans.UserManagement

setRights

public boolean setRights(String username,
                         boolean read,
                         boolean write,
                         boolean admin)
Specified by:
setRights in interface org.apache.qpid.management.common.mbeans.UserManagement

createUser

public boolean createUser(String username,
                          String password,
                          boolean read,
                          boolean write,
                          boolean admin)
Specified by:
createUser in interface org.apache.qpid.management.common.mbeans.UserManagement

createUser

public boolean createUser(String username,
                          char[] password,
                          boolean read,
                          boolean write,
                          boolean admin)
Specified by:
createUser in interface org.apache.qpid.management.common.mbeans.UserManagement

deleteUser

public boolean deleteUser(String username)
Specified by:
deleteUser in interface org.apache.qpid.management.common.mbeans.UserManagement

reloadData

public boolean reloadData()
Specified by:
reloadData in interface org.apache.qpid.management.common.mbeans.UserManagement

viewUsers

public TabularData viewUsers()
Specified by:
viewUsers in interface org.apache.qpid.management.common.mbeans.UserManagement

setPrincipalDatabase

public void setPrincipalDatabase(PrincipalDatabase database)
setPrincipalDatabase

Parameters:
database - set The Database to use for user lookup

setAccessFile

public void setAccessFile(String accessFile)
                   throws IOException,
                          ConfigurationException
setAccessFile

Parameters:
accessFile - the file to use for updating.
Throws:
IOException - If the file cannot be accessed
ConfigurationException - if checks on the file fail.


Licensed to the Apache Software Foundation