Interface AccessLogPublisherCfg

    • Method Detail

      • addAccessChangeListener

        void addAccessChangeListener​(ConfigurationChangeListener<AccessLogPublisherCfg> listener)
        Register to be notified when this Access Log Publisher is changed.
        Parameters:
        listener - The Access Log Publisher configuration change listener.
      • removeAccessChangeListener

        void removeAccessChangeListener​(ConfigurationChangeListener<AccessLogPublisherCfg> listener)
        Deregister an existing Access Log Publisher configuration change listener.
        Parameters:
        listener - The Access Log Publisher configuration change listener.
      • getFilteringPolicy

        AccessLogPublisherCfgDefn.FilteringPolicy getFilteringPolicy()
        Gets the "filtering-policy" property.

        Specifies how filtering criteria should be applied to log records.

        Default value: no-filtering

        Returns:
        Returns the value of the "filtering-policy" property.
      • getJavaClass

        String getJavaClass()
        Gets the "java-class" property.

        The fully-qualified name of the Java class that provides the Access Log Publisher implementation.

        Default value: org.opends.server.loggers.AccessLogPublisher

        Specified by:
        getJavaClass in interface LogPublisherCfg
        Returns:
        Returns the value of the "java-class" property.
      • isSuppressInternalOperations

        boolean isSuppressInternalOperations()
        Gets the "suppress-internal-operations" property.

        Indicates whether internal operations (for example, operations that are initiated by plugins) should be logged along with the operations that are requested by users.

        Default value: true

        Returns:
        Returns the value of the "suppress-internal-operations" property.
      • isSuppressSynchronizationOperations

        boolean isSuppressSynchronizationOperations()
        Gets the "suppress-synchronization-operations" property.

        Indicates whether access messages that are generated by synchronization operations should be suppressed.

        Default value: false

        Returns:
        Returns the value of the "suppress-synchronization-operations" property.
      • listAccessLogFilteringCriteria

        String[] listAccessLogFilteringCriteria()
        Lists the Access Log Filtering Criteria.
        Returns:
        Returns an array containing the names of the Access Log Filtering Criteria.
      • getAccessLogFilteringCriteria

        AccessLogFilteringCriteriaCfg getAccessLogFilteringCriteria​(String name)
                                                             throws ConfigException
        Gets the named Access Log Filtering Criteria.
        Parameters:
        name - The name of the Access Log Filtering Criteria to retrieve.
        Returns:
        Returns the named Access Log Filtering Criteria.
        Throws:
        ConfigException - If the Access Log Filtering Criteria could not be found or it could not be successfully decoded.
      • removeAccessLogFilteringCriteriaAddListener

        void removeAccessLogFilteringCriteriaAddListener​(ConfigurationAddListener<AccessLogFilteringCriteriaCfg> listener)
        Deregisters an existing Access Log Filtering Criteria configuration add listener.
        Parameters:
        listener - The Access Log Filtering Criteria configuration add listener.
      • addAccessLogFilteringCriteriaDeleteListener

        void addAccessLogFilteringCriteriaDeleteListener​(ConfigurationDeleteListener<AccessLogFilteringCriteriaCfg> listener)
                                                  throws ConfigException
        Registers to be notified when existing Access Log Filtering Criteria are deleted.
        Parameters:
        listener - The Access Log Filtering Criteria configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.
      • removeAccessLogFilteringCriteriaDeleteListener

        void removeAccessLogFilteringCriteriaDeleteListener​(ConfigurationDeleteListener<AccessLogFilteringCriteriaCfg> listener)
        Deregisters an existing Access Log Filtering Criteria configuration delete listener.
        Parameters:
        listener - The Access Log Filtering Criteria configuration delete listener.