Package org.opends.server.authorization.dseecompat

Class AciListenerManager

java.lang.Object

org.opends.server.authorization.dseecompat.AciListenerManager

All Implemented Interfaces:

AlertGenerator, LocalBackendInitializationListener

public final class AciListenerManager
extends Object
implements LocalBackendInitializationListener, 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	Description
AciListenerManager(AciList aciList, Dn cfgDN, ServerContext serverContext)	Save the list created by the AciHandler routine.

Method Summary

Modifier and Type	Method	Description
void	finalizeListenerManager()	Deregister from the change notification listener, the backend initialization listener and the alert generator.
Map<String,String>	getAlerts()	Retrieves information about the set of alerts that this generator may produce.
Dn	getComponentEntryDN()	Retrieves the DN of the configuration entry with which this alert generator is associated.
void	performBackendPostFinalizationProcessing(String backendId, Predicate<Dn> handlesEntry)	Performs any processing that may be required whenever a backend is finalized.
void	performBackendPreInitializationProcessing(LocalBackend<?> 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

Methods inherited from interface org.opends.server.api.AlertGenerator

getClassName

Methods inherited from interface org.opends.server.api.LocalBackendInitializationListener

performBackendPostInitializationProcessing, performBackendPreFinalizationProcessing

Constructor Detail

AciListenerManager

public AciListenerManager(AciList aciList,
                          Dn cfgDN,
                          ServerContext serverContext)

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.

serverContext - The server context

Method Detail

finalizeListenerManager

public void finalizeListenerManager()

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

performBackendPreInitializationProcessing

public void performBackendPreInitializationProcessing(LocalBackend<?> 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 LocalBackendInitializationListener

Parameters:

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

performBackendPostFinalizationProcessing

public void performBackendPostFinalizationProcessing(String backendId,
                                                     Predicate<Dn> handlesEntry)

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 and after 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 LocalBackendInitializationListener

Parameters:

backendId - The backend ID of the backend that has been taken out of service.

handlesEntry - A predicate which can be used for determining whether the finalized backend contained an entry.

getComponentEntryDN

public Dn getComponentEntryDN()

Description copied from interface: AlertGenerator

Retrieves the DN of the configuration entry with which this alert generator is associated.

Specified by:

getComponentEntryDN in interface AlertGenerator

Returns:

The DN of the configuration entry with which this alert generator is associated.

getAlerts

public Map<String,String> getAlerts()

Description copied from interface: AlertGenerator

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.