|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.service.datacollection.FormattingLogger atg.service.datacollection.FormattingSummaryLogger atg.service.datacollection.FormattingSummaryFileLogger
public class FormattingSummaryFileLogger
A FormattingSummaryLogger that logs items to the named file.
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 | |
---|---|
FormattingSummaryFileLogger()
|
Method Summary | |
---|---|
void |
close()
Closes the log media cleanly (if applicable). |
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.lang.String |
getJobDescription()
Returns property JobDescription |
java.lang.String |
getJobName()
Returns property JobName |
java.io.File |
getLogFileDir()
Returns property LogFileDir |
java.lang.String |
getLogFileExtension()
Returns property LogFileExtension |
java.lang.String |
getLogFileName()
Returns property LogFileName |
Schedule |
getSchedule()
Returns property Schedule |
Scheduler |
getScheduler()
Returns property Scheduler |
java.lang.String |
getTimestampDateFormat()
Returns property TimestampDateFormat |
boolean |
isTimestampLogFileName()
Returns property TimestampLogFileName |
void |
open()
Opens the log media for writing to (if applicable). |
void |
performScheduledTask(Scheduler pScheduler,
ScheduledJob pJob)
Callback method for the scheduler. |
void |
rotate()
Flush the current entries into the file. |
void |
setJobDescription(java.lang.String pJobDescription)
Sets property JobDescription |
void |
setJobName(java.lang.String pJobName)
Sets property JobName |
void |
setLogFileDir(java.io.File pLogFileDir)
Sets property LogFileDir |
void |
setLogFileExtension(java.lang.String pLogFileExtension)
Sets property LogFileExtension |
void |
setLogFileName(java.lang.String pLogFileName)
Sets property LogFileName |
void |
setSchedule(Schedule pSchedule)
Sets property Schedule |
void |
setScheduler(Scheduler pScheduler)
Sets property Scheduler |
void |
setTimestampDateFormat(java.lang.String pTimestampDateFormat)
Sets property TimestampDateFormat |
void |
setTimestampLogFileName(boolean pTimestampLogFileName)
Sets property TimestampLogFileName |
Methods inherited from class atg.service.datacollection.FormattingSummaryLogger |
---|
appendField, isValidFormatVariable |
Methods inherited from class atg.service.datacollection.FormattingLogger |
---|
addDataItem, flush, getCount, getFieldDelimiter, getFormatFields, getLineTerminator, isSkipNullObject, isValidFormatField, logEvent, sanitizeFormatFields, setFieldDelimiter, setFormatFields, setLineTerminator, setSkipNullObject |
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 |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public FormattingSummaryFileLogger()
Method Detail |
---|
public void setScheduler(Scheduler pScheduler)
public Scheduler getScheduler()
public void setSchedule(Schedule pSchedule)
public Schedule getSchedule()
public void setJobName(java.lang.String pJobName)
public java.lang.String getJobName()
public void setJobDescription(java.lang.String pJobDescription)
public java.lang.String getJobDescription()
public void setLogFileName(java.lang.String pLogFileName)
public java.lang.String getLogFileName()
public void setLogFileDir(java.io.File pLogFileDir)
public java.io.File getLogFileDir()
public void setLogFileExtension(java.lang.String pLogFileExtension)
public java.lang.String getLogFileExtension()
public void setTimestampLogFileName(boolean pTimestampLogFileName)
public boolean isTimestampLogFileName()
public void setTimestampDateFormat(java.lang.String pTimestampDateFormat)
public java.lang.String getTimestampDateFormat()
public void doStartService() throws ServiceException
doStartService
in class FormattingLogger
ServiceException
- if an error occurred during the operationpublic void doStopService() throws ServiceException
doStopService
in class FormattingLogger
ServiceException
- if an error occurred during the operationpublic void performScheduledTask(Scheduler pScheduler, ScheduledJob pJob)
performScheduledTask
in interface Schedulable
pScheduler
- calling the jobpJob
- the ScheduledJobpublic void rotate()
public void open() throws java.io.IOException
java.io.IOException
public void close() throws java.io.IOException
java.io.IOException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |