Package COM.activesw.api.client

Class BrokerAccessControlList

java.lang.Object
COM.activesw.api.client.BrokerAccessControlList
public class BrokerAccessControlList extends 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 Details

  • Method Details

    • getUserNames

      public String[] getUserNames()
      Get the list of user names which are allowed access.

    • setUserNames

      public void setUserNames(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.
      COM.activesw.api.client.BrokerBlankParameterException - If names is blank, or if any name in the array is blank.
      BrokerException

    • getUserNameState

      public boolean getUserNameState(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(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.
      COM.activesw.api.client.BrokerBlankParameterException - If names is blank.
      BrokerException

    • setUserNameStates

      public void setUserNameStates(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.
      COM.activesw.api.client.BrokerBlankParameterException - If names is blank, or if any name in the array is blank.
      BrokerException

    • getAuthNames

      public String[] getAuthNames()
      Get the list of authenticator names which are allowed.

    • setAuthNames

      public void setAuthNames(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.
      COM.activesw.api.client.BrokerBlankParameterException - If names is blank, or if any name in the array is blank.
      BrokerException

    • getAuthNameState

      public boolean getAuthNameState(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(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.
      COM.activesw.api.client.BrokerBlankParameterException - If name is blank.
      BrokerException

    • setAuthNameStates

      public void setAuthNameStates(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.
      COM.activesw.api.client.BrokerBlankParameterException - If names is blank, or if any name in the array is blank.
      BrokerException

    • toString

      public String toString()
      Get a string with the ACL in a form suitable for human viewing.
      Overrides:
      toString in class Object

    • toString

      public String toString(int indent_level, 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.