Class ExternalAccessLogPublisherCfgDefn

    • Method Detail

      • getInstance

        public static ExternalAccessLogPublisherCfgDefn getInstance()
        Get the External Access Log Publisher configuration definition singleton.
        Returns:
        Returns the External Access Log Publisher configuration definition singleton.
      • getConfigFilePropertyDefinition

        public StringPropertyDefinition getConfigFilePropertyDefinition()
        Get the "config-file" property definition.

        The JSON configuration file that defines the External Access Log Publisher. The content of the JSON configuration file depends on the type of external audit event handler. The path to the file is relative to the server root.

        Returns:
        Returns the "config-file" property definition.
      • getEnabledPropertyDefinition

        public BooleanPropertyDefinition getEnabledPropertyDefinition()
        Get the "enabled" property definition.

        Indicates whether the External Access Log Publisher is enabled for use.

        Returns:
        Returns the "enabled" property definition.
      • getFilteringPolicyPropertyDefinition

        public EnumPropertyDefinition<AccessLogPublisherCfgDefn.FilteringPolicy> getFilteringPolicyPropertyDefinition()
        Get the "filtering-policy" property definition.

        Specifies how filtering criteria should be applied to log records.

        Returns:
        Returns the "filtering-policy" property definition.
      • getJavaClassPropertyDefinition

        public ClassPropertyDefinition getJavaClassPropertyDefinition()
        Get the "java-class" property definition.

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

        Returns:
        Returns the "java-class" property definition.
      • getLogControlOidsPropertyDefinition

        public BooleanPropertyDefinition getLogControlOidsPropertyDefinition()
        Get the "log-control-oids" property definition.

        Specifies whether control OIDs will be included in operation log records.

        Returns:
        Returns the "log-control-oids" property definition.
      • getLogFieldBlacklistPropertyDefinition

        public StringPropertyDefinition getLogFieldBlacklistPropertyDefinition()
        Get the "log-field-blacklist" property definition.

        List of fields that the server omits from access log messages.

        Valid values for this property are JSON paths for fields present in the log file.

        Returns:
        Returns the "log-field-blacklist" property definition.
      • getSuppressInternalOperationsPropertyDefinition

        public BooleanPropertyDefinition getSuppressInternalOperationsPropertyDefinition()
        Get the "suppress-internal-operations" property definition.

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

        Returns:
        Returns the "suppress-internal-operations" property definition.
      • getSuppressSynchronizationOperationsPropertyDefinition

        public BooleanPropertyDefinition getSuppressSynchronizationOperationsPropertyDefinition()
        Get the "suppress-synchronization-operations" property definition.

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

        Returns:
        Returns the "suppress-synchronization-operations" property definition.