Chapter 4. JoltBeans Toolkit Class Library Reference

The JoltBeans Toolkit Class Library provides a JavaBeans compliant interface to Jolt. JoltBeans wrap the existing Jolt class library into reusable bean components, such as the JoltSessionBean or the JoltServiceBean. JoltBeans components are not specific to any given application.

Note: For information on the Jolt aware AWT Beans, that include JoltLabel, JoltCheckbox, JoltTextField, JoltChoice, and JoltList, refer to Chapter 5, "Jolt Aware AWT Beans Class Library Reference."

The bea.jolt.beans package includes the following classes:

JoltInputEvent Class

java.lang.Object
|
+----java.util.EventObject
|
+----bea.jolt.beans.JoltInputEvent

JoltInputEvent carries information about input data to JoltServiceBeans. An instance of JoltInputEvent represents a single input field (possibly with multiple occurrences) to a TUXEDO service. Typically, this event is sent by a GUI element when its data content changes.

JoltInputEvent Constructors

The JoltInputEvent constructors create objects that carry information about input data to JoltServiceBeans. The input field can be a single data element, one of many occurrence of an element, or an entire array. Input data can be either a string or a native datatype (e.g. Float, Double).

JoltInputEvent - single data element

This constructor is used when the input is a single data element and it is represented in a native data format.

Synopsis

JoltInputEvent(Object source, String fieldName, Object value)

Parameters

source
Event source

fieldName
Name of the input field (Jolt name)

value
Value of the field in a native data type, such as Integer or Float

Usage

This constructor is used when the input is a single data element and it is represented in a native data format.

JoltInputEvent - multiple occurrences; only one occurrence set

This constructor is used when the input is a data element with multiple occurrences, but only one occurrence is to be set, and it is represented in a native data format.

Synopsis

JoltInputEvent(Object source, String fieldName, Object value, int  pos)

Parameters

source
Event source

fieldName
Name of the input field (Jolt name)

value
Value of the field in a native data type, such as Integer or Float

pos
The position of the data element

Usage

This constructor is used when the input is a data element with multiple occurrences, but only one occurrence is to be set, and it is represented in a native data format.

JoltInputEvent - data element with multiple occurrences

This constructor is used when the input is a data element with multiple occurrences and it is represented in a native data format.

Synopsis

JoltInputEvent(Object source, String fieldName, Object values[])

Parameters

source
Event source

fieldName
Name of the input field (Jolt name)

values
Array of occurrences of the field in a native data type, such as Integer or Float

Usage

This constructor is used when the input is a data element with multiple occurrences and it is represented in a native data format.

JoltInputEvent - single element; String

This constructor is used when the input is a single data element and it is represented as a String.

Synopsis

JoltInputEvent(Object source, String fieldName, String textValue)

Parameters

source
Event source

fieldName
Name of the input field (Jolt name)

textValue
Value of the field as a String

Usage

This constructor is used when the input is a single data element and it is represented as a String. The JoltInputEvent object will perform the necessary data conversion.

JoltInputEvent - multiple occurrences; only one occurrence set; String

This constructor is used when the input is a data element with multiple occurrences, but only one occurrence is to be set, and it is represented as a String.

Synopsis

JoltInputEvent(Object source, String fieldName, String textValue, int pos)

Parameters

source
Event source

fieldName
Name of the input field (Jolt name)

textValue
Value of the field as a String

pos
The position of the data element

Usage

This constructor is used when the input is a data element with multiple occurrences, but only one occurrence is to be set, and it is represented as a String. The JoltInputEvent object performs the necessary data conversion.

JoltInputEvent - multiple occurrences; array of Strings

This constructor is used when the input is a data element with multiple occurrences and it is represented as an array of Strings.

Synopsis

JoltInputEvent(Object source, String fieldName, String  textValues[])

Parameters

source
Event source

fieldName
Name of the input field (Jolt name)

textValues
Array of occurrences of the field as String

Usage

