com.sssw.jms.api.security
Interface JMQAclManager

public interface JMQAclManager

Interface for pluggable access control management in JMS.

Since:

jBroker MQ 2.1

Field Summary

static String	CONSUME_PERMISSION String constant for CONSUME permission.
static String	MANAGE_PERMISSION String constant for MANAGE permission.
static String	PRODUCE_PERMISSION String constant for PRODUCE permission.

Method Summary

void	createAcl(String name, Acl acl) Create an ACL with the given name
void	deleteAcl(String name) Delete the ACL with the given name
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	getPermission(String name) Get a permission for a particular priviledge.
void	init(Properties props) Initialize the ACL manager.
Acl	newAcl() Get a new blank ACL
AclEntry	newAclEntry() Get a new blank AclEntry object
void	updateAcl(String name, Acl acl) Update the ACL with the given name

Field Detail

CONSUME_PERMISSION

public static final String CONSUME_PERMISSION

String constant for CONSUME permission.

See Also:

Constant Field Values

PRODUCE_PERMISSION

public static final String PRODUCE_PERMISSION

String constant for PRODUCE permission.

See Also:

Constant Field Values

MANAGE_PERMISSION

public static final String MANAGE_PERMISSION

String constant for MANAGE permission.

See Also:

Constant Field Values

Method Detail

init

public void init(Properties props)

Initialize the ACL manager. This method is called after the class has been instantiated.

Parameters:

props - the properties passed to the JMS server. By default this is the content of the lib/msgsvc.properties file.

getPermission

public Permission getPermission(String name)
                         throws JMSException

Get a permission for a particular priviledge. This method must at least be able to return the CONSUME, PRODUCE and MANAGE permissions.

Parameters:

name - the name of permission

Returns:

the permission object for the specified permission

Throws:

JMSException - the provider could not execute this method

See Also:

Permission

newAcl

public Acl newAcl()
           throws JMSException

Get a new blank ACL

Returns:

a newly created, blank Acl object

Throws:

JMSException - the provider could not execute this method

See Also:

Acl

createAcl

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

Create an ACL with the given name

Parameters:

name - the name of ACL to create

acl - the value of ACL

Throws:

JMSException - the provider could not execute this method

See Also:

Acl

deleteAcl

public void deleteAcl(String name)
               throws JMSException

Delete the ACL with the given name

Parameters:

name - the name of ACL to delete

Throws:

JMSException - the provider could not execute this method

getAcl

public Acl getAcl(String name)
           throws JMSException

Get the ACL with the given name

Parameters:

name - the name of ACL to return

Returns:

the ACL with name

Throws:

JMSException - the provider could not execute this method

See Also:

Acl

updateAcl

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

Update the ACL with the given name

Parameters:

name - the name of ACL to update

acl - the new value of ACL

Throws:

JMSException - the provider could not execute this method

See Also:

Acl

getAllAclNames

public String[] getAllAclNames()
                        throws JMSException

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

Returns:

a string array with all ACL names

Throws:

JMSException - the provider could not execute this method

newAclEntry

public AclEntry newAclEntry()
                     throws JMSException

Get a new blank AclEntry object

Returns:

a newly created, blank AclEntry object

Throws:

JMSException - the provider could not execute this method

See Also:

AclEntry