org.apache.qpid.server.jmx.mbeans

Class UserManagementMBean

java.lang.Object

javax.management.StandardMBean

org.apache.qpid.server.jmx.DefaultManagedObject

org.apache.qpid.server.jmx.AMQManagedObject

org.apache.qpid.server.jmx.mbeans.UserManagementMBean

All Implemented Interfaces:

DynamicMBean, MBeanRegistration, NotificationBroadcaster, UserManagement, ManagedObject

public class UserManagementMBean
extends AMQManagedObject
implements UserManagement

Field Summary

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.jmx.ManagedObject

DOMAIN

Constructor Summary

Constructors

Constructor and Description
UserManagementMBean(PasswordCredentialManagingAuthenticationProvider provider, ManagedObjectRegistry registry)

Method Summary

Modifier and Type	Method and Description
boolean	createUser(String username, String password) Create users with given details.
boolean	deleteUser(String username) View users returns all the users that are currently available to the system.
String	getAuthenticationProviderType() The type of the underlying authentication provider being managed.
String	getObjectInstanceName()
ManagedObject	getParentObject()
boolean	reloadData() Reload the user data Since Qpid JMX API 2.3 / 1.12 this operation reloads only the password data.
boolean	setPassword(String username, String password) Set password for a given user.
TabularData	viewUsers() View users returns all the users that are currently available to the system.

Methods inherited from class org.apache.qpid.server.jmx.AMQManagedObject

addNotificationListener, getBroadcaster, incrementAndGetSequenceNumber, removeNotificationListener

Methods inherited from class org.apache.qpid.server.jmx.DefaultManagedObject

getHierarchicalName, getHierarchicalType, getManagementInterface, getMBeanInfo, getNotificationInfo, getObjectName, getObjectNameForSingleInstanceMBean, getRegistry, getType, 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

Methods inherited from interface javax.management.NotificationBroadcaster

getNotificationInfo

Constructor Detail

UserManagementMBean

public UserManagementMBean(PasswordCredentialManagingAuthenticationProvider provider,
                           ManagedObjectRegistry registry)
                    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)

Description copied from interface: UserManagement

Set password for a given user.

Specified by:

setPassword in interface UserManagement

Parameters:

username - The username to create

password - The password for the user

Returns:

The result of the operation

createUser

public boolean createUser(String username,
                          String password)

Description copied from interface: UserManagement

Create users with given details.

Specified by:

createUser in interface UserManagement

Parameters:

username - The username to create

password - The password for the user

Returns:

true if the user was created successfully, or false otherwise

deleteUser

public boolean deleteUser(String username)

Description copied from interface: UserManagement

View users returns all the users that are currently available to the system.

Specified by:

deleteUser in interface UserManagement

Parameters:

username - The user to delete

Returns:

The result of the operation

reloadData

public boolean reloadData()

Description copied from interface: UserManagement

Reload the user data Since Qpid JMX API 2.3 / 1.12 this operation reloads only the password data. Since Qpid JMX API 1.2 but prior to 2.3 / 1.12 this operation reloads the password and authorisation files. Prior to 1.2, only the authorisation file was reloaded.

Specified by:

reloadData in interface UserManagement

Returns:

The result of the operation

viewUsers

public TabularData viewUsers()

Description copied from interface: UserManagement

View users returns all the users that are currently available to the system. Since Qpid JMX API 2.3 / 1.12 the items that corresponded to read, write and admin flags are deprecated and always return false.

Specified by:

viewUsers in interface UserManagement

Returns:

a table of users data (Username, read, write, admin)

getParentObject

public ManagedObject getParentObject()

Specified by:

getParentObject in interface ManagedObject

Specified by:

getParentObject in class DefaultManagedObject

getAuthenticationProviderType

public String getAuthenticationProviderType()

Description copied from interface: UserManagement

The type of the underlying authentication provider being managed.

Specified by:

getAuthenticationProviderType in interface UserManagement