public interface AccessLogPublisherCfg extends LogPublisherCfg
Access Log Publishers are responsible for distributing access log messages from the access logger to a destination.
Modifier and Type | Method and Description |
---|---|
void |
addAccessChangeListener(ConfigurationChangeListener<AccessLogPublisherCfg> listener)
Register to be notified when this Access Log Publisher is changed.
|
void |
addAccessLogFilteringCriteriaAddListener(ConfigurationAddListener<AccessLogFilteringCriteriaCfg> listener)
Registers to be notified when new Access Log Filtering Criteria are added.
|
void |
addAccessLogFilteringCriteriaDeleteListener(ConfigurationDeleteListener<AccessLogFilteringCriteriaCfg> listener)
Registers to be notified when existing Access Log Filtering Criteria are deleted.
|
Class<? extends AccessLogPublisherCfg> |
configurationClass()
Gets the configuration class associated with this Access Log Publisher.
|
AccessLogFilteringCriteriaCfg |
getAccessLogFilteringCriteria(String name)
Gets the named Access Log Filtering Criteria.
|
AccessLogPublisherCfgDefn.FilteringPolicy |
getFilteringPolicy()
Gets the "filtering-policy" property.
|
String |
getJavaClass()
Gets the "java-class" property.
|
boolean |
isSuppressInternalOperations()
Gets the "suppress-internal-operations" property.
|
boolean |
isSuppressSynchronizationOperations()
Gets the "suppress-synchronization-operations" property.
|
String[] |
listAccessLogFilteringCriteria()
Lists the Access Log Filtering Criteria.
|
void |
removeAccessChangeListener(ConfigurationChangeListener<AccessLogPublisherCfg> listener)
Deregister an existing Access Log Publisher configuration change listener.
|
void |
removeAccessLogFilteringCriteriaAddListener(ConfigurationAddListener<AccessLogFilteringCriteriaCfg> listener)
Deregisters an existing Access Log Filtering Criteria configuration add listener.
|
void |
removeAccessLogFilteringCriteriaDeleteListener(ConfigurationDeleteListener<AccessLogFilteringCriteriaCfg> listener)
Deregisters an existing Access Log Filtering Criteria configuration delete listener.
|
addChangeListener, isEnabled, removeChangeListener
dn, name
Class<? extends AccessLogPublisherCfg> configurationClass()
configurationClass
in interface Configuration
configurationClass
in interface LogPublisherCfg
void addAccessChangeListener(ConfigurationChangeListener<AccessLogPublisherCfg> listener)
listener
- The Access Log Publisher configuration change listener.void removeAccessChangeListener(ConfigurationChangeListener<AccessLogPublisherCfg> listener)
listener
- The Access Log Publisher configuration change listener.AccessLogPublisherCfgDefn.FilteringPolicy getFilteringPolicy()
Specifies how filtering criteria should be applied to log records.
String getJavaClass()
The fully-qualified name of the Java class that provides the Access Log Publisher implementation.
getJavaClass
in interface LogPublisherCfg
boolean isSuppressInternalOperations()
Indicates whether internal operations (for example, operations that are initiated by plugins) should be logged along with the operations that are requested by users.
boolean isSuppressSynchronizationOperations()
Indicates whether access messages that are generated by synchronization operations should be suppressed.
String[] listAccessLogFilteringCriteria()
AccessLogFilteringCriteriaCfg getAccessLogFilteringCriteria(String name) throws ConfigException
name
- The name of the Access Log Filtering Criteria to retrieve.ConfigException
- If the Access Log Filtering Criteria could not be found or it
could not be successfully decoded.void addAccessLogFilteringCriteriaAddListener(ConfigurationAddListener<AccessLogFilteringCriteriaCfg> listener) throws ConfigException
listener
- The Access Log Filtering Criteria configuration add listener.ConfigException
- If the add listener could not be registered.void removeAccessLogFilteringCriteriaAddListener(ConfigurationAddListener<AccessLogFilteringCriteriaCfg> listener)
listener
- The Access Log Filtering Criteria configuration add listener.void addAccessLogFilteringCriteriaDeleteListener(ConfigurationDeleteListener<AccessLogFilteringCriteriaCfg> listener) throws ConfigException
listener
- The Access Log Filtering Criteria configuration delete listener.ConfigException
- If the delete listener could not be registered.void removeAccessLogFilteringCriteriaDeleteListener(ConfigurationDeleteListener<AccessLogFilteringCriteriaCfg> listener)
listener
- The Access Log Filtering Criteria configuration delete listener.Copyright 2010-2020 ForgeRock AS.