com.sap.tc.logging.interfaces

Interface IBaseLog

All Superinterfaces:

Cloneable, IObjectInfo

All Known Implementing Classes:

BaseLog

public interface IBaseLog
extends IObjectInfo, Cloneable

Method Summary

void	addFilter(IFilter filter) Adds another filter that controls messages flow via this log.
void	close() Closes this log object.
String	getEncoding() Gets the canonical name of the character encoding that is used for this log.
IFilter	getFilter(int index) Gets the filter that control messages flow via this log.
Collection	getFilters() Gets the filters that control messages flow via this log.
String	getFooter() Sets the footer text of this log.
Formatter	getFormatter() Gets the formatter that dictates the format of log records in this log.
String	getHeader() Gets the header text of this log.
int	getMode() Get current working mode
String	getPattern() Gets the name pattern of this file log.
String	getSource() Gets the source name of this file log.
boolean	isClosed() Check is this log closed.
boolean	isOpened() Check is this log opened.
void	open() Open this log object.
void	removeFilter(IFilter filter) Removes a filter so that it no longer controls messages flow via this log.
void	removeFilters() Removes all filters associated with this log.
void	setEncoding(String enc) Sets the named character encoding to be used for this log.
void	setFormatter(Formatter formatter) Sets the formatter that dictates the format of log records in this log.
void	setMode(int mode) Set current working mode.
void	setPattern(String value) Sets the name pattern of this log.
void	setSource(String value) Sets the source name of this log.
int	status() Status of this log object.

Methods inherited from interface com.sap.tc.logging.interfaces.IObjectInfo

getDescription, getName, getVerInUse

Method Detail

getPattern

String getPattern()

Gets the name pattern of this file log.

Returns:

Name pattern

See Also:

setPattern(java.lang.String)

setPattern

void setPattern(String value)

Sets the name pattern of this log.

getSource

String getSource()

Gets the source name of this file log.

Returns:

Source name

See Also:

setSource(java.lang.String)

setSource

void setSource(String value)

Sets the source name of this log. Source name represent a source where messages will be written, or from where messages will be read. Full source name will be built based on given pattern.

See Also:

setPattern(java.lang.String)

getFormatter

Formatter getFormatter()

Gets the formatter that dictates the format of log records in this log.

Returns:

Formatter

See Also:

setFormatter(Formatter)

setFormatter

void setFormatter(Formatter formatter)

Sets the formatter that dictates the format of log records in this log.

Parameters:

formatter - - Formatter instance. if formatter == null, default ListFormatter() will be created!

See Also:

getFormatter()

getHeader

String getHeader()

Gets the header text of this log.

Returns:

Text which represent header of this log.

See Also:

#setHeader(java.lang.String)

getFooter

String getFooter()

Sets the footer text of this log.

Returns:

Text which represent footer of this log.

See Also:

#setHeader(java.lang.String)

getEncoding

String getEncoding()

Gets the canonical name of the character encoding that is used for this log. If no character encoding is set the default character encoding of the platform is used.

Returns:

Name of character encoding. Can be null.

See Also:

setEncoding(java.lang.String)

setEncoding

void setEncoding(String enc)

Sets the named character encoding to be used for this log. If no character encoding is set the default character encoding is used.

Parameters:

enc - Name of character encoding

See Also:

getEncoding()

addFilter

void addFilter(IFilter filter)

Adds another filter that controls messages flow via this log. The results of all filters for a given message are logically anded to determine whether a message is to be processed.

Parameters:

filter - New filter

removeFilter

void removeFilter(IFilter filter)

Removes a filter so that it no longer controls messages flow via this log.

Parameters:

filter - Filter to be removed

getFilter

IFilter getFilter(int index)

Gets the filter that control messages flow via this log.

Returns:

Instance of IFilter stored on given position / index

getFilters

Collection getFilters()

Gets the filters that control messages flow via this log.

Returns:

Unmodifiable collection of filters associated with this log

removeFilters

void removeFilters()

Removes all filters associated with this log.

close

void close()
           throws CloseException

Closes this log object.

Throws:

CloseException

open

void open()
          throws OpenException

Open this log object.

Throws:

OpenException

isClosed

boolean isClosed()

Check is this log closed.

isOpened

boolean isOpened()

Check is this log opened.

status

int status()

Status of this log object.

getMode

int getMode()

Get current working mode

setMode

void setMode(int mode)

Set current working mode.

Access Rights

This class can be accessed from:

SC	DC
[sap.com] FRAMEWORK	[sap.com] tc/ddic/ddicruntime
[sap.com] ENGINEAPI	[sap.com] tc/logging
[sap.com] ENGFACADE	[sap.com] tc/bl/logging/api
[sap.com] CORE-TOOLS	[sap.com] com.sap.engine.client.lib
[sap.com] BRMS-FACADE	[sap.com] tc/brms/facade