This constructor is used when the input is a data element with multiple occurrences and it is represented as an array of Strings. The JoltInputEvent object will perform the necessary data conversion.

JoltInputEvent Methods

The following methods are used in conjunction with the JoltInputEvent class:

getValue

The getValue() method gets the value of the field in its native representation.

Synopsis

Object getValue()

Usage

Get the value in its native representation.

Returns

Value of the field.

getValues

The getValues() method gets the occurring values of the field in its native representation.

Synopsis

Object[] getValues()

Usage

Get the occurring values in its native representation.

Returns

The occurrences of the field.

getTextValue

The getTextValue() method gets the value as a String.

Synopsis

String getTextValue()

Usage

Get the value as a String.

Returns

The value of the field as a String.

getTextValues

The getTextValues() method gets the occurring values as String.

Synopsis

String[] getTextValues()

Usage

Get the occurring values as String.

Returns

The occurrences of the field as a String

getFieldName

The getFieldName() method gets the name of the field.

Synopsis

String getFieldName()

Usage

Get the name of the field.

Returns

The name of the field

getOccurrenceCount

The getOccurrenceCount() method gets the number of occurrences of a named item.

Synopsis

int getOccurrenceCount()

Usage

Get the number of occurrences of the field.

Returns

The number of occurrences.

getSingleOccurrence

The getSingleOccurrence() method gets the position of the field.

Synopsis

int getSingleOccurrence()

Usage

Get the position of the field. These are:

Returns

Position

isText

The isText() method returns true if the field type is String, otherwise it returns false.

Synopsis

boolean isText()

Retuns

True if the field type is String, otherwise it returns false.

isVector

The isVector() method retuns true if the field has multiple occurrences, otherwise it returns false.

Synopsis

boolean isVector()

Retuns

True if the field has multiple occurrences, otherwise it returns false.

JoltOutputEvent Class

java.lang.Object
|
+----java.util.EventObject
|
+----bea.jolt.beans.JoltOutputEvent

JoltOutputEvent is the event class for event objects sent from JoltServiceBeans to GUI elements when the reply from the TUXEDO service is received.

JoltOutputEvent Methods

The following methods are used in conjunction with the JoltOutputEvent class:

isEventMessage

The isEventMessage() method returns a boolean value that is true if this JoltOutputEvent has been constructed for a TUXEDO event. It is false if this JoltOutputEvent has been constructed for a service reply.

Synopsis

boolean isEventMessage()

Usage

Gets the flag indicating the origin of the event.

Returns

True if this is a TUXEDO user event or false if this is a service reply.

getValue - value of a field

The getValue() method gets the value of a field in the output buffer.

Synopsis

Object getValue(String fieldName)

Parameters

fieldName
Name of the field (Jolt field name).

Usage

Gets the value of a field in the output buffer.

Returns

Value of the field in native data format.

getValue - value of one occurrence of a field

The getValue() method gets the value of one occurrence of a field in the output buffer.

Synopsis

Object getValue(String fieldName, int index)

Parameters

fieldName
Name of the field (Jolt field name).

index
The occurrence index of the field.

Usage

Gets the value of one occurrence of a field in the output buffer.

Returns

Value of the field in native data format

getValues

The getValues() method gets all occurrences of a field in the output buffer.

Synopsis

Object[] getValues(String fieldName)

Parameters

fieldName
Name of the field (Jolt field name)

Usage

Get all occurrences of a field in the output buffer.

Returns

Array of all occurrences in native data format.

getTextValue - value of a field

The getTextValue() method gets the value of a field in the output buffer as String.

Synopsis

String getTextValue(String fieldName)

Parameters

fieldName
Name of the field (Jolt field name)

Usage

Get the value of a field in the output buffer.

Returns

Value of the field as String.

getTextValue - value of one occurrence of a field

The getTextValue() method gets the value of one occurrence of a field in the output buffer.

Synopsis

String getTextValue(String fieldName, int index)

Parameters

fieldName
Name of the field (Jolt field name)

index
The occurrence index of the field.

Usage

