Package org.apache.activemq.artemis.core.server

Interface SecuritySettingPlugin

All Superinterfaces:
Serializable
All Known Implementing Classes:
LegacyLDAPSecuritySettingPlugin
public interface SecuritySettingPlugin extends Serializable

  • Method Details

    • setInit

      default void setInit(Map<String,String> props)

    • init

      SecuritySettingPlugin init(Map<String,String> options)
      Initialize the plugin with the given configuration options. This method is called by the broker when the file-based configuration is read (see org.apache.activemq.artemis.core.deployers.impl.FileConfigurationParser#parseSecurity(org.w3c.dom.Element, org.apache.activemq.artemis.core.config.Configuration). If you're creating/configuring the plugin programmatically then the recommended approach is to simply use the plugin's getters/setters rather than this method.
      Parameters:
      options - name/value pairs used to configure the SecuritySettingPlugin instance
      Returns:
      this instance

    • stop

      SecuritySettingPlugin stop()
      Clean up all the associated resources associated with this plugin (e.g. LDAP connections, file handles, etc.)
      Returns:
      this instance

    • getSecurityRoles

      Map<String,Set<Role>> getSecurityRoles()
      Fetch the security role information from the external environment (e.g. file, LDAP, etc.) and return it.
      Returns:
      the Map's key corresponds to the "match" for the security setting and the corresponding value is the set of org.apache.activemq.artemis.core.security.Role objects defining the appropriate authorization

    • setSecurityRepository

      void setSecurityRepository(HierarchicalRepository<Set<Role>> securityRepository)
      This method is called by the broker during the start-up process. It's for plugins that might need to modify the security settings during runtime (e.g. LDAP plugin that uses a listener to receive updates, etc.). Any changes made to this HierarchicalRepository will be reflected in the broker.