org.apache.qpid.management.common.mbeans
Interface UserManagement


public interface UserManagement


Field Summary
static List<String> COMPOSITE_ITEM_DESCRIPTIONS
           
static List<String> COMPOSITE_ITEM_NAMES
           
static String RIGHTS_ADMIN
           
static String RIGHTS_READ_ONLY
           
static String RIGHTS_READ_WRITE
           
static List<String> TABULAR_UNIQUE_INDEX
           
static String TYPE
           
static String USERNAME
           
 
Method Summary
 boolean createUser(String username, char[] password, boolean read, boolean write, boolean admin)
          Deprecated. since Qpid JMX API 1.7
 boolean createUser(String username, String password, boolean read, boolean write, boolean admin)
          Create users with given details.
 boolean deleteUser(String username)
          View users returns all the users that are currently available to the system.
 boolean reloadData()
          Reload the date from disk Since Qpid JMX API 1.2 this operation reloads the password and authorisation files.
 boolean setPassword(String username, char[] password)
          Deprecated. since Qpid JMX API 1.7
 boolean setPassword(String username, String password)
          Set password for a given user.
 boolean setRights(String username, boolean read, boolean write, boolean admin)
          set rights for users with given details
 TabularData viewUsers()
          View users returns all the users that are currently available to the system.
 

Field Detail

TYPE

static final String TYPE
See Also:
Constant Field Values

USERNAME

static final String USERNAME
See Also:
Constant Field Values

RIGHTS_READ_ONLY

static final String RIGHTS_READ_ONLY
See Also:
Constant Field Values

RIGHTS_READ_WRITE

static final String RIGHTS_READ_WRITE
See Also:
Constant Field Values

RIGHTS_ADMIN

static final String RIGHTS_ADMIN
See Also:
Constant Field Values

COMPOSITE_ITEM_NAMES

static final List<String> COMPOSITE_ITEM_NAMES

COMPOSITE_ITEM_DESCRIPTIONS

static final List<String> COMPOSITE_ITEM_DESCRIPTIONS

TABULAR_UNIQUE_INDEX

static final List<String> TABULAR_UNIQUE_INDEX
Method Detail

setPassword

@Deprecated
boolean setPassword(String username,
                               char[] password)
Deprecated. since Qpid JMX API 1.7

set password for user. Since Qpid JMX API 1.2 this operation expects plain text passwords to be provided. Prior to this, MD5 hashed passwords were supplied.

Parameters:
username - The username to create
password - The password for the user
Returns:
The result of the operation

setPassword

boolean setPassword(String username,
                    String password)
Set password for a given user.

Parameters:
username - The username to create
password - The password for the user
Returns:
The result of the operation
Since:
Qpid JMX API 1.7

setRights

boolean setRights(String username,
                  boolean read,
                  boolean write,
                  boolean admin)
set rights for users with given details

Parameters:
username - The username to create
read - The set of permission to give the new user
write - The set of permission to give the new user
admin - The set of permission to give the new user
Returns:
The result of the operation

createUser

@Deprecated
boolean createUser(String username,
                              char[] password,
                              boolean read,
                              boolean write,
                              boolean admin)
Deprecated. since Qpid JMX API 1.7

Create users with given details Since Qpid JMX API 1.2 this operation expects plain text passwords to be provided. Prior to this, MD5 hashed passwords were supplied.

Parameters:
username - The username to create
password - The password for the user
read - The set of permission to give the new user
write - The set of permission to give the new user
admin - The set of permission to give the new user
Returns:
The result of the operation

createUser

boolean createUser(String username,
                   String password,
                   boolean read,
                   boolean write,
                   boolean admin)
Create users with given details.

Parameters:
username - The username to create
password - The password for the user
read - The set of permission to give the new user
write - The set of permission to give the new user
admin - The set of permission to give the new user
Returns:
The result of the operation
Since:
Qpid JMX API 1.7

deleteUser

boolean deleteUser(String username)
View users returns all the users that are currently available to the system.

Parameters:
username - The user to delete
Returns:
The result of the operation

reloadData

boolean reloadData()
Reload the date from disk Since Qpid JMX API 1.2 this operation reloads the password and authorisation files. Prior to this, only the authorisation file was reloaded.

Returns:
The result of the operation

viewUsers

TabularData viewUsers()
View users returns all the users that are currently available to the system.

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


Licensed to the Apache Software Foundation