|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.ErrorLogPublisher<T>
T
- The type of error log publisher configuration handled
by this log publisher implementation.@PublicAPI(stability=VOLATILE, mayInstantiate=false, mayExtend=true, mayInvoke=false) public abstract class ErrorLogPublisher<T extends ErrorLogPublisherCfg>
This class defines the set of methods and structures that must be implemented for a Directory Server error log publisher.
Field Summary | |
---|---|
protected java.util.HashSet<Severity> |
defaultSeverities
The set of default log severities that will be used if no custom severities have been defined for the associated category. |
protected java.util.HashMap<Category,java.util.HashSet<Severity>> |
definedSeverities
The hash map that will be used to define specific log severities for the various categories. |
Constructor Summary | |
---|---|
ErrorLogPublisher()
|
Method Summary | |
---|---|
abstract void |
close()
Close this publisher. |
abstract DN |
getDN()
Gets the DN of the configuration entry for this error log publisher. |
abstract void |
initializeErrorLogPublisher(T config)
Initializes this access publisher provider based on the information in the provided debug publisher configuration. |
boolean |
isConfigurationAcceptable(ErrorLogPublisherCfg configuration,
java.util.List<Message> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this error log publisher. |
abstract void |
logError(Message message)
Writes a message to the error log using the provided information. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.util.HashMap<Category,java.util.HashSet<Severity>> definedSeverities
protected java.util.HashSet<Severity> defaultSeverities
Constructor Detail |
---|
public ErrorLogPublisher()
Method Detail |
---|
public abstract void initializeErrorLogPublisher(T config) throws ConfigException, InitializationException
config
- The error publisher configuration that contains
the information to use to initialize this error
publisher.
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.public boolean isConfigurationAcceptable(ErrorLogPublisherCfg configuration, java.util.List<Message> unacceptableReasons)
configuration
- The error 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.
true
if the provided configuration is acceptable
for this error log publisher, or false
if not.public abstract void close()
public abstract void logError(Message message)
message
- The message to be logged.public abstract DN getDN()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |