org.opends.server.loggers

Class TextDebugLogPublisher

java.lang.Object

org.opends.server.loggers.DebugLogPublisher<org.forgerock.opendj.server.config.server.FileBasedDebugLogPublisherCfg>

org.opends.server.loggers.TextDebugLogPublisher

All Implemented Interfaces:

Closeable, AutoCloseable, org.forgerock.opendj.config.server.ConfigurationAddListener<org.forgerock.opendj.server.config.server.DebugTargetCfg>, org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.FileBasedDebugLogPublisherCfg>, org.forgerock.opendj.config.server.ConfigurationDeleteListener<org.forgerock.opendj.server.config.server.DebugTargetCfg>, LogPublisher<org.forgerock.opendj.server.config.server.FileBasedDebugLogPublisherCfg>

public class TextDebugLogPublisher
extends DebugLogPublisher<org.forgerock.opendj.server.config.server.FileBasedDebugLogPublisherCfg>
implements org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.FileBasedDebugLogPublisherCfg>, org.forgerock.opendj.config.server.ConfigurationAddListener<org.forgerock.opendj.server.config.server.DebugTargetCfg>, org.forgerock.opendj.config.server.ConfigurationDeleteListener<org.forgerock.opendj.server.config.server.DebugTargetCfg>

The debug log publisher implementation that writes debug messages to files on disk. It also maintains the rotation and retention polices of the log files.

Constructor Summary

Constructors

Constructor and Description
TextDebugLogPublisher()

Method Summary

Modifier and Type	Method and Description
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationAdd(org.forgerock.opendj.server.config.server.DebugTargetCfg config)
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationChange(org.forgerock.opendj.server.config.server.FileBasedDebugLogPublisherCfg config)
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationDelete(org.forgerock.opendj.server.config.server.DebugTargetCfg config)
void	close() Close this publisher.
org.forgerock.opendj.ldap.DN	getDN() Gets the DN of the configuration entry for this log publisher.
void	initializeLogPublisher(org.forgerock.opendj.server.config.server.FileBasedDebugLogPublisherCfg config, ServerContext serverContext) Initializes this publisher provider based on the information in the provided debug publisher configuration.
boolean	isConfigurationAcceptable(org.forgerock.opendj.server.config.server.FileBasedDebugLogPublisherCfg config, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons) Indicates whether the provided configuration is acceptable for this log publisher.
boolean	isConfigurationAddAcceptable(org.forgerock.opendj.server.config.server.DebugTargetCfg config, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)
boolean	isConfigurationChangeAcceptable(org.forgerock.opendj.server.config.server.FileBasedDebugLogPublisherCfg config, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)
boolean	isConfigurationDeleteAcceptable(org.forgerock.opendj.server.config.server.DebugTargetCfg config, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)
void	trace(TraceSettings settings, String signature, String sourceLocation, String msg, StackTraceElement[] stackTrace) Log an arbitrary event in a method.
void	traceException(TraceSettings settings, String signature, String sourceLocation, String msg, Throwable ex, StackTraceElement[] stackTrace) Log a caught exception in a method.

Methods inherited from class org.opends.server.loggers.DebugLogPublisher

addTraceSettings

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextDebugLogPublisher

public TextDebugLogPublisher()

Method Detail

isConfigurationAcceptable

