Package org.forgerock.opendj.server.config.server

Interface PolicyBasedAccessControlHandlerCfg

All Superinterfaces:
AccessControlHandlerCfg, Configuration
public interface PolicyBasedAccessControlHandlerCfg extends AccessControlHandlerCfg
A server-side interface for querying Policy Based Access Control Handler settings.

A policy based access control handler implements a coarse grained access control model suitable for use in proxies.

  • Method Details

    • configurationClass

      Class<? extends PolicyBasedAccessControlHandlerCfg> configurationClass()
      Gets the configuration class associated with this Policy Based Access Control Handler.
      Specified by:
      configurationClass in interface AccessControlHandlerCfg
      Specified by:
      configurationClass in interface Configuration
      Returns:
      Returns the configuration class associated with this Policy Based Access Control Handler.

    • addPolicyBasedChangeListener

      void addPolicyBasedChangeListener(ConfigurationChangeListener<PolicyBasedAccessControlHandlerCfg> listener)
      Register to be notified when this Policy Based Access Control Handler is changed.
      Parameters:
      listener - The Policy Based Access Control Handler configuration change listener.

    • removePolicyBasedChangeListener

      void removePolicyBasedChangeListener(ConfigurationChangeListener<PolicyBasedAccessControlHandlerCfg> listener)
      Deregister an existing Policy Based Access Control Handler configuration change listener.
      Parameters:
      listener - The Policy Based Access Control Handler configuration change listener.

    • getJavaClass

      String getJavaClass()
      Gets the "java-class" property.

      Specifies the fully-qualified name of the Java class that provides the Policy Based Access Control Handler implementation.

      Default value: org.opends.server.authorization.policy.PolicyBasedAccessControlHandler

      Specified by:
      getJavaClass in interface AccessControlHandlerCfg
      Returns:
      Returns the value of the "java-class" property.

    • listGlobalAccessControlPolicies

      String[] listGlobalAccessControlPolicies()
      Lists the Global Access Control Policies.
      Returns:
      Returns an array containing the names of the Global Access Control Policies.

    • getGlobalAccessControlPolicy

      GlobalAccessControlPolicyCfg getGlobalAccessControlPolicy(String name) throws ConfigException
      Gets the named Global Access Control Policy.
      Parameters:
      name - The name of the Global Access Control Policy to retrieve.
      Returns:
      Returns the named Global Access Control Policy.
      Throws:
      ConfigException - If the Global Access Control Policy could not be found or it could not be successfully decoded.

    • addGlobalAccessControlPolicyAddListener

      void addGlobalAccessControlPolicyAddListener(ConfigurationAddListener<GlobalAccessControlPolicyCfg> listener) throws ConfigException
      Registers to be notified when new Global Access Control Policies are added.
      Parameters:
      listener - The Global Access Control Policy configuration add listener.
      Throws:
      ConfigException - If the add listener could not be registered.

    • removeGlobalAccessControlPolicyAddListener

      void removeGlobalAccessControlPolicyAddListener(ConfigurationAddListener<GlobalAccessControlPolicyCfg> listener)
      Deregisters an existing Global Access Control Policy configuration add listener.
      Parameters:
      listener - The Global Access Control Policy configuration add listener.

    • addGlobalAccessControlPolicyDeleteListener

      void addGlobalAccessControlPolicyDeleteListener(ConfigurationDeleteListener<GlobalAccessControlPolicyCfg> listener) throws ConfigException
      Registers to be notified when existing Global Access Control Policies are deleted.
      Parameters:
      listener - The Global Access Control Policy configuration delete listener.
      Throws:
      ConfigException - If the delete listener could not be registered.

    • removeGlobalAccessControlPolicyDeleteListener

      void removeGlobalAccessControlPolicyDeleteListener(ConfigurationDeleteListener<GlobalAccessControlPolicyCfg> listener)
      Deregisters an existing Global Access Control Policy configuration delete listener.
      Parameters:
      listener - The Global Access Control Policy configuration delete listener.