com.ibm.eNetwork.HOD.trace
Class RASTrace

java.lang.Object
  |
  +--com.ibm.eNetwork.beans.HOD.HODBean
        |
        +--com.ibm.eNetwork.HOD.trace.RASTrace

All Implemented Interfaces:

java.lang.Cloneable, ECLTraceListener, java.util.EventListener, java.io.Externalizable, com.ibm.eNetwork.HOD.common.HODConstants, java.beans.PropertyChangeListener, com.ibm.eNetwork.HOD.RASTraceIntf, java.io.Serializable, com.ibm.eNetwork.beans.HOD.trace.TraceListener, com.ibm.eNetwork.beans.HOD.trace.TraceProducer

public class RASTrace

extends com.ibm.eNetwork.beans.HOD.HODBean

implements com.ibm.eNetwork.beans.HOD.trace.TraceListener, ECLTraceListener, com.ibm.eNetwork.HOD.RASTraceIntf

This class implements a windowed interface which allows users to visually set component trace levels, capture trace data, and save it. This class implements both the Beans TraceListener interface and the HACL ECLTraceListener interface, so it can be used with either set of trace APIs to display trace information.

By default RASTrace is not visible--the user must call setVisible(true) to display RASTrace.

See Also:

Serialized Form

Field Summary

static java.lang.String	ENABLED enabled property keyword
static java.lang.String	VISIBLE visible property keyword

Fields inherited from class com.ibm.eNetwork.beans.HOD.HODBean

BEAN_VERSION_STRING, DEBUG, TRACE_LEVEL, TRACE_MAXIMUM, TRACE_MINIMUM, TRACE_NONE, TRACE_NORMAL, traceLevel

Fields inherited from interface com.ibm.eNetwork.HOD.common.HODConstants

DEFAULT_WIN_FONT, HOD_ICON_EVENT, HOD_MSG_FILE, HOD_RAS_COMPID_ADVMACRO, HOD_RAS_COMPID_ASSOC_PRT, HOD_RAS_COMPID_BLINKREMAP, HOD_RAS_COMPID_CODEPAGE, HOD_RAS_COMPID_COLORREMAP, HOD_RAS_COMPID_CONFIG, HOD_RAS_COMPID_FILETRANSFER, HOD_RAS_COMPID_FTP_SCREEN, HOD_RAS_COMPID_FTP_SESSION, HOD_RAS_COMPID_FTP_TERMINAL, HOD_RAS_COMPID_FUDOMA, HOD_RAS_COMPID_HOD_API, HOD_RAS_COMPID_IMPEXP, HOD_RAS_COMPID_JNILOAD, HOD_RAS_COMPID_KEYPAD, HOD_RAS_COMPID_KEYREMAP, HOD_RAS_COMPID_MACRO, HOD_RAS_COMPID_MACROMANGR, HOD_RAS_COMPID_PRT_TERMINAL, HOD_RAS_COMPID_SCREEN, HOD_RAS_COMPID_SESSION, HOD_RAS_COMPID_SESSION_MGR, HOD_RAS_COMPID_SLP, HOD_RAS_COMPID_TERMINAL, HOD_RAS_COMPID_ZIPPRINT, HOD_RAS_FUNC_NAME, HOD_START_UP, HOD_TRANSFER_FILE_INFO, MOUSE_DOUBLE_CLICK_THRESHOLD, XFER_ASCII_GET_OPTIONS, XFER_ASCII_GET_OPTIONS_DEFAULT, XFER_ASCII_PUT_OPTIONS, XFER_ASCII_PUT_OPTIONS_DEFAULT, XFER_BINARY_GET_OPTIONS, XFER_BINARY_GET_OPTIONS_DEFAULT, XFER_BINARY_PUT_OPTIONS, XFER_BINARY_PUT_OPTIONS_DEFAULT, XFER_DEFAULT_OPTIONS, XFER_FILETYPE_DTA, XFER_FILETYPE_SAVF, XFER_FILETYPE_SRC, XFER_HOST_TYPE, XFER_HOST_TYPE_CICS, XFER_HOST_TYPE_CMS, XFER_HOST_TYPE_DEFAULT, XFER_HOST_TYPE_OS400, XFER_HOST_TYPE_TSO, XFER_PACKET_SIZE, XFER_PACKET_SIZE_DEFAULT, XFER_TIME_OUT_VALUE, XFER_TIME_OUT_VALUE_DEFAULT, XFER_TRANSFER_MODE, XFER_TRANSFER_MODE_ASCII, XFER_TRANSFER_MODE_BINARY, XFER_TRANSFER_MODE_DEFAULT

Constructor Summary

RASTrace()
Create a RASTrace object with default properties.

RASTrace(java.util.Properties p)
Create a RASTrace object with new properties.

Method Summary