public boolean isConfigurationAcceptable(org.forgerock.opendj.server.config.server.FileBasedDebugLogPublisherCfg config,
                                         List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Description copied from interface: LogPublisher

Indicates whether the provided configuration is acceptable for this log publisher. It should be possible to call this method on an uninitialized log publisher instance in order to determine whether the log publisher would be able to use the provided configuration.

Note that implementations which use a subclass of the provided configuration class will likely need to cast the configuration to the appropriate subclass type.

Specified by:

isConfigurationAcceptable in interface LogPublisher<org.forgerock.opendj.server.config.server.FileBasedDebugLogPublisherCfg>

Overrides:

isConfigurationAcceptable in class DebugLogPublisher<org.forgerock.opendj.server.config.server.FileBasedDebugLogPublisherCfg>

Parameters:

config - The log publisher configuration for which to make the determination.

unacceptableReasons - A list that may be used to hold the reasons that the provided configuration is not acceptable.

Returns:

true if the provided configuration is acceptable for this log publisher, or false if not.

initializeLogPublisher

public void initializeLogPublisher(org.forgerock.opendj.server.config.server.FileBasedDebugLogPublisherCfg config,
                                   ServerContext serverContext)
                            throws org.forgerock.opendj.config.server.ConfigException,
                                   InitializationException

Description copied from interface: LogPublisher

Initializes this publisher provider based on the information in the provided debug publisher configuration.

Specified by:

initializeLogPublisher in interface LogPublisher<org.forgerock.opendj.server.config.server.FileBasedDebugLogPublisherCfg>

Parameters:

config - The publisher configuration that contains the information to use to initialize this publisher.

serverContext - The server context.

Throws:

org.forgerock.opendj.config.server.ConfigException - If an unrecoverable problem arises in the process of performing the initialization as a result of the server configuration.

InitializationException - If a problem occurs during initialization that is not related to the server configuration.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(org.forgerock.opendj.server.config.server.FileBasedDebugLogPublisherCfg config,
                                               List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Specified by:

isConfigurationChangeAcceptable in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.FileBasedDebugLogPublisherCfg>

applyConfigurationChange

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(org.forgerock.opendj.server.config.server.FileBasedDebugLogPublisherCfg config)

Specified by:

applyConfigurationChange in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.FileBasedDebugLogPublisherCfg>

isConfigurationAddAcceptable

public boolean isConfigurationAddAcceptable(org.forgerock.opendj.server.config.server.DebugTargetCfg config,
                                            List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Specified by:

isConfigurationAddAcceptable in interface org.forgerock.opendj.config.server.ConfigurationAddListener<org.forgerock.opendj.server.config.server.DebugTargetCfg>

isConfigurationDeleteAcceptable

public boolean isConfigurationDeleteAcceptable(org.forgerock.opendj.server.config.server.DebugTargetCfg config,
                                               List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Specified by:

isConfigurationDeleteAcceptable in interface org.forgerock.opendj.config.server.ConfigurationDeleteListener<org.forgerock.opendj.server.config.server.DebugTargetCfg>

applyConfigurationAdd

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationAdd(org.forgerock.opendj.server.config.server.DebugTargetCfg config)

Specified by:

applyConfigurationAdd in interface org.forgerock.opendj.config.server.ConfigurationAddListener<org.forgerock.opendj.server.config.server.DebugTargetCfg>

applyConfigurationDelete

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationDelete(org.forgerock.opendj.server.config.server.DebugTargetCfg config)

Specified by:

applyConfigurationDelete in interface org.forgerock.opendj.config.server.ConfigurationDeleteListener<org.forgerock.opendj.server.config.server.DebugTargetCfg>

trace

public void trace(TraceSettings settings,
                  String signature,
                  String sourceLocation,
                  String msg,
                  StackTraceElement[] stackTrace)

Description copied from class: DebugLogPublisher

Log an arbitrary event in a method.

Specified by:

trace in class DebugLogPublisher<org.forgerock.opendj.server.config.server.FileBasedDebugLogPublisherCfg>

Parameters:

settings - The current trace settings in effect.

signature - The method signature.

sourceLocation - The location of the method in the source.

msg - The message to be logged.

stackTrace - The stack trace at the time the message is logged or null if its not available.

traceException

public void traceException(TraceSettings settings,
                           String signature,
                           String sourceLocation,
                           String msg,
                           Throwable ex,
                           StackTraceElement[] stackTrace)

Description copied from class: DebugLogPublisher

Log a caught exception in a method.

Specified by:

traceException in class DebugLogPublisher<org.forgerock.opendj.server.config.server.FileBasedDebugLogPublisherCfg>

Parameters:

settings - The current trace settings in effect.

signature - The method signature.

sourceLocation - The location of the method in the source.

msg - The message to be logged.

ex - The exception that was caught.

stackTrace - The stack trace at the time the exception is caught or null if its not available.

close

public void close()

Description copied from interface: LogPublisher

Close this publisher.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface LogPublisher<org.forgerock.opendj.server.config.server.FileBasedDebugLogPublisherCfg>

getDN

public org.forgerock.opendj.ldap.DN getDN()

Description copied from interface: LogPublisher

Gets the DN of the configuration entry for this log publisher.

Specified by:

getDN in interface LogPublisher<org.forgerock.opendj.server.config.server.FileBasedDebugLogPublisherCfg>

Returns:

The configuration entry DN.