org.forgerock.openam.plugin.configuration

Class FedletAuditServiceConfigurationProviderImpl

java.lang.Object

org.forgerock.openam.plugin.configuration.FedletAuditServiceConfigurationProviderImpl

All Implemented Interfaces:

AuditServiceConfigurationProvider

public class FedletAuditServiceConfigurationProviderImpl
extends Object
implements AuditServiceConfigurationProvider

No-Op AuditServiceConfigurationProvider implementation for the OpenAM Fedlet.

Constructor Summary

Constructors

Constructor and Description
FedletAuditServiceConfigurationProviderImpl()

Method Summary

Modifier and Type	Method and Description
void	addConfigurationListener(AuditServiceConfigurationListener listener) Add a listener that will be notified of any changes in the SMS audit service configuration.
AMAuditServiceConfiguration	getDefaultConfiguration() Get the default audit service configuration.
Set<AuditEventHandlerConfiguration>	getDefaultEventHandlerConfigurations() Get the default audit event handler configuration.
org.forgerock.audit.events.EventTopicsMetaData	getEventTopicsMetaData() Provides meta-data describing the audit event topics the AuditEventHandler may have to handle.
AMAuditServiceConfiguration	getRealmConfiguration(String realm) Get the audit service configuration for the specified realm.
Set<AuditEventHandlerConfiguration>	getRealmEventHandlerConfigurations(String realm) Get the audit event handler configuration for the specified realm.
void	removeConfigurationListener(AuditServiceConfigurationListener listener) Remove the listener from the notification list.
void	setupComplete() This will be called once system startup is complete.

Methods inherited from class java.lang.Object

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

Constructor Detail

FedletAuditServiceConfigurationProviderImpl

public FedletAuditServiceConfigurationProviderImpl()

Method Detail

setupComplete

public void setupComplete()

Description copied from interface: AuditServiceConfigurationProvider

This will be called once system startup is complete. It should register a listener for SMS configuration changes and notify any audit configuration listeners that the configuration has changed.

Specified by:

setupComplete in interface AuditServiceConfigurationProvider

addConfigurationListener

public void addConfigurationListener(AuditServiceConfigurationListener listener)

Description copied from interface: AuditServiceConfigurationProvider

Add a listener that will be notified of any changes in the SMS audit service configuration.

Specified by:

addConfigurationListener in interface AuditServiceConfigurationProvider

Parameters:

listener - The listener to be notified.

removeConfigurationListener

public void removeConfigurationListener(AuditServiceConfigurationListener listener)

Description copied from interface: AuditServiceConfigurationProvider

Remove the listener from the notification list.

Specified by:

removeConfigurationListener in interface AuditServiceConfigurationProvider

Parameters:

listener - The listener to remove.

getDefaultConfiguration

public AMAuditServiceConfiguration getDefaultConfiguration()

Description copied from interface: AuditServiceConfigurationProvider

Get the default audit service configuration.

Specified by:

getDefaultConfiguration in interface AuditServiceConfigurationProvider

Returns:

The default audit service configuration.

getRealmConfiguration

public AMAuditServiceConfiguration getRealmConfiguration(String realm)

Description copied from interface: AuditServiceConfigurationProvider

Get the audit service configuration for the specified realm. If no configuration exists for this realm, the default configuration will be returned.

Specified by:

getRealmConfiguration in interface AuditServiceConfigurationProvider

Parameters:

realm - The realm for which the configuration is required.

Returns:

The audit service configuration.

getDefaultEventHandlerConfigurations

public Set<AuditEventHandlerConfiguration> getDefaultEventHandlerConfigurations()

Description copied from interface: AuditServiceConfigurationProvider

Get the default audit event handler configuration.

Specified by:

getDefaultEventHandlerConfigurations in interface AuditServiceConfigurationProvider

Returns:

The default audit event handler configurations.

getRealmEventHandlerConfigurations

public Set<AuditEventHandlerConfiguration> getRealmEventHandlerConfigurations(String realm)

Description copied from interface: AuditServiceConfigurationProvider

Get the audit event handler configuration for the specified realm. If no configuration exists for this realm, the default configuration will be returned.

Specified by:

getRealmEventHandlerConfigurations in interface AuditServiceConfigurationProvider

Parameters:

realm - The realm for which the configuration is required.

Returns:

The audit event handler configurations.

getEventTopicsMetaData

public org.forgerock.audit.events.EventTopicsMetaData getEventTopicsMetaData()

Description copied from interface: AuditServiceConfigurationProvider

Provides meta-data describing the audit event topics the AuditEventHandler may have to handle.

Specified by:

getEventTopicsMetaData in interface AuditServiceConfigurationProvider

Returns:

The event topics meta-data.