|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.log.AbstractLogEnabled
com.genesyslab.platform.logging.runtime.AbstractLogger
com.genesyslab.platform.logging.runtime.Logger
public final class Logger
Constructor Summary | |
---|---|
Logger(java.lang.String name)
Default constructor. |
Method Summary | |
---|---|
void |
applyConfiguration(LogConfiguration configuration)
This method should be called BEFORE any output. |
boolean |
canLogMessage(LogLevel level)
Determines if given level is enough for logging in current configuration. |
void |
close()
Call this method to stop the logger and close all the outputs. |
void |
doWrite(LogEntry entry)
|
void |
doWrite(java.lang.String srcName,
int messageId,
java.lang.Object[] args)
|
LogConfiguration |
getConfiguration()
Returns the read-only current logger configuration. |
BaseTarget |
getConsoleTarget()
|
FileHeaderProvider |
getFileHeaderProvider()
The FileHeaderProvider is used for receiving the log files header. |
java.util.List<FileTarget> |
getFileTargets()
|
protected InternalRootLogger |
getInternalLogger()
|
boolean |
getIsEnabled()
Shows if the logger is active and can perform write operations. |
ILogger |
getLogger()
|
LoggerPolicy |
getLoggerPolicy()
Gets LoggerPolicy of the logger. |
MessageTemplateManager |
getMessageTemplateManager()
|
Protocol |
getNetworkProtocol()
Please note: the instance of Logger does not control the lifetime or lifecycle of passed networkProtocol. |
SpooledNetworkTarget |
getNetworkTarget()
|
boolean |
isEnabled()
Shows if the logger is active and can perform write operations. |
void |
logMessage(java.lang.String srcName,
java.lang.Object message,
LogLevel level)
|
void |
logMessage(java.lang.String srcName,
java.lang.Object message,
java.lang.Throwable exception,
LogLevel level)
|
void |
logMessage(java.lang.String srcName,
java.lang.String formatString,
java.lang.Object[] args,
LogLevel level)
|
protected void |
onEnableLogging(ILogger logger)
Called when new logger is provided by user. |
void |
setConfiguration(LogConfigurationReadOnly logConf)
|
void |
setConsoleTarget(BaseTarget target)
|
void |
setDateTimeProvider(DateTimeProvider dateTimeProvider)
|
void |
setEnabled(boolean value)
Manage if the logger is active and can perform write operations. |
void |
setFileHeaderProvider(FileHeaderProvider value)
The FileHeaderProvider is used for receiving the log files header. |
void |
setLoggerPolicy(LoggerPolicy value)
Sets LoggerPolicy of the logger. |
void |
setMessageTemplateManager(MessageTemplateManager mtMgr)
|
void |
setNetworkProtocol(Protocol value)
Please note: The instance of Logger does not control the lifetime or lifecycle of the passed networkProtocol. |
void |
setNetworkTarget(SpooledNetworkTarget target)
|
void |
setPotentiallyEnabledLevels(java.util.Set<LogLevel> levels)
|
void |
setVerboseLevel(VerboseLevel level)
|
Methods inherited from class com.genesyslab.platform.logging.runtime.AbstractLogger |
---|
createChildLogger, createChildLoggerEx, debug, debug, debugFormat, error, error, errorFormat, fatalError, fatalError, fatalErrorFormat, getName, getRootLogger, info, info, infoFormat, isDebug, isError, isFatalError, isInfo, isWarn, warn, warn, warnFormat, write, write |
Methods inherited from class com.genesyslab.platform.commons.log.AbstractLogEnabled |
---|
enableLogging |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.genesyslab.platform.logging.LoggerEx |
---|
createChildLoggerEx, getName, getRootLogger, write, write |
Methods inherited from interface com.genesyslab.platform.commons.log.ILogger |
---|
createChildLogger, debug, debug, debugFormat, error, error, errorFormat, fatalError, fatalError, fatalErrorFormat, info, info, infoFormat, isDebug, isError, isFatalError, isInfo, isWarn, warn, warn, warnFormat |
Constructor Detail |
---|
public Logger(java.lang.String name) throws LoggerException
VerboseLevel.TRACE
and higher to the console. Configure the logger using
applyConfiguration(LogConfiguration)
for different behavior.
LoggerException
Method Detail |
---|
protected InternalRootLogger getInternalLogger()
getInternalLogger
in class AbstractLogger
protected void onEnableLogging(ILogger logger)
onEnableLogging
in class AbstractLogEnabled
logger
- The new loggerpublic BaseTarget getConsoleTarget()
public void setConsoleTarget(BaseTarget target)
public SpooledNetworkTarget getNetworkTarget()
public void setNetworkTarget(SpooledNetworkTarget target)
public java.util.List<FileTarget> getFileTargets()
public void setVerboseLevel(VerboseLevel level)
public void setPotentiallyEnabledLevels(java.util.Set<LogLevel> levels)
public Protocol getNetworkProtocol()
getNetworkProtocol
in interface LoggerSupport
public void setNetworkProtocol(Protocol value) throws java.lang.Exception
LoggerSupport
setNetworkProtocol
in interface LoggerSupport
java.lang.Exception
public FileHeaderProvider getFileHeaderProvider()
Cloneable.clone()
method and sets the clone of
passed value.
Please note: the clones of this instance will be used for actual log
files headers forming.
getFileHeaderProvider
in interface LoggerSupport
public void setFileHeaderProvider(FileHeaderProvider value) throws LoggerException
LoggerSupport
setFileHeaderProvider
in interface LoggerSupport
LoggerException
public MessageTemplateManager getMessageTemplateManager()
public void setMessageTemplateManager(MessageTemplateManager mtMgr)
public LogConfiguration getConfiguration()
getConfiguration
in interface LoggerSupport
public void setConfiguration(LogConfigurationReadOnly logConf)
public LoggerPolicy getLoggerPolicy()
getLoggerPolicy
in interface LoggerSupport
public void setLoggerPolicy(LoggerPolicy value)
setLoggerPolicy
in interface LoggerSupport
value
- new logger policypublic boolean isEnabled()
public void setEnabled(boolean value)
value
- new value for logger enabling flagpublic void applyConfiguration(LogConfiguration configuration) throws LoggerException
applyConfiguration
in interface LoggerSupport
configuration
- new logging configuration
LoggerException
public void close()
close
in interface LoggerSupport
public void setDateTimeProvider(DateTimeProvider dateTimeProvider)
public boolean canLogMessage(LogLevel level)
LoggerEx
canLogMessage
in interface LoggerEx
canLogMessage
in class AbstractLogger
level
- log level to check
public ILogger getLogger()
getLogger
in class AbstractLogEnabled
public void doWrite(java.lang.String srcName, int messageId, java.lang.Object[] args)
doWrite
in interface InternalRootLogger
public void doWrite(LogEntry entry)
doWrite
in interface InternalRootLogger
public void logMessage(java.lang.String srcName, java.lang.Object message, LogLevel level)
logMessage
in interface InternalRootLogger
public void logMessage(java.lang.String srcName, java.lang.Object message, java.lang.Throwable exception, LogLevel level)
logMessage
in interface InternalRootLogger
public void logMessage(java.lang.String srcName, java.lang.String formatString, java.lang.Object[] args, LogLevel level)
logMessage
in interface InternalRootLogger
public boolean getIsEnabled()
LoggerSupport
getIsEnabled
in interface LoggerSupport
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |