|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sap.ip.me.api.logging.DefaultFileLogWriter
Default file log writer implementation for Mobile Infrastructure. All
messages will be logged into a trace file that can be configured in the
MobileEngine.config
file. Further on the maximum log filesize
can be configured.
Field Summary | |
protected static java.lang.String |
LOG_FILENAME_SUFFIX
The filename / path suffix of a Mobile Infrastructure log configuration |
protected static java.lang.String |
LOG_MAX_VIEWABLE_SIZE
The value behind this key determines the maximum size that can be displayed in UI. |
protected static java.lang.String |
LOG_MAXSIZE_SUFFIX
The maximum (file) size suffix of a Mobile Infrastructure log configuration |
Constructor Summary | |
DefaultFileLogWriter()
|
Method Summary | |
java.util.Vector |
getLogContent()
Returns a vector with String objects. |
java.io.InputStream |
getLogContentAsStream()
Gets input stream with log content. |
java.io.Writer |
getWriter(int severity,
java.lang.String component,
java.lang.String message)
Writes a given message to trace (with prefix "Start: ") and returns current log writer. |
void |
initialize(java.lang.String configurationPrefix)
Initializes the log writer with given configuration prefix. |
void |
logFileContent(int severity,
java.lang.String component,
java.io.File file,
java.lang.String encoding)
Logs the content of a file into the log file. |
void |
releaseWriter(int severity,
java.lang.String component,
java.lang.String message)
Writes a given message to trace (with prefix "End: ") and updates internal status. |
boolean |
reset()
Resets the log. |
void |
setPrintAppendix(boolean printAppendix)
Sets the flag if the log appendix should be written everytime the log is switched off. |
void |
setPrintProlog(boolean printProlog)
Sets the flag if the log prolog should be written everytime the log is switched on. |
boolean |
switchOn(boolean on)
Switch the log writer on or off. |
void |
writeln(int severity,
java.lang.String component,
java.lang.String message,
java.lang.Object[] params)
Formats the message and writes it into the log file if log writer is switched on. |
void |
writeln(int severity,
java.lang.String component,
java.lang.String message,
java.lang.Object[] params,
java.lang.Throwable t,
boolean printStacktrace)
Formats the message and writes it into the log if log writer is switched on. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static final java.lang.String LOG_FILENAME_SUFFIX
protected static final java.lang.String LOG_MAX_VIEWABLE_SIZE
protected static final java.lang.String LOG_MAXSIZE_SUFFIX
Constructor Detail |
public DefaultFileLogWriter()
Method Detail |
public void writeln(int severity, java.lang.String component, java.lang.String message, java.lang.Object[] params)
writeln
in interface LogWriter
severity
- The severity for this message.component
- The component that logs this message.message
- The message that has to be logged. See java.text.MessageFormat
for the format of this string.params
- The parameter list for the message. See java.text.MessageFormat
.public void writeln(int severity, java.lang.String component, java.lang.String message, java.lang.Object[] params, java.lang.Throwable t, boolean printStacktrace)
printStacktrace
parameter a stack trace
of the Exception will be logged too.
writeln
in interface LogWriter
severity
- The severity for this message.component
- The component that logs this message.message
- The message that has to be logged. See java.text.MessageFormat
for the format of this string.params
- The parameter list for the message. See java.text.MessageFormat
.t
- The Throwable that has to be logged.printStacktrace
- true
iff the stacktrace should be
logged.public boolean reset()
reset
in interface LogWriter
true
iff reset was successfulpublic void logFileContent(int severity, java.lang.String component, java.io.File file, java.lang.String encoding)
logFileContent
in interface LogWriter
severity
- The severity for this messagecomponent
- The component that logs this messagefile
- The file that has to be loggedencoding
- The encoding that should be used to read the filepublic java.io.Writer getWriter(int severity, java.lang.String component, java.lang.String message)
null
if trace is disabled.
getWriter
in interface LogWriter
severity
- The severity for this message.message
- A message that will be traced.
null
if trace is off otherwise current log writer is returned.public void releaseWriter(int severity, java.lang.String component, java.lang.String message)
releaseWriter
in interface LogWriter
severity
- The severity for this message.message
- A message that will be traced.public boolean switchOn(boolean on)
switchOn
in interface LogWriter
on
- true
iff the log should be switched on. The log
writer handles multiple calls of this method.
true
if switch was successful.public java.util.Vector getLogContent()
String
objects. Every object represents
a line of the log file. If there is no log file available an empty vector
is returned.
getLogContent
in interface LogWriter
public void initialize(java.lang.String configurationPrefix)
AppLog
or Trace
instances.
initialize
in interface LogWriter
configurationPrefix
- The configuration prefix that should be used to
initialize the log writer.public void setPrintProlog(boolean printProlog)
setPrintProlog
in interface LogWriter
printProlog
- true
if the log prolog should be written.public void setPrintAppendix(boolean printAppendix)
setPrintAppendix
in interface LogWriter
printAppendix
- true
if the log appendix should be
written.public java.io.InputStream getLogContentAsStream()
getLogContentAsStream
in interface com.sap.ip.me.api.logging.LogContentStreamSupport
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |