public interface DebugLogPublisherCfgClient extends LogPublisherCfgClient
Debug Log Publishers are responsible for distributing debug log messages from the debug logger to a destination.
Modifier and Type | Method and Description |
---|---|
<C extends DebugTargetCfgClient> |
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.
|
ValueOrExpression<Integer> |
getDefaultThrowableStackFrames()
Gets the "default-throwable-stack-frames" property.
|
ValueOrExpression<String> |
getJavaClass()
Gets the "java-class" property.
|
ValueOrExpression<Boolean> |
isDefaultDebugExceptionsOnly()
Gets the "default-debug-exceptions-only" property.
|
ValueOrExpression<Boolean> |
isDefaultIncludeThrowableCause()
Gets the "default-include-throwable-cause" property.
|
ValueOrExpression<Boolean> |
isDefaultOmitMethodEntryArguments()
Gets the "default-omit-method-entry-arguments" property.
|
ValueOrExpression<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(ValueOrExpression<Boolean> value)
Sets the "default-debug-exceptions-only" property.
|
void |
setDefaultIncludeThrowableCause(ValueOrExpression<Boolean> value)
Sets the "default-include-throwable-cause" property.
|
void |
setDefaultOmitMethodEntryArguments(ValueOrExpression<Boolean> value)
Sets the "default-omit-method-entry-arguments" property.
|
void |
setDefaultOmitMethodReturnValue(ValueOrExpression<Boolean> value)
Sets the "default-omit-method-return-value" property.
|
void |
setDefaultThrowableStackFrames(ValueOrExpression<Integer> value)
Sets the "default-throwable-stack-frames" property.
|
void |
setJavaClass(ValueOrExpression<String> value)
Sets the "java-class" property.
|
isEnabled, setEnabled
commit, properties
ManagedObjectDefinition<? extends DebugLogPublisherCfgClient,? extends DebugLogPublisherCfg> definition()
definition
in interface ConfigurationClient
definition
in interface LogPublisherCfgClient
ValueOrExpression<Boolean> isDefaultDebugExceptionsOnly()
Indicates whether only logs with exception should be logged.
void setDefaultDebugExceptionsOnly(ValueOrExpression<Boolean> value) throws PropertyException
Indicates whether only logs with exception should be logged.
value
- The value of the "default-debug-exceptions-only" property.PropertyException
- If the new value is invalid.ValueOrExpression<Boolean> isDefaultIncludeThrowableCause()
Indicates whether to include the cause of exceptions in exception thrown and caught messages logged by default.
void setDefaultIncludeThrowableCause(ValueOrExpression<Boolean> value) throws PropertyException
Indicates whether to include the cause of exceptions in exception thrown and caught messages logged by default.
value
- The value of the "default-include-throwable-cause" property.PropertyException
- If the new value is invalid.ValueOrExpression<Boolean> isDefaultOmitMethodEntryArguments()
Indicates whether to include method arguments in debug messages logged by default.
void setDefaultOmitMethodEntryArguments(ValueOrExpression<Boolean> value) throws PropertyException
Indicates whether to include method arguments in debug messages logged by default.
value
- The value of the "default-omit-method-entry-arguments" property.PropertyException
- If the new value is invalid.ValueOrExpression<Boolean> isDefaultOmitMethodReturnValue()
Indicates whether to include the return value in debug messages logged by default.
void setDefaultOmitMethodReturnValue(ValueOrExpression<Boolean> value) throws PropertyException
Indicates whether to include the return value in debug messages logged by default.
value
- The value of the "default-omit-method-return-value" property.PropertyException
- If the new value is invalid.ValueOrExpression<Integer> getDefaultThrowableStackFrames()
Indicates the number of stack frames to include in the stack trace for method entry and exception thrown messages.
void setDefaultThrowableStackFrames(ValueOrExpression<Integer> value) throws PropertyException
Indicates the number of stack frames to include in the stack trace for method entry and exception thrown messages.
value
- The value of the "default-throwable-stack-frames" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getJavaClass()
The fully-qualified name of the Java class that provides the Debug Log Publisher implementation.
getJavaClass
in interface LogPublisherCfgClient
void setJavaClass(ValueOrExpression<String> value) throws PropertyException
The fully-qualified name of the Java class that provides the Debug Log Publisher implementation.
setJavaClass
in interface LogPublisherCfgClient
value
- The value of the "java-class" property.PropertyException
- If the new value is invalid.String[] listDebugTargets() throws ConcurrentModificationException, LdapException
ConcurrentModificationException
- If this Debug Log Publisher has been removed from the
server by another client.LdapException
- If any other error occurs.DebugTargetCfgClient getDebugTarget(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
name
- The name of the Debug Target to retrieve.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.LdapException
- If any other error occurs.<C extends DebugTargetCfgClient> C createDebugTarget(ManagedObjectDefinition<C,? extends DebugTargetCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.C
- The type of the Debug Target being created.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 PropertyException
s that occurred whilst attempting to
determine the default values of the Debug Target. This
argument can be null
.IllegalManagedObjectNameException
- If the name of the new Debug Target is invalid.void removeDebugTarget(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
name
- The name of the Debug Target to remove.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.LdapException
- If any other error occurs.Copyright 2010-2018 ForgeRock AS.