Package com.unboundid.directory.sdk.broker.api

Class PolicyDecisionLogger

  • All Implemented Interfaces:
    Configurable, ExampleUsageProvider, Reconfigurable<PolicyDecisionLoggerConfig>, UnboundIDExtension
    @Extensible
@BrokerExtension
@ThreadSafety(level=INTERFACE_THREADSAFE)
public abstract class PolicyDecisionLogger
extends java.lang.Object
implements UnboundIDExtension, Reconfigurable<PolicyDecisionLoggerConfig>, ExampleUsageProvider
    This class defines an API that must be implemented by extensions which record information about PingAuthorize policy enforcement point (PEP) and policy decision point (PDP) activity

    Each policy decision logger may be configured to indicate whether to include the PDP response or exclude log messages based on their Policy Message Type. This is handled automatically by the server, so individual policy decision logger implementations do not need to attempt to perform that filtering on their own. However, they may perform additional processing if desired to further narrow the set of messages that should be logged.

    Configuring Policy Decision Loggers

    To configure a policy decision created using this API, use a command like: 
          dsconfig create-log-publisher \
           --publisher-name "{logger-name}" \
           --type third-party-policy-decision \
           --set enabled:true \
           --set "extension-class:{class-name}" \
           --set "extension-argument:{name=value}"
    where "{logger-name}" is the name to use for the policy decision logger instance, "{class-name}" is the fully-qualified name of the Java class that extends com.unboundid.directory.sdk.common.api .PolicyDecisionLogger, and "{name=value}" represents name-value pairs for any arguments to provide to the logger. If multiple arguments should be provided to the logger, then the "--set extension-argument:{name=value}" option should be provided multiple times.

    • Constructor Detail

      • PolicyDecisionLogger

        public PolicyDecisionLogger()
        Creates a new instance of this policy decision logger. All policy decision logger implementations must include a default constructor, but any initialization should generally be done in the initializePolicyDecisionLogger method.

    • Method Detail

      • getExtensionDescription

        public abstract java.lang.String[] getExtensionDescription()
        Retrieves a human-readable description for this extension. Each element of the array that is returned will be considered a separate paragraph in generated documentation.
        Specified by:
        getExtensionDescription in interface UnboundIDExtension
        Returns:
        A human-readable description for this extension, or null or an empty array if no description should be available.

      • defineConfigArguments

        public void defineConfigArguments​(ArgumentParser parser)
                           throws ArgumentException
        Updates the provided argument parser to define any configuration arguments which may be used by this extension. The argument parser may also be updated to define relationships between arguments (e.g., to specify required, exclusive, or dependent argument sets).
        Specified by:
        defineConfigArguments in interface Configurable
        Parameters:
        parser - The argument parser to be updated with the configuration arguments which may be used by this extension.
        Throws:
        ArgumentException - If a problem is encountered while updating the provided argument parser.

      • initializePolicyDecisionLogger

        public void initializePolicyDecisionLogger​(ServerContext serverContext,
                                           PolicyDecisionLoggerConfig config,
                                           ArgumentParser parser)
                                    throws LDAPException
        Initializes this policy decision logger.
        Parameters:
        serverContext - A handle to the server context for the server in which this extension is running.
        config - The general configuration for this policy decision logger.
        parser - The argument parser which has been initialized from the configuration for this policy decision logger.
        Throws:
        LDAPException - If a problem occurs while initializing this policy decision logger.

      • isConfigurationAcceptable

        public boolean isConfigurationAcceptable​(PolicyDecisionLoggerConfig config,
                                         ArgumentParser parser,
                                         java.util.List<java.lang.String> unacceptableReasons)
        Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension. The parser will have been used to parse any configuration available for this extension, and any automatic validation will have been performed. This method may be used to perform any more complex validation which cannot be performed automatically by the argument parser.
        Specified by:
        isConfigurationAcceptable in interface Reconfigurable<PolicyDecisionLoggerConfig>
        Parameters:
        config - The general configuration for this extension.
        parser - The argument parser that has been used to parse the proposed configuration for this extension.
        unacceptableReasons - A list to which messages may be added to provide additional information about why the provided configuration is not acceptable.
        Returns:
        true if the configuration in the provided argument parser appears to be acceptable, or false if not.

      • applyConfiguration

        public ResultCode applyConfiguration​(PolicyDecisionLoggerConfig config,
                                     ArgumentParser parser,
                                     java.util.List<java.lang.String> adminActionsRequired,
                                     java.util.List<java.lang.String> messages)
        Attempts to apply the configuration from the provided argument parser to this extension.
        Specified by:
        applyConfiguration in interface Reconfigurable<PolicyDecisionLoggerConfig>
        Parameters:
        config - The general configuration for this extension.
        parser - The argument parser that has been used to parse the new configuration for this extension.
        adminActionsRequired - A list to which messages may be added to provide additional information about any additional administrative actions that may be required to apply some of the configuration changes.
        messages - A list to which messages may be added to provide additional information about the processing performed by this method.
        Returns:
        A result code providing information about the result of applying the configuration change. A result of SUCCESS should be used to indicate that all processing completed successfully. Any other result will indicate that a problem occurred during processing.

      • finalizePolicyDecisionLogger

        public void finalizePolicyDecisionLogger()
        Performs any cleanup which may be necessary when this policy decision logger is to be taken out of service.

      • log

        public abstract void log​(PolicyMessageType messageType,
                         java.util.Map<java.lang.String,​java.lang.String> logContext,
                         java.lang.String message)
        Logs a message.
        Parameters:
        messageType - The PolicyMessageType. This is an indication of what stage in the decision processing lifecycle is being logged.

        This can be either PolicyMessageType.ADVICE or PolicyMessageType.DECISION

        logContext - A set of key/value pairs summarizing and providing context for the policy decision or advice.
        message - This is null when include-pdp-response is disabled and for message types that do not record a policy decision response (like PolicyMessageType.ADVICE).

      • getExamplesArgumentSets

        public java.util.Map<java.util.List<java.lang.String>,​java.lang.String> getExamplesArgumentSets()
        Retrieves a map containing examples of configurations that may be used for this extension. The map key should be a list of sample arguments, and the corresponding value should be a description of the behavior that will be exhibited by the extension when used with that configuration.
        Specified by:
        getExamplesArgumentSets in interface ExampleUsageProvider
        Returns:
        A map containing examples of configurations that may be used for this extension. It may be null or empty if there should not be any example argument sets.