atg.nucleus.logging
Class PrintStreamLogger

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.nucleus.logging.DisplayLogger
              atg.nucleus.logging.PrintStreamLogger

All Implemented Interfaces:

NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, LogListener, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class PrintStreamLogger
extends DisplayLogger

This log listener writes the logged events directly to the configured print stream.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

PrintStreamLogger()
Constructs a PrintStreamLogger.

Method Summary

protected atg.nucleus.logging.LogPrintStream	createPrefixLogPrintStream(java.io.PrintStream pLogStream, boolean pSuppressTimestamp) Create the prefix log print stream.
void	doStartService() This is called after the service has been created, added to the Registry, and configured.
void	doStopService() This is called when the service is to be stopped.
java.io.PrintStream	getPrintStream() Returns PrintStream.
boolean	isTerse() Whether to use a terse TersePrintStreamLogger.
void	setPrintStream(java.io.PrintStream pPrintStream) Sets PrintStream to write log events to.
void	setTerse(boolean pTerse) Whether to use a terse TersePrintStreamLogger.

Methods inherited from class atg.nucleus.logging.DisplayLogger

generateCroppedStackTrace, getLoggingEnabled, getLogStream, getMaxLinesInStackTrace, getPrefixLogStream, getPrintStackTrace, getWrittenEventCount, isCropStackTrace, isPrefixEachLine, isPrefixEachMessage, isSuppressTimestamp, logEvent, setCropStackTrace, setLoggingEnabled, setLogStream, setMaxLinesInStackTrace, setPrefixEachLine, setPrefixEachMessage, setPrefixLogStream, setPrintStackTrace, setSuppressTimestamp, writeLogEvent

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

PrintStreamLogger

public PrintStreamLogger()

Constructs a PrintStreamLogger.

Method Detail

setTerse

public void setTerse(boolean pTerse)

Whether to use a terse TersePrintStreamLogger.

isTerse

public boolean isTerse()

Whether to use a terse TersePrintStreamLogger.

setPrintStream

public void setPrintStream(java.io.PrintStream pPrintStream)

Sets PrintStream to write log events to.

Parameters:

pPrintStream - the PrintStream

createPrefixLogPrintStream

protected atg.nucleus.logging.LogPrintStream createPrefixLogPrintStream(java.io.PrintStream pLogStream,
                                                                        boolean pSuppressTimestamp)

Create the prefix log print stream.

Parameters:

pLogStream - to log stream to wrap

pSuppressTimestamp - whether to suppress the time stamp.

getPrintStream

public java.io.PrintStream getPrintStream()

Returns PrintStream.

Returns:

PrintStream

doStartService

public void doStartService()
                    throws ServiceException

This is called after the service has been created, added to the Registry, and configured. This method should start any processes required to run the service.

Overrides:

doStartService in class GenericService

Throws:

ServiceException - if an error occurred during the operation

doStopService

public void doStopService()
                   throws ServiceException

This is called when the service is to be stopped. The service should stop any processes that it started, basically performing the opposite function as startService(). The service should also release any resources it has. After this method is called, Nucleus may choose to discard the service.

Overrides:

doStopService in class GenericService

Throws:

ServiceException - if an error occurred during the operation