LegacyLDAPSecuritySettingPlugin (Red Hat JBoss Enterprise Application Platform 7.2.0.Beta public API)

java.lang.Object
- org.apache.activemq.artemis.core.server.impl.LegacyLDAPSecuritySettingPlugin

All Implemented Interfaces:: Serializable, SecuritySettingPlugin

public class LegacyLDAPSecuritySettingPlugin
extends Object
implements SecuritySettingPlugin

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class LegacyLDAPSecuritySettingPlugin.LDAPNamespaceChangeListener

Nested Classes
Modifier and Type	Class and Description
`protected class`	`LegacyLDAPSecuritySettingPlugin.LDAPNamespaceChangeListener`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ADMIN_PERMISSION_VALUE`
`static String`	`AUTHENTICATION`
`static String`	`CONNECTION_PASSWORD`
`static String`	`CONNECTION_PROTOCOL`
`static String`	`CONNECTION_URL`
`static String`	`CONNECTION_USERNAME`
`static String`	`DESTINATION_BASE`
`static String`	`ENABLE_LISTENER`
`static String`	`FILTER`
`static String`	`INITIAL_CONTEXT_FACTORY`
`static String`	`READ_PERMISSION_VALUE`
`static String`	`ROLE_ATTRIBUTE`
`static String`	`WRITE_PERMISSION_VALUE`

Constructor Summary

Constructors
Constructor and Description

LegacyLDAPSecuritySettingPlugin()

Constructors
Constructor and Description
`LegacyLDAPSecuritySettingPlugin()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAdminPermissionValue()`
`String`	`getAuthentication()`
`String`	`getConnectionPassword()`
`String`	`getConnectionProtocol()`
`String`	`getConnectionURL()`
`String`	`getConnectionUsername()`
`String`	`getDestinationBase()`
`String`	`getFilter()`
`String`	`getInitialContextFactory()`
`String`	`getReadPermissionValue()`
`String`	`getRoleAttribute()`
`Map<String,Set<Role>>`	`getSecurityRoles()` Fetch the security role information from the external environment (e.g.
`String`	`getWritePermissionValue()`
`LegacyLDAPSecuritySettingPlugin`	`init(Map<String,String> options)` Initialize the plugin with the given configuration options.
`protected boolean`	`isContextAlive()`
`boolean`	`isEnableListener()`
`void`	`namingExceptionThrown(NamingExceptionEvent namingExceptionEvent)` Handler for exception events from the registry.
`void`	`objectAdded(NamingEvent namingEvent)` Handler for new policy entries in the directory.
`void`	`objectChanged(NamingEvent namingEvent)` Handler for changed policy entries in the directory.
`void`	`objectRemoved(NamingEvent namingEvent)` Handler for removed policy entries in the directory.
`void`	`objectRenamed(NamingEvent namingEvent)`
`protected void`	`open()`
`LegacyLDAPSecuritySettingPlugin`	`setAdminPermissionValue(String adminPermissionValue)`
`LegacyLDAPSecuritySettingPlugin`	`setAuthentication(String authentication)`
`LegacyLDAPSecuritySettingPlugin`	`setConnectionPassword(String connectionPassword)`
`LegacyLDAPSecuritySettingPlugin`	`setConnectionProtocol(String connectionProtocol)`
`LegacyLDAPSecuritySettingPlugin`	`setConnectionURL(String connectionURL)`
`LegacyLDAPSecuritySettingPlugin`	`setConnectionUsername(String connectionUsername)`
`LegacyLDAPSecuritySettingPlugin`	`setDestinationBase(String destinationBase)`
`LegacyLDAPSecuritySettingPlugin`	`setEnableListener(boolean enableListener)`
`LegacyLDAPSecuritySettingPlugin`	`setFilter(String filter)`
`LegacyLDAPSecuritySettingPlugin`	`setInitialContextFactory(String initialContextFactory)`
`LegacyLDAPSecuritySettingPlugin`	`setReadPermissionValue(String readPermissionValue)`
`SecuritySettingPlugin`	`setRoleAttribute(String roleAttribute)`
`void`	`setSecurityRepository(HierarchicalRepository<Set<Role>> securityRepository)` This method is called by the broker during the start-up process.
`LegacyLDAPSecuritySettingPlugin`	`setWritePermissionValue(String writePermissionValue)`
`SecuritySettingPlugin`	`stop()` Clean up all the associated resources associated with this plugin (e.g.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INITIAL_CONTEXT_FACTORY
```
public static final String INITIAL_CONTEXT_FACTORY
```
    See Also:
    
    Constant Field Values
  - CONNECTION_URL
```
public static final String CONNECTION_URL
```
    See Also:
    
    Constant Field Values
  - CONNECTION_USERNAME
```
public static final String CONNECTION_USERNAME
```
    See Also:
    
    Constant Field Values
  - CONNECTION_PASSWORD
```
public static final String CONNECTION_PASSWORD
```
    See Also:
    
    Constant Field Values
  - CONNECTION_PROTOCOL
```
public static final String CONNECTION_PROTOCOL
```
    See Also:
    
    Constant Field Values
  - AUTHENTICATION
```
public static final String AUTHENTICATION
```
    See Also:
    
    Constant Field Values
  - ROLE_ATTRIBUTE
```
public static final String ROLE_ATTRIBUTE
```
    See Also:
    
    Constant Field Values
  - FILTER
```
public static final String FILTER
```
    See Also:
    
    Constant Field Values
  - DESTINATION_BASE
```
public static final String DESTINATION_BASE
```
    See Also:
    
    Constant Field Values
  - ADMIN_PERMISSION_VALUE
```
public static final String ADMIN_PERMISSION_VALUE
```
    See Also:
    
    Constant Field Values
  - READ_PERMISSION_VALUE
```
public static final String READ_PERMISSION_VALUE
```
    See Also:
    
    Constant Field Values
  - WRITE_PERMISSION_VALUE
```
public static final String WRITE_PERMISSION_VALUE
```
    See Also:
    
    Constant Field Values
  - ENABLE_LISTENER
```
public static final String ENABLE_LISTENER
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LegacyLDAPSecuritySettingPlugin
```
public LegacyLDAPSecuritySettingPlugin()
```
- Method Detail
  - init