Get the value of one occurrence of a field in the output buffer.

Returns

Value of the field as String.

getTextValues

The getTextValues() method gets all occurrences of a field in the JoltOutput message buffer.

Synopsis

String[] getTextValues(String fieldName)

Parameters

fieldName
Name of the field (Jolt field name)

Usage

Get all occurrences of a field in the output buffer.

Returns

Array of all occurrences as String array.

JoltServiceBean Class

java.lang.Object
|
+----bea.jolt.beans.JoltServiceBean

The JoltServiceBean represents a remote TUXEDO service. It listens to JoltInputEvents from other beans to populate its input buffer. JoltServiceBean offers the callService() method to invoke the service.

JoltServiceBean is an event source for JoltOutputEvents that carry information about output of the service. After a successful callService() listener beans are notified via a JoltOutputEvent that carries the output buffer.

Note: All getOutputValue/getOutputTextValue methods operate on output parameters only. All setInputValue/setInputTextValue methods operate on input parameters only.

JoltServiceBean Constructor

The JoltServiceBean constructor creates a bean representing a Jolt service.

JoltServiceBean

This constructor creates an instance of the JoltServiceBean class.

Synopsis

JoltServiceBean()

See Also

JoltInputEvent, JoltOutputEvent

JoltServiceBean Methods

The following methods are used in conjunction with the JoltServiceBean class:

propertyChange

The propertyChange() method is the event handler for PropertyChange events.

Synopsis

void propertyChange(PropertyChangeEvent evt)

Parameters

evt
The event object.

Usage

Event handler for PropertyChange events. The JoltSessionBean notifies the JoltServiceBean when it logs on and off by raising a PropertyChangeEvent about its LoggedOn property. The logoff of a session, other than the current session, does not affect the JoltServiceBean. This method should not be called directly.

dataChanged

The dataChanged() method is the event handler method for JoltInputEvents. The JoltServiceBean updates the input buffer field specified in the JoltInputEvent to the value specified in the event.

Synopsis

void dataChanged(JoltInputEvent evt)

Parameters

evt
The event object.

Usage

Event handler for JoltInputEvents. This method should not be called directly.

setServiceName

The setServiceName() method sets the name of the remote service that this bean represents.

Synopsis

void setServiceName(String name)

Parameters

name
Service name

Usage

Sets the name of the remote service that this bean represents.

getServiceName

The getServiceName() method gets the name of the remote service that this bean represents.

Synopsis

String getServiceName()

Usage

Gets the name of the remote service that this bean represents.

Returns

The name of the TUXEDO service.

isTransactional

The isTransactional() method returns true if the bean is in transactional mode, otherwise it returns false.

Synopsis

boolean isTransactional()

Usage

Set to true if this JoltServiceBean is to be included in the transaction that was started by its JoltSessionBean.

Returns

True or false.

setTransactional

The setTransactional() method sets the transactional mode of the bean.

Synopsis

void setTransactional(boolean mode)

Parameters

mode
True or false

Usage

Set to true if this JoltServiceBean is to be included in the transaction that was started by its JoltSessionBean.

setSession

The setSession() method is used in cases when the JoltServiceBean is created after the logon event. Otherwise, the JoltServiceBean gets access to a TUXEDO client session by listening to JoltSessionEvents.

Synopsis

void setSession(JoltSessionBean value)

Parameters

value
The JoltSessionBean that is used by this service bean

Usage

Sets the JoltSessionBean associated with this JoltServiceBean.

getSession

The getSession() method gets the JoltSessionBean used by this JoltServiceBean.

Synopsis

JoltSessionBean getSession()

Usage

Gets the JoltSessionBean used by this JoltServiceBean.

Returns

JoltSessionBean

getOutputValue - value of field

The getOutputValue() method gets the value of a field in the output buffer using the field's native type.

Synopsis

Object getOutputValue(String fieldName)

Parameters

fieldName
Name of the field.

Usage

Gets the value of a field in the output buffer using the field's native type.

Returns

Value of the field.

Throws

