COM.activesw.api.client
Class BrokerAccessControlList

java.lang.Object
  COM.activesw.api.client.BrokerAccessControlList

public class BrokerAccessControlList
extends java.lang.Object

An access control list (ACL) consists of a list of names of users who should be allowed access, plus a list of names of authenticators which can issue users their identities.

For SSL, a user name is a distinguished name, and the authenticator should be the distinguished name of the issuing certificate authority.

Constructor Summary

BrokerAccessControlList()
Create an empty access control list (ACL).

BrokerAccessControlList(BrokerAccessControlList acl)
Copy constructor.

Method Summary

java.lang.String[]	getAuthNames() Get the list of authenticator names which are allowed.
boolean	getAuthNameState(java.lang.String name) Get the allow state for a single authenticator name.
java.lang.String[]	getUserNames() Get the list of user names which are allowed access.
boolean	getUserNameState(java.lang.String name) Get the allow state for a single user name.
void	setAuthNames(java.lang.String[] names) Set the list of authenticator names which are allowed.
void	setAuthNameState(java.lang.String name, boolean is_allowed) Set the allow state for a single authenticator name.
void	setAuthNameStates(java.lang.String[] names, boolean is_allowed) Set the allow state for a list of authenticator names.
void	setUserNames(java.lang.String[] names) Set the list of user names which are allowed access.
void	setUserNameState(java.lang.String name, boolean is_allowed) Set the allow state for a single user name.
void	setUserNameStates(java.lang.String[] names, boolean is_allowed) Set the allow state for a list of user names.
java.lang.String	toString() Get a string with the ACL in a form suitable for human viewing.
java.lang.String	toString(int indent_level, java.lang.String name) Get a string with the ACL in a form suitable for human viewing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BrokerAccessControlList

public BrokerAccessControlList()

Create an empty access control list (ACL).

BrokerAccessControlList

public BrokerAccessControlList(BrokerAccessControlList acl)
                        throws BrokerException

Copy constructor.

Throws:

BrokerNullParameterException - If acl is null.

BrokerException

Method Detail

getUserNames

public java.lang.String[] getUserNames()

Get the list of user names which are allowed access.

setUserNames

public void setUserNames(java.lang.String[] names)
                  throws BrokerException

Set the list of user names which are allowed access.

Throws:

BrokerNullParameterException - If names is null, or if any name in the array is null.

BrokerBlankParameterException - If names is blank, or if any name in the array is blank.

BrokerException

getUserNameState

public boolean getUserNameState(java.lang.String name)
                         throws BrokerException

Get the allow state for a single user name. A name is allowed if it is currently in the list.

Throws:

BrokerNullParameterException - If name is null.

BrokerException

setUserNameState

public void setUserNameState(java.lang.String name,
                             boolean is_allowed)
                      throws BrokerException

Set the allow state for a single user name. This may result in adding or removing a name from the list.

Throws:

BrokerNullParameterException - If name is null.

BrokerBlankParameterException - If names is blank.

BrokerException

setUserNameStates

public void setUserNameStates(java.lang.String[] names,
                              boolean is_allowed)
                       throws BrokerException

Set the allow state for a list of user names. This may result in adding or removing from the list.

Throws:

BrokerNullParameterException - If names is null, or if any name in the array is null.

BrokerBlankParameterException - If names is blank, or if any name in the array is blank.

BrokerException

getAuthNames

public java.lang.String[] getAuthNames()

Get the list of authenticator names which are allowed.

setAuthNames

public void setAuthNames(java.lang.String[] names)
                  throws BrokerException

Set the list of authenticator names which are allowed.

Throws:

BrokerNullParameterException - If names is null, or if any name in the array is null.

BrokerBlankParameterException - If names is blank, or if any name in the array is blank.

BrokerException

getAuthNameState

public boolean getAuthNameState(java.lang.String name)
                         throws BrokerException

Get the allow state for a single authenticator name. A name is allowed if it is currently in the list.

Throws:

BrokerNullParameterException - If name is null.

BrokerException

setAuthNameState

public void setAuthNameState(java.lang.String name,
                             boolean is_allowed)
                      throws BrokerException

Set the allow state for a single authenticator name. This may result in adding or removing a name from the list.

Throws:

BrokerNullParameterException - If name is null.

BrokerBlankParameterException - If name is blank.

BrokerException

setAuthNameStates

public void setAuthNameStates(java.lang.String[] names,
                              boolean is_allowed)
                       throws BrokerException

Set the allow state for a list of authenticator names. This may result in adding or removing names from the list.

Throws:

BrokerNullParameterException - If names is null, or if any name in the array is null.

BrokerBlankParameterException - If names is blank, or if any name in the array is blank.

BrokerException

toString

public java.lang.String toString()

Get a string with the ACL in a form suitable for human viewing.

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(int indent_level,
                                 java.lang.String name)

Get a string with the ACL in a form suitable for human viewing. The "indent_level" is the number of 4-space indents that the output should be generated for. The "name" is the optional name to give the access list. It can be null.