```
public LegacyLDAPSecuritySettingPlugin init(Map<String,String> options)
```
    Description copied from interface: SecuritySettingPlugin
    
    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.
    
    Specified by:
    
    init in interface SecuritySettingPlugin
    
    Parameters:
    
    options - name/value pairs used to configure the SecuritySettingPlugin instance
    
    Returns:
    
    this instance
  - getRoleAttribute
```
public String getRoleAttribute()
```
  - setRoleAttribute
```
public SecuritySettingPlugin setRoleAttribute(String roleAttribute)
```
  - getFilter
```
public String getFilter()
```
  - setFilter
```
public LegacyLDAPSecuritySettingPlugin setFilter(String filter)
```
  - getDestinationBase
```
public String getDestinationBase()
```
  - setDestinationBase
```
public LegacyLDAPSecuritySettingPlugin setDestinationBase(String destinationBase)
```
  - getAuthentication
```
public String getAuthentication()
```
  - setAuthentication
```
public LegacyLDAPSecuritySettingPlugin setAuthentication(String authentication)
```
  - getConnectionPassword
```
public String getConnectionPassword()
```
  - setConnectionPassword
```
public LegacyLDAPSecuritySettingPlugin setConnectionPassword(String connectionPassword)
```
  - getConnectionProtocol
```
public String getConnectionProtocol()
```
  - setConnectionProtocol
```
public LegacyLDAPSecuritySettingPlugin setConnectionProtocol(String connectionProtocol)
```
  - getConnectionURL
```
public String getConnectionURL()
```
  - setConnectionURL
```
public LegacyLDAPSecuritySettingPlugin setConnectionURL(String connectionURL)
```
  - getConnectionUsername
```
public String getConnectionUsername()
```
  - setConnectionUsername
```
public LegacyLDAPSecuritySettingPlugin setConnectionUsername(String connectionUsername)
```
  - getInitialContextFactory
```
public String getInitialContextFactory()
```
  - getAdminPermissionValue
```
public String getAdminPermissionValue()
```
  - setAdminPermissionValue
