com.ibm.eNetwork.ECL.trace
Class ECLTrace

java.lang.Object
  |
  +--com.ibm.eNetwork.ECL.trace.ECLTrace

public class ECLTrace

extends java.lang.Object

ECLTrace is used to register/unregister ECLTraceListeners and set/get the traceLevels for all the traceable HACL components.

Field Summary

static java.lang.String	SESSION_TRACE_COMM_EVENT
static java.lang.String	SESSION_TRACE_DS
static java.lang.String	SESSION_TRACE_ERR
static java.lang.String	SESSION_TRACE_FIELD
static java.lang.String	SESSION_TRACE_FIELDLIST
static java.lang.String	SESSION_TRACE_OIA
static java.lang.String	SESSION_TRACE_OIA_EVENT
static java.lang.String	SESSION_TRACE_PRINTER
static java.lang.String	SESSION_TRACE_PS
static java.lang.String	SESSION_TRACE_PS_EVENT
static java.lang.String	SESSION_TRACE_SCREENRECO_EVENT
static java.lang.String	SESSION_TRACE_SCREENRECODBG_EVENT
static java.lang.String	SESSION_TRACE_SCRN_RECO
static java.lang.String	SESSION_TRACE_SD
static java.lang.String	SESSION_TRACE_SESSION
static java.lang.String	SESSION_TRACE_TRANSPORT
static java.lang.String	SESSION_TRACE_XFER
static int	TRACE_MAXIMUM
static int	TRACE_MINIMUM
static int	TRACE_NONE
static int	TRACE_NORMAL

Constructor Summary

ECLTrace()

Method Summary

static int	GetTraceLevel(java.lang.String comp) Returns the trace level of the specified ECL component
static boolean	RegisterTraceEvent(ECLTraceListener notify) Registers a notification object for all trace events fired by HACL components.
static boolean	RegisterTraceEvent(ECLTraceListener notify, java.lang.String ID) Registers a notification object for trace events fired by HACL components.
static boolean	SetTraceLevel(java.lang.String comp, int traceLevel) Sets the trace level of the ECL component to the level passed in.
static boolean	UnregisterTraceEvent(ECLTraceListener notify) Unregisters a notification object previously registered with the RegisterTraceListener() method.
static boolean	UnregisterTraceEvent(ECLTraceListener notify, java.lang.String ID) Unregisters a notification object previously registered with the RegisterTraceListener() method.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TRACE_NONE

public static final int TRACE_NONE

TRACE_MINIMUM

public static final int TRACE_MINIMUM

TRACE_NORMAL

public static final int TRACE_NORMAL

TRACE_MAXIMUM

public static final int TRACE_MAXIMUM

SESSION_TRACE_SESSION

public static java.lang.String SESSION_TRACE_SESSION

SESSION_TRACE_PS

public static java.lang.String SESSION_TRACE_PS

SESSION_TRACE_FIELD

public static java.lang.String SESSION_TRACE_FIELD

SESSION_TRACE_FIELDLIST

public static java.lang.String SESSION_TRACE_FIELDLIST

SESSION_TRACE_OIA

public static java.lang.String SESSION_TRACE_OIA

SESSION_TRACE_ERR

public static java.lang.String SESSION_TRACE_ERR

SESSION_TRACE_XFER

public static java.lang.String SESSION_TRACE_XFER

SESSION_TRACE_DS

public static java.lang.String SESSION_TRACE_DS

SESSION_TRACE_TRANSPORT

public static java.lang.String SESSION_TRACE_TRANSPORT

SESSION_TRACE_OIA_EVENT

public static java.lang.String SESSION_TRACE_OIA_EVENT

SESSION_TRACE_PS_EVENT

public static java.lang.String SESSION_TRACE_PS_EVENT

SESSION_TRACE_COMM_EVENT

public static java.lang.String SESSION_TRACE_COMM_EVENT

SESSION_TRACE_SCREENRECO_EVENT

