org.sblim.cimclient

Class LogAndTraceManager

public class LogAndTraceManager extends Object

Class LogAndTraceManager provides the means to register/unregister log and trace listeners. It is the entry point for application that want to redirect the CIM Client's log and trace messages into their own logging framework.
Method Summary
voidaddLogListener(LogListener pListener)
Adds a listener for log messages.
voidaddTraceListener(TraceListener pListener)
Adds a listener for log messages.
voidclearLogListeners()
Removes all listeners.
voidclearTraceListeners()
Removes all listeners.
List<LogListener>getLogListeners()
Gets the registered log listeners including the internal console and file loggers.
static LogAndTraceManagergetManager()
Returns the singleton instance of the manager.
List<TraceListener>getTraceListeners()
Gets the registered trace listeners including the internal console and file loggers.
OutputStreamgetXmlTraceStream()
Returns the stream to which the CIM-XML traces are sent.
voidremoveLogListener(LogListener pListener)
Remove a listener.
voidremoveTraceListener(TraceListener pListener)
Removes a listener.
voidsetXmlTraceStream(OutputStream pStream)
Sets the stream to which the CIM-XML traces are sent.

Method Detail

addLogListener

public void addLogListener(LogListener pListener)
Adds a listener for log messages. The listener will be notified of any log event.

Parameters: pListener The listener

addTraceListener

public void addTraceListener(TraceListener pListener)
Adds a listener for log messages. The listener will be notified of any trace event.

Parameters: pListener The listener

clearLogListeners

public void clearLogListeners()
Removes all listeners. Caution: This will also remove the internal console and file loggers.

clearTraceListeners

public void clearTraceListeners()
Removes all listeners. Caution this will also remove the internal trace file listener.

getLogListeners

public List<LogListener> getLogListeners()
Gets the registered log listeners including the internal console and file loggers.

Returns: An unmodifiable list of listeners

getManager

public static LogAndTraceManager getManager()
Returns the singleton instance of the manager.

Returns: The manager

getTraceListeners

public List<TraceListener> getTraceListeners()
Gets the registered trace listeners including the internal console and file loggers.

Returns: A unmodifiable list of listeners

getXmlTraceStream

public OutputStream getXmlTraceStream()
Returns the stream to which the CIM-XML traces are sent. A value of null means that tracing is effectively disabled. Otherwise the CIM-XML tracing can be activated either globally or per-connection via the "sblim.wbem.cimxmlTracing" configuration property.

Returns: The CIM-XML trace stream

removeLogListener

public void removeLogListener(LogListener pListener)
Remove a listener. This listener will not be notified of log events anymore.

Parameters: pListener The listener

removeTraceListener

public void removeTraceListener(TraceListener pListener)
Removes a listener. This listener will not be notified of trace events anymore.

Parameters: pListener The listener

setXmlTraceStream

public void setXmlTraceStream(OutputStream pStream)
Sets the stream to which the CIM-XML traces are sent. A value of null means that tracing is effectively disabled. Otherwise the CIM-XML tracing can be activated either globally or per-connection via the "sblim.wbem.cimxmlTracing" configuration property.

Parameters: pStream The CIM-XML trace stream

Copyright © 2005, 2009 IBM Corporation. All Rights Reserved.