NoSuchFieldError

getOutputValue - value of one occurrence of field

The getOutputValue() method gets the value of one occurrence of a field in the output buffer using the field's native type.

Synopsis

Object getOutputValue(String fieldName, int index)

Parameters

fieldName
Name of the field.

index
Index of the field.

Usage

Gets the value of one occurrence in the output buffer using the field's native type.

Returns

Value of the field.

Throws

NoSuchFieldError

getOutputValues

The getOutputValues() method gets all of the occurrences of a field in the output buffer using field's native type.

Synopsis

Object[] getOutputValues(String fieldName)

Parameters

fieldName
The name of the field.

Usage

Gets all of the occurrences of a field in the output buffer using field's native type.

Returns

The occurrences of the field.

Throws

NoSuchFieldError

getOutputTextValue - value of field

The getOutputTextValue() method gets the value of a field in the output buffer as a String.

Synopsis

String getOutputTextValue(String fieldName)

Parameters

fieldName
The name of the field

Usage

Gets the value of a field in the output buffer as a String.

Returns

The value of the field as a String.

Throws

NoSuchFieldError

getOutputTextValue - value of one occurrence of field

The getOutputTextValue() method gets the value of one occurrence of a field in the output buffer as a String.

Synopsis

String getOutputTextValue(String fieldName, int index)

Parameters

fieldName
The name of the field.

index
Index of the field.

Usage

Gets the value of one occurrence of a field in the output buffer as a String.

Returns

The value of the field as a String.

Throws

NoSuchFieldError

getOutputTextValues

The getOutputTextValues() method gets all the occurrences of a field in the output buffer as String.

Synopsis

String[] getOutputTextValues(String fieldName)

Parameters

fieldName
Name of the field.

Usage

Gets all the occurrences of a field in the output buffer as String.

Returns

The occurrences of the field as a String.

Throws

NoSuchFieldError

setInputValue - value of field

The setInputValue() method sets the value of a field in the input buffer using the field's native type.

Synopsis

void setInputValue(String fieldName, Object value)

Parameters

fieldName
The name of the field.

value
Value to be set.

Usage

Sets the value of a field in the input buffer using the field's native type.

Throws

NoSuchFieldError, ClassCastException

setInputValue - value of one occurrence of field

The setInputValue() method sets the value of one occurrence of a field in the input buffer using the field's native type.

Synopsis

void setInputValue(String fieldName, int index, Object value)

Parameters

fieldName
The name of the field.

index
Index of the field.

value
Value to be set.

Usage

Sets the value of one occurrence of a field in the input buffer using the field's native type.

Throws

NoSuchFieldError, ClassCastException

setInputValues

The setInputValues() method sets all the occurrences of a field in the input buffer using the field's native type.

Synopsis

void setInputValues(String fieldName, Object values[])

Parameters

fieldName
The name of the field

values
The value to set.

Usage

Sets all the occurrences of a field in the input buffer using the field's native type. This method operates using input parameters only.

Throws

NoSuchFieldError, ClassCastException

setInputTextValue - value of field

The setInputTextValue() method sets the value of a field in the input buffer as a String.

Synopsis

void setInputTextValue(String fieldName, String textValue) 

Parameters

fieldName
The name of the field.

textValue
The value to set.

Usage

Sets the value of a field in the input buffer as a String.

Throws

NoSuchFieldError, NumberFormatException

setInputTextValue - value of one occurrence of field

The setInputTextValue() method sets the value of one occurrence of a field in the input buffer as a String.

Synopsis

void setInputTextValue(String fieldName, int index, String  textValue) 

Parameters

fieldName
The name of the field.

index
Index of the field.

textValue
The value to set.

Usage

Sets the value of one occurrence of a field in the input buffer as a String.

Throws

NoSuchFieldError, NumberFormatException

setInputTextValues

The setInputTextValues() method sets all the occurrences of a field in the input buffer as String.

Synopsis

void setInputTextValues(String fieldName, String textValues[]) 

Parameters

fieldName
The name of the field.

