Package com.ibm.websphere.ras
Class TrConfigurator
- java.lang.Object
-
- com.ibm.websphere.ras.TrConfigurator
-
public class TrConfigurator extends java.lang.ObjectConfigurator: Uses a LogProvider configuration to initialize the TrService service. The log provider is required to provide a non-null delegate. This delegate can not be reset.
-
-
Constructor Summary
Constructors Constructor Description TrConfigurator()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static voidaddTraceComponentListener(TraceComponentChangeListener tcl)static java.lang.StringgetEffectiveTraceSpec()static TextFileOutputStreamFactorygetFileOutputStreamFactory()static java.lang.StringgetLogLocation()static voidinit(com.ibm.wsspi.logprovider.LogProviderConfig config)Initialize Tr (and underlying Tr service).static voidregisterTraceComponent(TraceComponent tc)This method (to register pre-created TraceComponents) is needed: but it should not be on the main/base Tr API, as it is not something that should be called frequently.static voidremoveTraceComponentListener(TraceComponentChangeListener tcl)static voidsetInstrumentation(boolean instrumentation)static voidsetMessageRouter(MessageRouter msgRouter)Set the MessageRouter into the TrService delegate.static voidsetTraceRouter(com.ibm.ws.logging.WsTraceRouter msgRouter)Set the TraceRouter into the TrService delegate.static voidstop()Stop the Tr service (the disabled delegate will be used until reconfigured).static voidunsetMessageRouter(MessageRouter msgRouter)UnSet the MessageRouter from the TrService delegate.static voidunsetTraceRouter(com.ibm.ws.logging.WsTraceRouter msgRouter)UnSet the TraceRouter from the TrService delegate.static voidupdate(java.util.Map<java.lang.String,java.lang.Object> newConfig)Update Tr with new configuration values (based on injection via config admin).
-
-
-
Method Detail
-
init
public static void init(com.ibm.wsspi.logprovider.LogProviderConfig config)
Initialize Tr (and underlying Tr service).
-
update
public static void update(java.util.Map<java.lang.String,java.lang.Object> newConfig)
Update Tr with new configuration values (based on injection via config admin). The parameter map should be modified to match actual values used (e.g. substitution in case of error).- Parameters:
newConfig-
-
addTraceComponentListener
public static void addTraceComponentListener(TraceComponentChangeListener tcl)
-
removeTraceComponentListener
public static void removeTraceComponentListener(TraceComponentChangeListener tcl)
-
getEffectiveTraceSpec
public static java.lang.String getEffectiveTraceSpec()
- Returns:
- the trace specification the server is using.
-
getLogLocation
public static java.lang.String getLogLocation()
- Returns:
-
stop
public static void stop()
Stop the Tr service (the disabled delegate will be used until reconfigured).
-
setInstrumentation
public static void setInstrumentation(boolean instrumentation)
- Parameters:
instrumentation-
-
setMessageRouter
public static void setMessageRouter(MessageRouter msgRouter)
Set the MessageRouter into the TrService delegate.
-
unsetMessageRouter
public static void unsetMessageRouter(MessageRouter msgRouter)
UnSet the MessageRouter from the TrService delegate.
-
setTraceRouter
public static void setTraceRouter(com.ibm.ws.logging.WsTraceRouter msgRouter)
Set the TraceRouter into the TrService delegate.
-
unsetTraceRouter
public static void unsetTraceRouter(com.ibm.ws.logging.WsTraceRouter msgRouter)
UnSet the TraceRouter from the TrService delegate.
-
registerTraceComponent
public static void registerTraceComponent(TraceComponent tc)
This method (to register pre-created TraceComponents) is needed: but it should not be on the main/base Tr API, as it is not something that should be called frequently.- Parameters:
tc-
-
getFileOutputStreamFactory
public static TextFileOutputStreamFactory getFileOutputStreamFactory()
- Returns:
-
-