com.sap.ip.me.api.logging
Class DefaultSystemLogWriter

java.lang.Object
  com.sap.ip.me.api.logging.DefaultSystemLogWriter

All Implemented Interfaces:

LogWriter

public class DefaultSystemLogWriter

extends java.lang.Object

implements LogWriter

Default System.out log writer implementation for Mobile Infrastructure. All messages will be logged to System.out.

Since:

MI 2.5

Author:

SAP

Constructor Summary

DefaultSystemLogWriter()

Method Summary

java.util.Vector	getLogContent() Returns an empty vector because the DefaultSystemLogWriter does not support this feature.
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.
boolean	reset() Does nothing because this functionality is not supported by DefaultSystemLogWriter .
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 to System.out.
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 to System.out.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSystemLogWriter

public DefaultSystemLogWriter()

Method Detail

logFileContent

public 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.

Specified by:

logFileContent in interface LogWriter

Parameters:

severity - The severity for this message

component - The component that logs this message

file - The file that has to be logged

encoding - The encoding that should be used to read the file

reset

public boolean reset()

Does nothing because this functionality is not supported by DefaultSystemLogWriter .

Specified by:

reset in interface LogWriter

Returns:

Returns always true

switchOn

public boolean switchOn(boolean on)

Switch the log writer on or off.

Specified by:

switchOn in interface LogWriter

Parameters:

on - true iff the log should be switched on. The log writer has to handle multiple calls of this method.

Returns:

Returns true if switch was successful.

writeln

public 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 to System.out. Depending of the printStacktrace parameter a stack trace of the Exception will be logged too.

Specified by:

writeln in interface LogWriter

Parameters:

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.

See Also:

<{java.text.MessageFormat}>

writeln

public void writeln(int severity,
                    java.lang.String component,
                    java.lang.String message,
                    java.lang.Object[] params)

Formats the message and writes it to System.out.

Specified by:

writeln in interface LogWriter

Parameters:

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 .

See Also:

<{java.text.MessageFormat}>

getLogContent

public java.util.Vector getLogContent()

Returns an empty vector because the DefaultSystemLogWriter does not support this feature.

Specified by:

getLogContent in interface LogWriter

Returns:

An empty vector

initialize

public void initialize(java.lang.String configurationPrefix)

Initializes the log writer with given configuration prefix. DO NOT call this method . This method is called by the Mobile Infrastructure framework after creation of AppLog or Trace instances.

Specified by:

initialize in interface LogWriter

Parameters:

configurationPrefix - The configuration prefix that should be used to initialize the log writer.

setPrintProlog

public void setPrintProlog(boolean printProlog)

Sets the flag if the log prolog should be written everytime the log is switched on.

Specified by:

setPrintProlog in interface LogWriter

Parameters:

printProlog - true if the log prolog should be written.

setPrintAppendix

public void setPrintAppendix(boolean printAppendix)

Sets the flag if the log appendix should be written everytime the log is switched off.

Specified by:

setPrintAppendix in interface LogWriter

Parameters:

printAppendix - true if the log appendix should be written.