textValues
The values to set.

Usage

Sets all the occurrences of a field in the input buffer as String.

Throws

NoSuchFieldError, ClassCastException

getOccurrenceCount

The getOccurrenceCount() method gets the number of occurrences of a field from the output buffer.

Synopsis

int getOccurrenceCount(String fieldName)

Parameters

fieldName
The name of the field.

Usage

Gets the number of occurrences of a field from the output buffer.

Returns

The number of occurrences.

Throws

NoSuchFieldError

clear

Synopsis

void clear()

Usage

This method clears the underlying input and output buffers.

callService

The callService() method invokes the remote service.

Synopsis

void callService()

Usage

Invokes the remote service.

Throws

ServiceException, TransactionException, ApplicationException

addJoltOutputListener

The addJoltOutputListener() method adds a JoltOutputEvent listener.

Synopsis

synchronized void addJoltOutputListener(JoltOutputListener listener)

Parameters

listener
The event listener to be added.

Usage

Adds a JoltOutputEvent listener.

removeJoltOutputListener

The removeJoltOutputListener() method removes a JoltOutputEvent listener.

Synopsis

synchronized void removeJoltOutputListener(JoltOutputListener listener)

Parameters

listener
The event listener to be removed.

Usage

Removes a JoltOutputEvent listener.

JoltSessionBean Class

java.lang.Object
|
+----bea.jolt.beans.JoltSessionBean

The JoltSessionBean represents the TUXEDO session. It includes the functionality of JoltSession, JoltSessionAttributes, and JoltTransaction classes. The JoltSessionBean offers properties to set session attributes and methods that open and close a TUXEDO session. It also sends a propertyChange event for the LoggedOn property when the TUXEDO session is established. In addition, the JoltSessionBean provides methods to control transactions. The JoltSessionBean is an event source for JoltOutputEvents. These events are sent if an unsolicited message or TUXEDO user event notification is sent.

JoltSessionBean Constructor

The JoltSessionBean constructor creates an instance of the JoltSessionBean.

JoltSessionBean

Synopsis

JoltSessionBean()

JoltSessionBean Methods

The following methods are used in conjunction with the JoltSessionBean class:

addJoltOutputListener

The addJoltOutputListener() method adds a JoltOutputEvent listener.

Synopsis

synchronized void addJoltOutputListener(JoltOutputListener listener)

Parameters

listener
Event listener to be added.

Usage

Adds a JoltOutputEvent listener.

removeJoltOutputListener

The removeJoltOutputListener() method removes a JoltOutputEvent listener.

Synopsis

synchronized void removeJoltOutputListener(JoltOutputListener listener)

Parameters

listener
Event listener to be removed.

Usage

Removes a JoltOutputEvent listener.

isLoggedOn

The isLoggedOn() method determines if the session exists.

Synopsis

boolean isLoggedOn()

Usage

Determines if the session exists.

Returns

True or false.

addPropertyChangeListener

The specified PropertyChangeListener's propertyChange() method is called each time the value of the LoggedOn property changes.

Synopsis

void addPropertyChangeListener(PropertyChangeListener l)

Parameters

l
The PropertyChangeListener.

Usage

The specified PropertyChangeListener's propertyChange() method is called each time the value of the loggedOn property changes.

removePropertyChangeListener

The removePropertyChangeListener() method removes the PropertyChangeListener from the internal list.

Synopsis

void removePropertyChangeListener(PropertyChangeListener l)

Parameters

l
The PropertyChangeListener.

Usage

Removes the PropertyChangeListener from the internal list.

logon

The logon() method opens a new session to TUXEDO.

Synopsis

void logon()

Usage

Opens a new session to TUXEDO. If a session is open, it throws a SessionException. Upon successful logon, the LoggedOn property value changes to true.

Throws

SessionException

logoff

The logoff() method closes the session to TUXEDO.

Synopsis

void logoff()

Usage

Closes the session to TUXEDO. Session attributes are not cleared after logoff. The LoggedOn property value changes to false.

