Package org.forgerock.opendj.server.config.client

Interface DebugLogPublisherCfgClient

All Superinterfaces:

ConfigurationClient, LogPublisherCfgClient

All Known Subinterfaces:

FileBasedDebugLogPublisherCfgClient

public interface DebugLogPublisherCfgClient
extends LogPublisherCfgClient

A client-side interface for reading and modifying Debug Log Publisher settings.

Debug Log Publishers are responsible for distributing debug log messages from the debug logger to a destination.

Method Summary

Modifier and Type	Method	Description
<C extends DebugTargetCfgClient> C	createDebugTarget(ManagedObjectDefinition<C,? extends DebugTargetCfg> d, String name, Collection<PropertyException> exceptions)	Creates a new Debug Target.
ManagedObjectDefinition<? extends DebugLogPublisherCfgClient,? extends DebugLogPublisherCfg>	definition()	Get the configuration definition associated with this Debug Log Publisher.
DebugTargetCfgClient	getDebugTarget(String name)	Gets the named Debug Target.
int	getDefaultThrowableStackFrames()	Gets the "default-throwable-stack-frames" property.
String	getJavaClass()	Gets the "java-class" property.
boolean	isDefaultDebugExceptionsOnly()	Gets the "default-debug-exceptions-only" property.
boolean	isDefaultIncludeThrowableCause()	Gets the "default-include-throwable-cause" property.
boolean	isDefaultOmitMethodEntryArguments()	Gets the "default-omit-method-entry-arguments" property.
boolean	isDefaultOmitMethodReturnValue()	Gets the "default-omit-method-return-value" property.
String[]	listDebugTargets()	Lists the Debug Targets.
void	removeDebugTarget(String name)	Removes the named Debug Target.
void	setDefaultDebugExceptionsOnly(Boolean value)	Sets the "default-debug-exceptions-only" property.
void	setDefaultIncludeThrowableCause(Boolean value)	Sets the "default-include-throwable-cause" property.
void	setDefaultOmitMethodEntryArguments(Boolean value)	Sets the "default-omit-method-entry-arguments" property.
void	setDefaultOmitMethodReturnValue(Boolean value)	Sets the "default-omit-method-return-value" property.
void	setDefaultThrowableStackFrames(Integer value)	Sets the "default-throwable-stack-frames" property.
void	setJavaClass(String value)	Sets the "java-class" property.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.LogPublisherCfgClient

isEnabled, setEnabled

Method Detail

definition

ManagedObjectDefinition<? extends DebugLogPublisherCfgClient,? extends DebugLogPublisherCfg> definition()

Get the configuration definition associated with this Debug Log Publisher.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface LogPublisherCfgClient

Returns:

Returns the configuration definition associated with this Debug Log Publisher.

isDefaultDebugExceptionsOnly

boolean isDefaultDebugExceptionsOnly()

Gets the "default-debug-exceptions-only" property.

Indicates whether only logs with exception should be logged.

Returns:

Returns the value of the "default-debug-exceptions-only" property.

setDefaultDebugExceptionsOnly

void setDefaultDebugExceptionsOnly(Boolean value)
                            throws PropertyException

Sets the "default-debug-exceptions-only" property.

Indicates whether only logs with exception should be logged.

Parameters:

value - The value of the "default-debug-exceptions-only" property.

Throws:

PropertyException - If the new value is invalid.

isDefaultIncludeThrowableCause

boolean isDefaultIncludeThrowableCause()

Gets the "default-include-throwable-cause" property.

Indicates whether to include the cause of exceptions in exception thrown and caught messages logged by default.

Returns:

Returns the value of the "default-include-throwable-cause" property.

setDefaultIncludeThrowableCause

void setDefaultIncludeThrowableCause(Boolean value)
                              throws PropertyException

Sets the "default-include-throwable-cause" property.

Indicates whether to include the cause of exceptions in exception thrown and caught messages logged by default.

Parameters:

value - The value of the "default-include-throwable-cause" property.

Throws:

PropertyException - If the new value is invalid.

isDefaultOmitMethodEntryArguments

boolean isDefaultOmitMethodEntryArguments()

Gets the "default-omit-method-entry-arguments" property.

Indicates whether to include method arguments in debug messages logged by default.

Returns:

Returns the value of the "default-omit-method-entry-arguments" property.

setDefaultOmitMethodEntryArguments

void setDefaultOmitMethodEntryArguments(Boolean value)
                                 throws PropertyException

Sets the "default-omit-method-entry-arguments" property.