public static java.lang.String SESSION_TRACE_SCREENRECO_EVENT

SESSION_TRACE_SCREENRECODBG_EVENT

public static java.lang.String SESSION_TRACE_SCREENRECODBG_EVENT

SESSION_TRACE_SD

public static java.lang.String SESSION_TRACE_SD

SESSION_TRACE_SCRN_RECO

public static java.lang.String SESSION_TRACE_SCRN_RECO

SESSION_TRACE_PRINTER

public static java.lang.String SESSION_TRACE_PRINTER

Constructor Detail

ECLTrace

public ECLTrace()

Method Detail

RegisterTraceEvent

public static boolean RegisterTraceEvent(ECLTraceListener notify)

Registers a notification object for all trace events fired by HACL components. The notification object must implement the ECLTraceListener. The ECLTraceListener added through this method will receive trace events from every component being traced in every session. This method is designed for users who want to route all trace events to the same trace facility.

ECLTraceListener objects can be unregistered using the UnregisterTraceEvent() method.

Parameters:

notify - ECLTraceListener object which is notified when trace events are fired.

See Also:

UnregisterTraceEvent(com.ibm.eNetwork.ECL.trace.ECLTraceListener), RegisterTraceEvent(com.ibm.eNetwork.ECL.trace.ECLTraceListener, java.lang.String), ECLTraceListener

RegisterTraceEvent

public static boolean RegisterTraceEvent(ECLTraceListener notify,
                                         java.lang.String ID)

Registers a notification object for trace events fired by HACL components. The notification object must implement the ECLTraceListener. The ECLTraceListener added through this method will receive trace events only from those components being traced in the the session whose SESSION_NAME property matches the ID parameter. This method is designed for users who want to route trace events from different sessions to different trace facilities.

ECLTraceListener objects can be unregistered using the UnregisterTraceEvent() method.

Parameters:

notify - ECLTraceListener object which is notified when trace events are fired.

ID - Should match the SESSION_NAME property to receive events only from those components that are used by this session.

See Also:

UnregisterTraceEvent(com.ibm.eNetwork.ECL.trace.ECLTraceListener, java.lang.String), RegisterTraceEvent(com.ibm.eNetwork.ECL.trace.ECLTraceListener), ECLTraceListener

UnregisterTraceEvent

public static boolean UnregisterTraceEvent(ECLTraceListener notify)

Unregisters a notification object previously registered with the RegisterTraceListener() method. If the notification object is not currently registered, this method does nothing.

Parameters:

notify - ECLTraceListener object which should be unregistered.

See Also:

RegisterTraceEvent(com.ibm.eNetwork.ECL.trace.ECLTraceListener), UnregisterTraceEvent(com.ibm.eNetwork.ECL.trace.ECLTraceListener, java.lang.String), ECLTraceListener

UnregisterTraceEvent

public static boolean UnregisterTraceEvent(ECLTraceListener notify,
                                           java.lang.String ID)

Unregisters a notification object previously registered with the RegisterTraceListener() method. If the notification object is not currently registered, this method does nothing.

Parameters:

notify - ECLTraceListener object which should be unregistered.

ID - Unregister the ECLTraceListener associated with this session ID.

See Also:

RegisterTraceEvent(com.ibm.eNetwork.ECL.trace.ECLTraceListener, java.lang.String), UnregisterTraceEvent(com.ibm.eNetwork.ECL.trace.ECLTraceListener), ECLTraceListener

SetTraceLevel

public static boolean SetTraceLevel(java.lang.String comp,
                                    int traceLevel)

Sets the trace level of the ECL component to the level passed in. Returns true when it succeeds.

Parameters:

comp - Name of the component whose trace level should be changed

traceLevel - Trace level value.

GetTraceLevel

public static int GetTraceLevel(java.lang.String comp)

Returns the trace level of the specified ECL component

Parameters:

comp - Name of the component.

Returns:

The current trace level of this component.