static java.util.Properties	defaults() Static method to access the trace default properties.
java.lang.Object	getLog()
java.lang.Object	getRASAdmin()
com.ibm.eNetwork.beans.HOD.trace.TraceListener	getTraceListener() Method to return the TraceListener.
java.lang.String	getTraceName() Returns a trace identifier for this bean.
boolean	isEnabled() Method to return whether trace is enabled.
boolean	isVisible() Method to return visibility of trace GUI.
void	openLocalMessageConsole() Method to handle trace events from a HACL component.
void	registerSingleTraceComponent(java.lang.String FunctionName, java.lang.String Component, int level)
void	setEnabled(boolean enable) Method to enable or disable trace.
void	setSaveToServe(boolean storeToServer)
boolean	setTraceLevel(java.lang.String function, java.lang.String component, int level)
void	setTraceNumRecords(int inTraceNumRecords)
void	setVisible(boolean show) Method to show or hide the trace GUI.
void	traceEvent(com.ibm.eNetwork.beans.HOD.trace.TraceEvent e) Method to handle trace events from a Bean.
void	TraceNotifyEvent(ECLTraceEvent e) Method to handle trace events from a HACL component.

Methods inherited from class com.ibm.eNetwork.beans.HOD.HODBean

addPropertyChangeListener, addTraceListener, addVetoableChangeListener, clone, dispose, fireTraceEvents, getComponent, getDebugFlag, getFunction, getProperties, getTraceLevel, getVersion, logException, propertyChange, readExternal, removePropertyChangeListener, removeTraceListener, removeVetoableChangeListener, setProperties, setTraceLevel, setVersion, toString, traceMessage, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

VISIBLE

public static final java.lang.String VISIBLE

visible property keyword

ENABLED

public static final java.lang.String ENABLED

enabled property keyword

Constructor Detail

RASTrace

public RASTrace()

Create a RASTrace object with default properties. This constructor can be used to create the trace facility for Beans applets and applications.

RASTrace

public RASTrace(java.util.Properties p)
         throws java.beans.PropertyVetoException

Create a RASTrace object with new properties. This constructor can be used to create the trace facility for Beans applets and applications.

Parameters:

p - Properties for RASTrace.

Throws:

java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.

Method Detail

setVisible

public void setVisible(boolean show)
                throws java.beans.PropertyVetoException

Method to show or hide the trace GUI. The trace GUI is initially invisible.

Specified by:

setVisible in interface com.ibm.eNetwork.HOD.RASTraceIntf

Parameters:

show - True to show, false to hide.

Throws:

java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.

isVisible

public boolean isVisible()

Method to return visibility of trace GUI.

getTraceListener

public com.ibm.eNetwork.beans.HOD.trace.TraceListener getTraceListener()

Method to return the TraceListener.

Specified by:

getTraceListener in interface com.ibm.eNetwork.HOD.RASTraceIntf

setEnabled

public void setEnabled(boolean enable)
                throws java.beans.PropertyVetoException

Method to enable or disable trace. Tracing is initially disabled.

Specified by:

setEnabled in interface com.ibm.eNetwork.HOD.RASTraceIntf

Parameters:

enable - True to enable trace; false to disable.

Throws:

java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.

setSaveToServe

public void setSaveToServe(boolean storeToServer)

Specified by:

setSaveToServe in interface com.ibm.eNetwork.HOD.RASTraceIntf

setTraceNumRecords

public void setTraceNumRecords(int inTraceNumRecords)

Specified by:

setTraceNumRecords in interface com.ibm.eNetwork.HOD.RASTraceIntf

setTraceLevel

public boolean setTraceLevel(java.lang.String function,
                             java.lang.String component,
                             int level)

Specified by:

setTraceLevel in interface com.ibm.eNetwork.HOD.RASTraceIntf

getLog

public java.lang.Object getLog()

Specified by:

getLog in interface com.ibm.eNetwork.HOD.RASTraceIntf

getRASAdmin

public java.lang.Object getRASAdmin()

Specified by:

getRASAdmin in interface com.ibm.eNetwork.HOD.RASTraceIntf

isEnabled

public boolean isEnabled()

Method to return whether trace is enabled.

traceEvent

public void traceEvent(com.ibm.eNetwork.beans.HOD.trace.TraceEvent e)

Method to handle trace events from a Bean.

Specified by:

traceEvent in interface com.ibm.eNetwork.beans.HOD.trace.TraceListener

Parameters:

e - TraceEvent.

TraceNotifyEvent

public void TraceNotifyEvent(ECLTraceEvent e)

Method to handle trace events from a HACL component.

Specified by:

TraceNotifyEvent in interface ECLTraceListener

Parameters:

e - ECLTraceEvent.

openLocalMessageConsole

public void openLocalMessageConsole()

Method to handle trace events from a HACL component.

Specified by:

openLocalMessageConsole in interface com.ibm.eNetwork.HOD.RASTraceIntf

getTraceName

public java.lang.String getTraceName()

Returns a trace identifier for this bean.

Overrides:

getTraceName in class com.ibm.eNetwork.beans.HOD.HODBean

defaults

public static java.util.Properties defaults()

Static method to access the trace default properties.

registerSingleTraceComponent

public void registerSingleTraceComponent(java.lang.String FunctionName,
                                         java.lang.String Component,
                                         int level)

Specified by:

registerSingleTraceComponent in interface com.ibm.eNetwork.HOD.RASTraceIntf