Throws

SessionException

clear

The clear() method resets all session attributes.

Synopsis

void clear() 

Usage

Resets all session attributes.

Throws

SessionException

beginTransaction

The beginTransaction() method starts the transaction.

Synopsis

void beginTransaction(int timeout)

Parameters

timeout
Transaction timeout

Usage

Starts a transaction. If this method is called twice without commitTransaction or abortTransaction, a TransactionException is raised.

Throws

TransactionException

commitTransaction

The commitTransaction() method commits the transaction.

Synopsis

void commitTransaction()

Usage

Commits the transaction.

Throws

TransactionException

rollbackTransaction

The rollbackTransaction() method aborts the transaction.

Synopsis

void rollbackTransaction()

Usage

Aborts the transaction.

Throws

TransactionException

isInTransaction

The isInTransaction() method returns true or false depending on whether there is a started transaction.

Synopsis

boolean isInTransaction()

Returns

True if in a transaction, that is a transaction has started and not committed or aborted, and false otherwise.

getAppAddress

The getAppAddress() method gets the IP address (host name and port number) of the JSL or the Jolt Relay.

Synopsis

String getAppAddress()

Usage

Gets the IP address (host name and port number) of the JSL or the Jolt Relay.

Returns

The APPADDRESS.

setAppAddress

The setAppAddress() method sets the IP address (host name and port number) of the JSL or the Jolt Relay.

Synopsis

void setAppAddress(String value)

Parameters

