com.sssw.jms.api.admin
Interface JMQSecurityAdmin

All Superinterfaces:

Remote

public interface JMQSecurityAdmin

extends Remote

Interface for managing security for JMS.

The JMQSecurityAdmin object is obtained from the JMQConnection object.

See Also:

JMQConnection.getSecurityAdmin()

Field Summary

static String	GROUP_ADMIN Name of the built-in Group of administrators
static String	GROUP_WORLD Name of the built-in Group containing everyone
static String	USER_ANONYMOUS Name of the built-in anonymous user

Method Summary

void	addPrincipalToGroup(String principal, String groupName) Add a principal to the group.
void	createAcl(String name, Acl acl) Create an ACL with the given name
void	createGroup(String groupName) Create a Group with the given name
void	createUser(String username, String password) Create a User with the given name and password.
void	deleteAcl(String name) Delete the ACL with the given name
void	deleteGroup(String groupName) Delete the Group with the given name
void	deleteUser(String username) Delete the User with the given name and password
Acl	getAcl(String name) Get the ACL with the given name
String[]	getAllAclNames() Get the names of all the ACLs defined in the JMS server
Permission	getConsumePermission() Get the permission for consuming messages, or browsing queues
Permission	getManagePermission() Get the permission for managing the JMS server
Principal	getPrincipal(String principalName) Get the principal with the given name.
Permission	getProducePermission() Get the permission for producing messages
boolean	isGroup(String principal) Determine if the given principal is a Group
String[]	listAllGroups() List the names of all the Groups
String[]	listAllUsers() List all the users
String[]	listGroupMembers(String groupName) List all the Group member names
Acl	newAcl() Get a new blank ACL
AclEntry	newAclEntry() Get a new blank AclEntry object
void	removePrincipalFromGroup(String principal, String groupName) Remove a principal from the group.
void	updateAcl(String name, Acl acl) Update the ACL with the given name
void	updatePassword(String username, String password) Update the password for the given user.

Field Detail

USER_ANONYMOUS

public static final String USER_ANONYMOUS

Name of the built-in anonymous user

See Also:

Constant Field Values

GROUP_ADMIN

public static final String GROUP_ADMIN

Name of the built-in Group of administrators

See Also:

Constant Field Values

GROUP_WORLD

public static final String GROUP_WORLD

Name of the built-in Group containing everyone

See Also:

Constant Field Values

Method Detail

getConsumePermission

public Permission getConsumePermission()
                                throws RemoteException,
                                       JMSException

Get the permission for consuming messages, or browsing queues

Returns:

the CONSUME permission

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

See Also:

Permission

getProducePermission

public Permission getProducePermission()
                                throws RemoteException,
                                       JMSException

Get the permission for producing messages

Returns:

the PRODUCE permission

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

See Also:

Permission

getManagePermission

public Permission getManagePermission()
                               throws RemoteException,
                                      JMSException

Get the permission for managing the JMS server

Returns:

the MANAGE permission

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

See Also:

Permission

newAcl

public Acl newAcl()
           throws RemoteException,
                  JMSException

Get a new blank ACL

Returns:

a newly created, blank Acl object

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

See Also:

Acl

createAcl

public void createAcl(String name,
                      Acl acl)
               throws RemoteException,
                      JMSException

Create an ACL with the given name

Parameters:

name - the name of ACL to create

acl - the value of ACL

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

See Also:

Acl

deleteAcl

public void deleteAcl(String name)
               throws RemoteException,
                      JMSException

Delete the ACL with the given name

Parameters:

name - the name of ACL to delete

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

getAcl

public Acl getAcl(String name)
           throws RemoteException,
                  JMSException

Get the ACL with the given name

Parameters:

name - the name of ACL to return

Returns:

the ACL with name

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

See Also:

Acl

updateAcl

public void updateAcl(String name,
                      Acl acl)
               throws RemoteException,
                      JMSException

Update the ACL with the given name

Parameters:

name - the name of ACL to update

acl - the new value of ACL

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

See Also:

Acl

getAllAclNames

public String[] getAllAclNames()
                        throws RemoteException,
                               JMSException

Get the names of all the ACLs defined in the JMS server

Returns:

a string array with all ACL names

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

newAclEntry

public AclEntry newAclEntry()
                     throws RemoteException,
                            JMSException

Get a new blank AclEntry object

Returns:

a newly created, blank AclEntry object

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

See Also:

AclEntry

getPrincipal

public Principal getPrincipal(String principalName)
                       throws RemoteException,
                              JMSException

Get the principal with the given name. Note that the principal could be an ordinary User or a Group

Returns:

the principal with principalName

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

See Also:

Principal

createUser

public void createUser(String username,
                       String password)
                throws RemoteException,
                       JMSException

Create a User with the given name and password. Note that the password does not go over the wire in the clear

Parameters:

username - name of new user

password - password for new user

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

deleteUser

public void deleteUser(String username)
                throws RemoteException,
                       JMSException

Delete the User with the given name and password

Parameters:

username - name of user to delete

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

updatePassword

public void updatePassword(String username,
                           String password)
                    throws RemoteException,
                           JMSException

Update the password for the given user. Note that the password does not go over the wire in the clear

Parameters:

username - name of user to update

password - new password for user

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

listAllUsers

public String[] listAllUsers()
                      throws RemoteException,
                             JMSException

List all the users

Returns:

a string array with all user names

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

createGroup

public void createGroup(String groupName)
                 throws RemoteException,
                        JMSException

Create a Group with the given name

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

deleteGroup

public void deleteGroup(String groupName)
                 throws RemoteException,
                        JMSException

Delete the Group with the given name

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

isGroup

public boolean isGroup(String principal)
                throws RemoteException,
                       JMSException

Determine if the given principal is a Group

Returns:

TRUE if principal represents a group, FALSE if user represents a user

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

addPrincipalToGroup

public void addPrincipalToGroup(String principal,
                                String groupName)
                         throws RemoteException,
                                JMSException

Add a principal to the group. Note that the principal could be an ordinary User or a Group

Parameters:

principal - the principal to add to a group

groupName - name of group principal should be added to

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

removePrincipalFromGroup

public void removePrincipalFromGroup(String principal,
                                     String groupName)
                              throws RemoteException,
                                     JMSException

Remove a principal from the group. Note that the principal could be an ordinary User or a Group

Parameters:

principal - the principal to remove to a group

groupName - name of group principal should be removed from

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

listGroupMembers

public String[] listGroupMembers(String groupName)
                          throws RemoteException,
                                 JMSException

List all the Group member names

Parameters:

groupName - name of group to retrieve members for

Returns:

a string array with all members of groupName

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

listAllGroups

public String[] listAllGroups()
                       throws RemoteException,
                              JMSException

List the names of all the Groups

Returns:

a string array with all group names

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method