```
public LegacyLDAPSecuritySettingPlugin setAdminPermissionValue(String adminPermissionValue)
```
  - getReadPermissionValue
```
public String getReadPermissionValue()
```
  - setReadPermissionValue
```
public LegacyLDAPSecuritySettingPlugin setReadPermissionValue(String readPermissionValue)
```
  - getWritePermissionValue
```
public String getWritePermissionValue()
```
  - setWritePermissionValue
```
public LegacyLDAPSecuritySettingPlugin setWritePermissionValue(String writePermissionValue)
```
  - setInitialContextFactory
```
public LegacyLDAPSecuritySettingPlugin setInitialContextFactory(String initialContextFactory)
```
  - isEnableListener
```
public boolean isEnableListener()
```
  - setEnableListener
```
public LegacyLDAPSecuritySettingPlugin setEnableListener(boolean enableListener)
```
  - isContextAlive
```
protected boolean isContextAlive()
```
  - open
```
protected void open()
             throws NamingException
```
    Throws:
    
    NamingException
  - getSecurityRoles
```
public Map<String,Set<Role>> getSecurityRoles()
```
    Description copied from interface: SecuritySettingPlugin
    
    Fetch the security role information from the external environment (e.g. file, LDAP, etc.) and return it.
    
    Specified by:
    
    getSecurityRoles in interface SecuritySettingPlugin
    
    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
```
public void setSecurityRepository(HierarchicalRepository<Set<Role>> securityRepository)
```
    Description copied from interface: SecuritySettingPlugin
    
    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.
    
    Specified by:
    
    setSecurityRepository in interface SecuritySettingPlugin
  - stop
```
public SecuritySettingPlugin stop()
```
    Description copied from interface: SecuritySettingPlugin
    
    Clean up all the associated resources associated with this plugin (e.g. LDAP connections, file handles, etc.)
    
    Specified by:
    
    stop in interface SecuritySettingPlugin
    
    Returns:
    
    this instance
  - objectAdded
```
public void objectAdded(NamingEvent namingEvent)
```
    Handler for new policy entries in the directory.
    
    Parameters:
    
    namingEvent - the new entry event that occurred
  - objectRemoved
```
public void objectRemoved(NamingEvent namingEvent)
```
    Handler for removed policy entries in the directory.
    
    Parameters:
    
    namingEvent - the removed entry event that occurred
  - objectRenamed
```
public void objectRenamed(NamingEvent namingEvent)
```
    Parameters:
    
    namingEvent - the renaming entry event that occurred
  - objectChanged
```
public void objectChanged(NamingEvent namingEvent)
```
    Handler for changed policy entries in the directory.
    
    Parameters:
    
    namingEvent - the changed entry event that occurred
  - namingExceptionThrown
```
public void namingExceptionThrown(NamingExceptionEvent namingExceptionEvent)
```
    Handler for exception events from the registry.
    
    Parameters:
    
    namingExceptionEvent - the exception event

Class LegacyLDAPSecuritySettingPlugin

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INITIAL_CONTEXT_FACTORY

CONNECTION_URL

CONNECTION_USERNAME

CONNECTION_PASSWORD

CONNECTION_PROTOCOL

AUTHENTICATION

ROLE_ATTRIBUTE

FILTER

DESTINATION_BASE

ADMIN_PERMISSION_VALUE

READ_PERMISSION_VALUE

WRITE_PERMISSION_VALUE

ENABLE_LISTENER

Constructor Detail

LegacyLDAPSecuritySettingPlugin

Method Detail

init

getRoleAttribute

setRoleAttribute

getFilter

setFilter

getDestinationBase

setDestinationBase

getAuthentication

setAuthentication

getConnectionPassword

setConnectionPassword

getConnectionProtocol

setConnectionProtocol

getConnectionURL

setConnectionURL

getConnectionUsername

setConnectionUsername

getInitialContextFactory

getAdminPermissionValue

setAdminPermissionValue

getReadPermissionValue

setReadPermissionValue

getWritePermissionValue

setWritePermissionValue

setInitialContextFactory

isEnableListener

setEnableListener

isContextAlive

open

getSecurityRoles

setSecurityRepository

stop

objectAdded

objectRemoved

objectRenamed

objectChanged

namingExceptionThrown