Package org.sblim.cimclient
Class LogAndTraceManager
- java.lang.Object
-
- org.sblim.cimclient.LogAndTraceManager
-
public class LogAndTraceManager extends java.lang.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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addCIMXMLTraceListener(CIMXMLTraceListener pListener)
Adds a listener for CIM-XML trace messages.void
addLogListener(LogListener pListener)
Adds a listener for log messages.void
addTraceListener(TraceListener pListener)
Adds a listener for log messages.void
clearCIMXMLTraceListeners()
Removes all CIM-XML trace listeners.void
clearLogListeners()
Removes all listeners.void
clearTraceListeners()
Removes all listeners.java.util.List<CIMXMLTraceListener>
getCIMXMLTraceListeners()
Gets the registered CIM-XML trace listeners.java.util.List<LogListener>
getLogListeners()
Gets the registered log listeners including the internal console and file loggers.static LogAndTraceManager
getManager()
Returns the singleton instance of the manager.java.util.List<TraceListener>
getTraceListeners()
Gets the registered trace listeners including the internal console and file loggers.java.io.OutputStream
getXmlTraceStream()
Returns the stream to which the CIM-XML traces are sent.void
removeCIMXMLTraceListener(CIMXMLTraceListener pListener)
Removes a CIM-XML trace listener.void
removeLogListener(LogListener pListener)
Remove a listener.void
removeTraceListener(TraceListener pListener)
Removes a listener.void
setXmlTraceStream(java.io.OutputStream pStream)
Sets the stream to which the CIM-XML traces are sent.
-
-
-
Method Detail
-
getManager
public static LogAndTraceManager getManager()
Returns the singleton instance of the manager.- Returns:
- The manager
-
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
-
removeLogListener
public void removeLogListener(LogListener pListener)
Remove a listener. This listener will not be notified of log events anymore.- Parameters:
pListener
- The listener
-
clearLogListeners
public void clearLogListeners()
Removes all listeners. Caution: This will also remove the internal console and file loggers.
-
getLogListeners
public java.util.List<LogListener> getLogListeners()
Gets the registered log listeners including the internal console and file loggers.- Returns:
- An unmodifiable list of listeners
-
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
-
removeTraceListener
public void removeTraceListener(TraceListener pListener)
Removes a listener. This listener will not be notified of trace events anymore.- Parameters:
pListener
- The listener
-
clearTraceListeners
public void clearTraceListeners()
Removes all listeners. Caution this will also remove the internal trace file listener.
-
getTraceListeners
public java.util.List<TraceListener> getTraceListeners()
Gets the registered trace listeners including the internal console and file loggers.- Returns:
- A unmodifiable list of listeners
-
addCIMXMLTraceListener
public void addCIMXMLTraceListener(CIMXMLTraceListener pListener)
Adds a listener for CIM-XML trace messages. The listener will be notified of any CIM-XML trace event.- Parameters:
pListener
- The listener
-
removeCIMXMLTraceListener
public void removeCIMXMLTraceListener(CIMXMLTraceListener pListener)
Removes a CIM-XML trace listener. This listener will not be notified of CIM-XML trace events anymore.- Parameters:
pListener
- The listener
-
clearCIMXMLTraceListeners
public void clearCIMXMLTraceListeners()
Removes all CIM-XML trace listeners.
-
getCIMXMLTraceListeners
public java.util.List<CIMXMLTraceListener> getCIMXMLTraceListeners()
Gets the registered CIM-XML trace listeners.- Returns:
- A unmodifiable list of listeners
-
getXmlTraceStream
public java.io.OutputStream getXmlTraceStream()
Returns the stream to which the CIM-XML traces are sent. A value ofnull
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
-
setXmlTraceStream
public void setXmlTraceStream(java.io.OutputStream pStream)
Sets the stream to which the CIM-XML traces are sent. A value ofnull
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
-
-