Indicates whether to include method arguments in debug messages logged by default.

Parameters:

value - The value of the "default-omit-method-entry-arguments" property.

Throws:

PropertyException - If the new value is invalid.

isDefaultOmitMethodReturnValue

boolean isDefaultOmitMethodReturnValue()

Gets the "default-omit-method-return-value" property.

Indicates whether to include the return value in debug messages logged by default.

Returns:

Returns the value of the "default-omit-method-return-value" property.

setDefaultOmitMethodReturnValue

void setDefaultOmitMethodReturnValue(Boolean value)
                              throws PropertyException

Sets the "default-omit-method-return-value" property.

Indicates whether to include the return value in debug messages logged by default.

Parameters:

value - The value of the "default-omit-method-return-value" property.

Throws:

PropertyException - If the new value is invalid.

getDefaultThrowableStackFrames

int getDefaultThrowableStackFrames()

Gets the "default-throwable-stack-frames" property.

Indicates the number of stack frames to include in the stack trace for method entry and exception thrown messages.

Returns:

Returns the value of the "default-throwable-stack-frames" property.

setDefaultThrowableStackFrames

void setDefaultThrowableStackFrames(Integer value)
                             throws PropertyException

Sets the "default-throwable-stack-frames" property.

Indicates the number of stack frames to include in the stack trace for method entry and exception thrown messages.

Parameters:

value - The value of the "default-throwable-stack-frames" property.

Throws:

PropertyException - If the new value is invalid.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

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

Specified by:

getJavaClass in interface LogPublisherCfgClient

Returns:

Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(String value)
           throws PropertyException

Sets the "java-class" property.

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

Specified by:

setJavaClass in interface LogPublisherCfgClient

Parameters:

value - The value of the "java-class" property.

Throws:

PropertyException - If the new value is invalid.

listDebugTargets

String[] listDebugTargets()
                   throws ConcurrentModificationException,
                          org.forgerock.opendj.ldap.LdapException

Lists the Debug Targets.

Returns:

Returns an array containing the names of the Debug Targets.

Throws:

ConcurrentModificationException - If this Debug Log Publisher has been removed from the server by another client.

org.forgerock.opendj.ldap.LdapException - If any other error occurs.

getDebugTarget

DebugTargetCfgClient getDebugTarget(String name)
                             throws DefinitionDecodingException,
                                    ManagedObjectDecodingException,
                                    ManagedObjectNotFoundException,
                                    ConcurrentModificationException,
                                    org.forgerock.opendj.ldap.LdapException

Gets the named Debug Target.

Parameters:

name - The name of the Debug Target to retrieve.

Returns:

Returns the named Debug Target.

Throws:

DefinitionDecodingException - If the named Debug Target was found but its type could not be determined.

ManagedObjectDecodingException - If the named Debug Target was found but one or more of its properties could not be decoded.

ManagedObjectNotFoundException - If the named Debug Target was not found on the server.

ConcurrentModificationException - If this Debug Log Publisher has been removed from the server by another client.

org.forgerock.opendj.ldap.LdapException - If any other error occurs.

createDebugTarget

<C extends DebugTargetCfgClient> C createDebugTarget(ManagedObjectDefinition<C,? extends DebugTargetCfg> d,
                                                     String name,
                                                     Collection<PropertyException> exceptions)
                                              throws IllegalManagedObjectNameException

Creates a new Debug Target. The new Debug Target will initially not contain any property values (including mandatory properties). Once the Debug Target has been configured it can be added to the server using the ConfigurationClient.commit() method.

Type Parameters:

C - The type of the Debug Target being created.

Parameters:

d - The definition of the Debug Target to be created.

name - The name of the new Debug Target.

exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Debug Target. This argument can be null.

Returns:

Returns a new Debug Target configuration instance.

Throws:

IllegalManagedObjectNameException - If the name of the new Debug Target is invalid.

removeDebugTarget

void removeDebugTarget(String name)
                throws ManagedObjectNotFoundException,
                       OperationRejectedException,
                       ConcurrentModificationException,
                       org.forgerock.opendj.ldap.LdapException

Removes the named Debug Target.

Parameters:

name - The name of the Debug Target to remove.

Throws:

ManagedObjectNotFoundException - If the Debug Target does not exist.

OperationRejectedException - If the server refuses to remove the Debug Target due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).

ConcurrentModificationException - If this Debug Log Publisher has been removed from the server by another client.

org.forgerock.opendj.ldap.LdapException - If any other error occurs.