org.opends.server.authorization.dseecompat

Class AciListenerManager

java.lang.Object

org.opends.server.authorization.dseecompat.AciListenerManager

All Implemented Interfaces:

AlertGenerator, BackendInitializationListener

public class AciListenerManager
extends Object
implements BackendInitializationListener, AlertGenerator

The AciListenerManager updates an ACI list after each modification operation. Also, updates ACI list when backends are initialized and finalized.

Constructor Summary

Constructors

Constructor and Description
AciListenerManager(AciList aciList, org.forgerock.opendj.ldap.DN cfgDN) Save the list created by the AciHandler routine.

Method Summary

Methods

Modifier and Type	Method and Description
void	finalizeListenerManager() Deregister from the change notification listener, the backend initialization listener and the alert generator.
LinkedHashMap<String,String>	getAlerts() Retrieves information about the set of alerts that this generator may produce.
String	getClassName() Retrieves the fully-qualified name of the Java class for this alert generator implementation.
org.forgerock.opendj.ldap.DN	getComponentEntryDN() Retrieves the DN of the configuration entry used to configure the handler.
void	logMsgsSetLockDownMode(LinkedList<LocalizableMessage> failedACIMsgs) Log the exception messages from the failed ACI decode and then put the server in lockdown mode -- if needed.
void	performBackendPostFinalizationProcessing(Backend<?> backend) Performs any processing that may be required whenever a backend is finalized.
void	performBackendPostInitializationProcessing(Backend<?> backend) Performs any processing that may be required after the Initialisation cycle has been completed, that is all listeners have received the initialisation event, and the backend has been put into service,.
void	performBackendPreFinalizationProcessing(Backend<?> backend) Performs any processing that may be required before starting the finalisation cycle, that is invoked before any listener receive the Finalization event.
void	performBackendPreInitializationProcessing(Backend<?> backend) Performs any processing that may be required whenever a backend is initialized for use in the Directory Server.

Methods inherited from class java.lang.Object

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

Constructor Detail

AciListenerManager

public AciListenerManager(AciList aciList,
                  org.forgerock.opendj.ldap.DN cfgDN)

Save the list created by the AciHandler routine. Registers as an Alert Generator that can send alerts when the server is being put in lockdown mode. Registers as backend initialization listener that is used to manage the ACI list cache when backends are initialized/finalized. Registers as a change notification listener that is used to manage the ACI list cache after ACI modifications have been performed.

Parameters:

aciList - The list object created and loaded by the handler.

cfgDN - The DN of the access control configuration entry.

Method Detail

finalizeListenerManager

public void finalizeListenerManager()

Deregister from the change notification listener, the backend initialization listener and the alert generator.

performBackendPreInitializationProcessing

public void performBackendPreInitializationProcessing(Backend<?> backend)

Performs any processing that may be required whenever a backend is initialized for use in the Directory Server. This method will be invoked after the backend has been initialized but before it has been put into service. In this case, the server will search the backend to find all aci attribute type values that it may contain and add them to the ACI list.

Specified by:

performBackendPreInitializationProcessing in interface BackendInitializationListener

Parameters:

backend - The backend that has been initialized and is about to be put into service.

performBackendPostFinalizationProcessing

public void performBackendPostFinalizationProcessing(Backend<?> backend)

Performs any processing that may be required whenever a backend is finalized. This method will be invoked after the backend has been taken out of service but before it has been finalized. In this case, the server will remove all aci attribute type values associated with entries in the provided backend.

Specified by:

performBackendPostFinalizationProcessing in interface BackendInitializationListener

Parameters:

backend - The backend that has been taken out of service and is about to be finalized.

performBackendPostInitializationProcessing

public void performBackendPostInitializationProcessing(Backend<?> backend)

Description copied from interface: BackendInitializationListener

Performs any processing that may be required after the Initialisation cycle has been completed, that is all listeners have received the initialisation event, and the backend has been put into service,.

Specified by:

performBackendPostInitializationProcessing in interface BackendInitializationListener

Parameters:

backend - The backend that has been initialized and has been put into service.

performBackendPreFinalizationProcessing

public void performBackendPreFinalizationProcessing(Backend<?> backend)

Description copied from interface: BackendInitializationListener

Performs any processing that may be required before starting the finalisation cycle, that is invoked before any listener receive the Finalization event.

Specified by:

performBackendPreFinalizationProcessing in interface BackendInitializationListener

Parameters:

backend - The backend that is about to be finalized.

getClassName

public String getClassName()

Retrieves the fully-qualified name of the Java class for this alert generator implementation.

Specified by:

getClassName in interface AlertGenerator

Returns:

The fully-qualified name of the Java class for this alert generator implementation.

getComponentEntryDN

public org.forgerock.opendj.ldap.DN getComponentEntryDN()

Retrieves the DN of the configuration entry used to configure the handler.

Specified by:

getComponentEntryDN in interface AlertGenerator

Returns:

The DN of the configuration entry containing the Access Control configuration information.

getAlerts

public LinkedHashMap<String,String> getAlerts()

Retrieves information about the set of alerts that this generator may produce. The map returned should be between the notification type for a particular notification and the human-readable description for that notification. This alert generator must not generate any alerts with types that are not contained in this list.

Specified by:

getAlerts in interface AlertGenerator

Returns:

Information about the set of alerts that this generator may produce.

logMsgsSetLockDownMode

public void logMsgsSetLockDownMode(LinkedList<LocalizableMessage> failedACIMsgs)

Log the exception messages from the failed ACI decode and then put the server in lockdown mode -- if needed.

Parameters:

failedACIMsgs - List of exception messages from failed ACI decodes.