Package org.forgerock.audit.events.handlers

Class EventHandlerConfiguration

java.lang.Object
org.forgerock.audit.events.handlers.EventHandlerConfiguration
Direct Known Subclasses:
ElasticsearchAuditEventHandlerConfiguration, FileBasedEventHandlerConfiguration, JmsAuditEventHandlerConfiguration, JsonStdoutAuditEventHandlerConfiguration, SplunkAuditEventHandlerConfiguration, SyslogAuditEventHandlerConfiguration
public abstract class EventHandlerConfiguration extends Object
Base class for audit event handler configuration.

  • 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

      public String getName()
      Returns the name of this handler.
      Returns:
      the name

    • setName

      public void setName(String name)
      Sets the name of this handler.
      Parameters:
      name - The name

    • getTopics

      public Set<String> getTopics()
      Returns the names of the topics accepted by this handler.
      Returns:
      the set of topic names

    • setTopics

      public void setTopics(Set<String> topics)
      Sets the topics accepted by this handler.
      Parameters:
      topics - The names of all accepted topics

    • isUsableForQueries

      public abstract boolean isUsableForQueries()
      States if an AuditEventHandler can be used for queries.
      Returns:
      True - If the AuditEventHandler can be used for queries. False - If the AuditEventHandler can not be used for queries.