com.ibm.websphere.ras
Class TrConfigurator

java.lang.Object
  extended by com.ibm.websphere.ras.TrConfigurator

public class TrConfigurator
extends java.lang.Object

Configurator: 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
TrConfigurator()
           
 
Method Summary
static void addTraceComponentListener(TraceComponentChangeListener tcl)
           
static TextFileOutputStreamFactory getFileOutputStreamFactory()
           
static java.lang.String getLogLocation()
           
static void init(com.ibm.wsspi.logprovider.LogProviderConfig config)
          Initialize Tr (and underlying Tr service).
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.
static void removeTraceComponentListener(TraceComponentChangeListener tcl)
           
static void setInstrumentation(boolean instrumentation)
           
static void setMessageRouter(MessageRouter msgRouter)
          Set the MessageRouter into the TrService delegate.
static com.ibm.ws.logging.internal.TraceSpecification setTraceSpec(java.lang.String spec)
          Set the trace specification of the service to the input value.
static void stop()
          Stop the Tr service (the disabled delegate will be used until reconfigured).
static void unsetMessageRouter(MessageRouter msgRouter)
          UnSet the MessageRouter from the TrService delegate.
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).
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TrConfigurator

public TrConfigurator()
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)

setTraceSpec

public static com.ibm.ws.logging.internal.TraceSpecification setTraceSpec(java.lang.String spec)
Set the trace specification of the service to the input value.

Parameters:
spec - New string trace specification
Returns:
new TraceSpecification, or null if unchanged

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.


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: