IBM WebSphere Application ServerTM
Release 7

com.ibm.websphere.smf
Interface SmfEventInfrastructure


public interface SmfEventInfrastructure

A WebSphere programming model extension which allows connectors or application components register an object that may be driven if the state of SMF recording changes.


Field Summary
static int ADD_DATA_FAILED_NO_REQUEST
          Error: There is no request in dispatch on this thread
static int ADD_DATA_FAILED_RECORDING_OFF
          Error: SMF120 Subtype 9 recording is disabled
static int ADD_DATA_FAILED_TOO_BIG
          Error: User Data > 2K in length
static int ADD_DATA_FAILED_TOO_MANY
          Error: 5 types, the max, have been set already
static int ADD_DATA_OK
          OK: New type and value was added.
static int ADD_DATA_REPLACED_DATA
          OK: Data for this type was already set.
static int DEREGISTER_FAILED
          Error: Object found, but unable to be removed from registration container
static int DEREGISTER_OK
          OK: Object successfully deregistered
static int DEREGISTER_WARNING_NOTIFIER_NOT_REGISTERED
          Warning: Object not found in registration container
static java.lang.String SEI_LOC
          The location in JNDI where this object can be obtained.
 
Method Summary
 int addDataToSMF120Subtype9Record(int type, byte[] data)
          Used to provide data to be included in the User Data section of the SMF 120 Subtype 9 record.
 int deregister(SmfEventNotifier sen)
           
 java.lang.Boolean isSMF120Subtype9Enabled()
          Used to determine if SMF recording is enabled for the SMF 120 subtype 9 record.
 int register(SmfEventNotifier sen)
          Registers an SMFENObject with WebSphere.
 

Field Detail

SEI_LOC

static final java.lang.String SEI_LOC
The location in JNDI where this object can be obtained.

See Also:
Constant Field Values

DEREGISTER_OK

static final int DEREGISTER_OK
OK: Object successfully deregistered

See Also:
Constant Field Values

DEREGISTER_WARNING_NOTIFIER_NOT_REGISTERED

static final int DEREGISTER_WARNING_NOTIFIER_NOT_REGISTERED
Warning: Object not found in registration container

See Also:
Constant Field Values

DEREGISTER_FAILED

static final int DEREGISTER_FAILED
Error: Object found, but unable to be removed from registration container

See Also:
Constant Field Values

ADD_DATA_OK

static final int ADD_DATA_OK
OK: New type and value was added.

See Also:
Constant Field Values

ADD_DATA_REPLACED_DATA

static final int ADD_DATA_REPLACED_DATA
OK: Data for this type was already set. New value will be used.

See Also:
Constant Field Values

ADD_DATA_FAILED_TOO_BIG

static final int ADD_DATA_FAILED_TOO_BIG
Error: User Data > 2K in length

See Also:
Constant Field Values

ADD_DATA_FAILED_TOO_MANY

static final int ADD_DATA_FAILED_TOO_MANY
Error: 5 types, the max, have been set already

See Also:
Constant Field Values

ADD_DATA_FAILED_RECORDING_OFF

static final int ADD_DATA_FAILED_RECORDING_OFF
Error: SMF120 Subtype 9 recording is disabled

See Also:
Constant Field Values

ADD_DATA_FAILED_NO_REQUEST

static final int ADD_DATA_FAILED_NO_REQUEST
Error: There is no request in dispatch on this thread

See Also:
Constant Field Values
Method Detail

register

int register(SmfEventNotifier sen)
Registers an SMFENObject with WebSphere.

Parameters:
sen - The SMFENObject to register.
Returns:
0 if it works, non-zero if it doesn't.

deregister

int deregister(SmfEventNotifier sen)
Parameters:
sen - The SMFENObject to deregister.
Returns:
0 if it works, 1 if the object was not previously registered, or 2 if it failed

isSMF120Subtype9Enabled

java.lang.Boolean isSMF120Subtype9Enabled()
Used to determine if SMF recording is enabled for the SMF 120 subtype 9 record.


addDataToSMF120Subtype9Record

int addDataToSMF120Subtype9Record(int type,
                                  byte[] data)
Used to provide data to be included in the User Data section of the SMF 120 Subtype 9 record.

Parameters:
type - used to identify the owner of (and thus how to format) the User Data. The value ‘0’ is unused. The value ‘1’ is reserved for use by WebSphere Application Server. Values < 65535 are reserved for use by IBM. Values >= 65535 are available for use by customers etc. No more than 5 unique types of User Data can be added to a single request's record. Subsequent additions of an already present User Data type will overwrite the previous data of that type such that each User Data type in a given request record shall be unique.
data - The block of data to be included in the SMF 120 subtype 9 User Data record. Length cannot exceed 2KB.
Returns:
retcode (Values are defined as constants below)

IBM WebSphere Application ServerTM
Release 7