value
The IP address (//host:port).

Usage

Sets the IP address (host name and port number) of the JSL or the Jolt Relay.

getIdleTimeOut

The getIdleTimeOut() method gets the IDLETIMEOUT attribute.

Synopsis

int getIdleTimeOut()

Usage

Gets the IDLETIMEOUT attribute.

Returns

Timeout value.

setIdleTimeOut

The setIdleTimeOut() method sets the IDLETIMEOUT attribute.

Synopsis

void setIdleTimeOut(int value)

Parameters

value
The new IDLETIMEOUT value.

Usage

Sets the IDLETIMEOUT attribute.

setReceiveTimeOut

The setReceiveTimeOut() method sets the RECVTIMEOUT attribute.

Synopsis

void setReceiveTimeOut(int value)

Parameters

value
The new RECVTIMEOUT value.

Usage

Sets the RECVTIMEOUT attribute.

getReceiveTimeOut

The getReceiveTimeOut() method gets the RECVTIMEOUT attribute.

Synopsis

int getReceiveTimeOut()

Usage

Gets the RECVTIMEOUT attribute.

Returns

Receive timeout value.

setSendTimeOut

The setSendTimeOut() method sets the SENDTIMEOUT attribute.

Synopsis

void setSendTimeOut(int value)

Parameters

value
The new SENDTIMEOUT value.

Usage

Sets the SENDTIMEOUT attribute.

getSendTimeOut

The getSendTimeOut() method gets the SENDTIMEOUT attribute.

Synopsis

int getSendTimeOut()

Usage

Gets the SENDTIMEOUT attribute.

Returns

Send timeout value.

getSessionTimeOut

The getSessionTimeOut() method gets the SESSIONTIMEOUT attribute.

Synopsis

String getSessionTimeOut()

Usage

Gets the SESSIONTIMEOUT attribute.

Returns

Session timeout value.

setUserName

The setUserName() method sets the TUXEDO user name to be used at logon.

Synopsis

void setUserName(String value)

Parameters

value
TUXEDO user name.

Usage

Sets the TUXEDO user name to be used at logon.

getUserName

The getUserName() method gets the TUXEDO user name to be used at logon.

Synopsis

String getUserName()

Usage

Gets the TUXEDO user name to be used at logon.

Returns

TUXEDO user name.

setUserRole

The setUserRole() method sets the TUXEDO user role to be used at logon.

Synopsis

void setUserRole(String value)

Parameters

value
TUXEDO user role.

Usage

Sets the TUXEDO user role to be used at logon.

getUserRole

The getUserRole() method gets the TUXEDO user role to be used at logon.

Synopsis

String getUserRole()

Usage

Gets the TUXEDO user role to be used at logon.

Returns

TUXEDO user role.

setUserPassword

The setUserPassword() method sets the TUXEDO user password to be used at logon.

Synopsis

void setUserPassword(String value)

Parameters

value
TUXEDO user password.

Usage

Sets the TUXEDO user password to be used at logon.

getUserPassword

The getUserPassword() method gets the TUXEDO user password to be used at logon.

Synopsis

String getUserPassword()

Usage

Gets the TUXEDO user password to be used at logon.

Returns

TUXEDO user password

setAppPassword

The setAppPassword() method sets the TUXEDO application password to be used at logon.

Synopsis

void setAppPassword(String value)

Parameters

value
TUXEDO application password.

Usage

Sets the TUXEDO application password to be used at logon.

getAppPassword

The getAppPassword() method gets the TUXEDO application password to be used at logon.

Synopsis

String getAppPassword()

Usage

Gets the TUXEDO application password to be used at logon.

Returns

TUXEDO application password.

JoltUserEventBean Class

java.lang.Object
|
+----bea.jolt.beans.JoltUserEventBean

The JoltUserEventBean provides access to TUXEDO events. The TUXEDO event to be subscribed to is defined by setting the appropriate parameters of this bean.

JoltUserEventBean Constructor

The JoltUserEventBean constructor creates an instance of the JoltUserEventBean which can be used to subscribe to a TUXEDO event.

JoltUserEventBean

This constructor subscribes to a specific TUXEDO event or notification.

Synopsis

JoltUserEventBean()

JoltUserEventBean Methods

The following methods are used in conjunction with the JoltUserEventBean class:

propertyChange

The propertyChange() method is the event handler for PropertyChange events.

Synopsis

void propertyChange(PropertyChangeEvent evt)

Parameters

evt
The event object.

Usage

Event handler for PropertyChange events. The JoltSessionBean notifies the JoltUserEventBean when it logs on and off by raising a PropertyChangeEvent about its LoggedOn property. The logoff of a session, other than the current session, does not affect the JoltUserEventBean. This method should not be called directly.

setEventName

The setEventName() method sets the regular expression of the user event that this bean represents.

Synopsis

void setEventName(String name)

Parameters

name
The regular expression of the user event.

Usage

Sets the regular expression of the user event that this bean represents. If the client wants to only subscribe to unsolicited events, use setEventName ("\\.UNSOLMSG").

getEventName

The getEventName() method gets the regular expression this bean represents.

Synopsis

String getEventName()

Usage

Gets the regular expression this bean represents.

setFilter

The setFilter() method sets the event filter.

Synopsis

void setFilter(String filter)

Parameters

filter
The event filter.

Usage

Sets the event filter.

getFilter

The getFilter() method gets the event filter.

Synopsis

String getFilter()

Usage

Gets the event filter.

Returns

Regular expression

setSession

The setSession() method is used when the JoltUserEventBean is created after the logon event.

Synopsis

void setSession(JoltSessionBean value)

Parameters

value
JoltSessionBean

Usage

This method is used in cases when the JoltUserEventBean is created after the logon event. Otherwise, the JoltUserEventBean can get access to a TUXEDO client session by listening to propertyChangeEvents.

getSession

The getSession() method gets the JoltSessionBean used by this JoltUserEventBean.

Synopsis

JoltSessionBean getSession()

Usage

Gets the JoltSessionBean used by this JoltUserEventBean.

Returns

JoltSessionBean

unsubscribe

The unsubscribe() method deletes the subscription to an event.

Synopsis

void unsubscribe()

Usage

This method is used to stop subcribing to the event represented by the JoltUserEventBean.

Throws

EventException, SessionException, JoltException

subscribe

The subscribe() method activates the subscription to an event.

Synopsis

void subscribe() 

Usage

Activates the subscription to an event.

Throws

EventException, SessionException, JoltException