Class EventHandlerConfiguration
java.lang.Object
org.forgerock.audit.events.handlers.EventHandlerConfiguration
- Direct Known Subclasses:
ElasticsearchAuditEventHandlerConfiguration
,FileBasedEventHandlerConfiguration
,JmsAuditEventHandlerConfiguration
,JsonStdoutAuditEventHandlerConfiguration
,SplunkAuditEventHandlerConfiguration
,SyslogAuditEventHandlerConfiguration
Base class for audit event handler configuration.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetName()
Returns the name of this handler.Returns the names of the topics accepted by this handler.boolean
Checks if the audit event handler is enabled.abstract boolean
States if anAuditEventHandler
can be used for queries.void
setEnabled
(boolean enabled) Sets the enabled flag for an audit event handler.void
Sets the name of this handler.void
Sets the topics accepted by this handler.
-
Constructor Details
-
EventHandlerConfiguration
public EventHandlerConfiguration()
-
-
Method Details
-
isEnabled
public boolean isEnabled()Checks if the audit event handler is enabled.- Returns:
- True - If the audit event handler is enabled. False - If the audit event handler is disabled.
-
setEnabled
public void setEnabled(boolean enabled) Sets the enabled flag for an audit event handler.- Parameters:
enabled
- True - Enable the audit event handler. False - Disable the audit event handler.
-
getName
Returns the name of this handler.- Returns:
- the name
-
setName
Sets the name of this handler.- Parameters:
name
- The name
-
getTopics
Returns the names of the topics accepted by this handler.- Returns:
- the set of topic names
-
setTopics
Sets the topics accepted by this handler.- Parameters:
topics
- The names of all accepted topics
-
isUsableForQueries
public abstract boolean isUsableForQueries()States if anAuditEventHandler
can be used for queries.- Returns:
- True - If the
AuditEventHandler
can be used for queries. False - If theAuditEventHandler
can not be used for queries.
-