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 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.
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 Class
java.lang.Object
|
+----java.util.EventObject
|
+----bea.jolt.beans.JoltInputEvent JoltInputEvent Constructors
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
(Objectsource
, StringfieldName
, Objectvalue
)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.
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
(Objectsource
, StringfieldName
, Objectvalue
, intpos
)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.
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
(Objectsource
, StringfieldName
, Objectvalues
[])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.
This constructor is used when the input is a single data element and it is represented as a String.
Synopsis
JoltInputEvent
(Objectsource
, StringfieldName
, StringtextValue
)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.
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
(Objectsource
, StringfieldName
, StringtextValue
, intpos
)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.
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
(Objectsource
, StringfieldName
, StringtextValues
[])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:
The
getValue()
method gets the value of the field in its native representation.Synopsis
ObjectgetValue
()Usage
Get the value in its native representation.
Returns
Value of the field.
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.
The
getTextValue()
method gets the value as a String.Synopsis
StringgetTextValue
()Usage
Get the value as a String.
Returns
The value of the field as a String.
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
The
getFieldName()
method gets the name of the field.Synopsis
StringgetFieldName
()Usage
Get the name of the field.
Returns
The name of the field
The
getOccurrenceCount()
method gets the number of occurrences of a named item.Synopsis
intgetOccurrenceCount
()Usage
Get the number of occurrences of the field.
Returns
The number of occurrences.
The
getSingleOccurrence()
method gets the position of the field.Synopsis
intgetSingleOccurrence
()Usage
Get the position of the field. These are:
- 0 for single data elements
- i for elements with multiple occurrences of which only one was set
The
isText()
method returns true if the field type is String, otherwise it returns false.Synopsis
booleanisText
()Retuns
True if the field type is String, otherwise it returns false.
The
isVector()
method retuns true if the field has multiple occurrences, otherwise it returns false.Synopsis
booleanisVector
()Retuns
True if the field has multiple occurrences, otherwise it returns false.
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.
The following methods are used in conjunction with the JoltOutputEvent class:
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
booleanisEventMessage
()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.
The
getValue()
method gets the value of a field in the output buffer.Synopsis
ObjectgetValue
(StringfieldName
)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.
The
getValue()
method gets the value of one occurrence of a field in the output buffer.Synopsis
ObjectgetValue
(StringfieldName
, intindex
)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
The
getValues()
method gets all occurrences of a field in the output buffer.Synopsis
Object[]getValues
(StringfieldName
)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.
The
getTextValue()
method gets the value of a field in the output buffer as String.Synopsis
StringgetTextValue
(StringfieldName
)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.
The
getTextValue()
method gets the value of one occurrence of a field in the output buffer.Synopsis
StringgetTextValue
(StringfieldName
,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.
The
getTextValues()
method gets all occurrences of a field in the JoltOutput message buffer.Synopsis
String[]getTextValues
(StringfieldName
)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.
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.
The JoltServiceBean constructor creates a bean representing a Jolt service.
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
- getOutputValue - value of field
- getOutputValue - value of one occurrence of field
- getOutputTextValue - value of field
- getOutputTextValue - value of one occurrence of field
- setInputValue - value of field
- setInputValue - value of one occurrence of field
- setInputTextValue - value of field
The
propertyChange()
method is the event handler for PropertyChange events.Synopsis
voidpropertyChange
(PropertyChangeEventevt
)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.
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
voiddataChanged
(JoltInputEventevt
)Parameters
evt
- The event object.
Usage
Event handler for JoltInputEvents. This method should not be called directly.
The
setServiceName()
method sets the name of the remote service that this bean represents.Synopsis
voidsetServiceName
(Stringname
)Parameters
name
- Service name
Usage
Sets the name of the remote service that this bean represents.
The
getServiceName()
method gets the name of the remote service that this bean represents.Synopsis
StringgetServiceName
()Usage
Gets the name of the remote service that this bean represents.
Returns
The name of the TUXEDO service.
The
isTransactional()
method returns true if the bean is in transactional mode, otherwise it returns false.Synopsis
booleanisTransactional
()Usage
Set to true if this JoltServiceBean is to be included in the transaction that was started by its JoltSessionBean.
Returns
True or false.
The
setTransactional()
method sets the transactional mode of the bean.Synopsis
voidsetTransactional
(booleanmode
)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.
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
voidsetSession
(JoltSessionBeanvalue
)Parameters
value
- The JoltSessionBean that is used by this service bean
Usage
Sets the JoltSessionBean associated with this JoltServiceBean.
The
getSession()
method gets the JoltSessionBean used by this JoltServiceBean.Synopsis
JoltSessionBeangetSession
()Usage
Gets the JoltSessionBean used by this JoltServiceBean.
Returns
JoltSessionBean
The
getOutputValue()
method gets the value of a field in the output buffer using the field's native type.Synopsis
ObjectgetOutputValue
(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
The
getOutputValue()
method gets the value of one occurrence of a field in the output buffer using the field's native type.Synopsis
ObjectgetOutputValue
(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
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
The
getOutputTextValue()
method gets the value of a field in the output buffer as a String.Synopsis
StringgetOutputTextValue
(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
The
getOutputTextValue()
method gets the value of one occurrence of a field in the output buffer as a String.Synopsis
StringgetOutputTextValue
(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
The
getOutputTextValues()
method gets all the occurrences of a field in the output buffer as String.Synopsis
String[]getOutputTextValues
(StringfieldName
)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
The
setInputValue()
method sets the value of a field in the input buffer using the field's native type.Synopsis
voidsetInputValue
(StringfieldName
, Objectvalue
)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
The
setInputValue()
method sets the value of one occurrence of a field in the input buffer using the field's native type.Synopsis
voidsetInputValue
(StringfieldName
, intindex
, Objectvalue
)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
The
setInputValues()
method sets all the occurrences of a field in the input buffer using the field's native type.Synopsis
voidsetInputValues
(StringfieldName
, Objectvalues
[])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
The
setInputTextValue()
method sets the value of a field in the input buffer as a String.Synopsis
voidsetInputTextValue
(StringfieldName
, StringtextValue
)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
The
setInputTextValue()
method sets the value of one occurrence of a field in the input buffer as a String.Synopsis
voidsetInputTextValue
(StringfieldName
, int index, StringtextValue
)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
The
setInputTextValues()
method sets all the occurrences of a field in the input buffer as String.Synopsis
voidsetInputTextValues
(StringfieldName
, StringtextValues
[])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
The
getOccurrenceCount()
method gets the number of occurrences of a field from the output buffer.Synopsis
intgetOccurrenceCount
(StringfieldName
)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
Synopsis
void clear()Usage
This method clears the underlying input and output buffers.
The
callService()
method invokes the remote service.Synopsis
voidcallService
()Usage
Invokes the remote service.
Throws
ServiceException, TransactionException, ApplicationException
The
addJoltOutputListener()
method adds a JoltOutputEvent listener.Synopsis
synchronized voidaddJoltOutputListener
(JoltOutputListenerlistener
)Parameters
listener
- The event listener to be added.
Usage
Adds a JoltOutputEvent listener.
The
removeJoltOutputListener()
method removes a JoltOutputEvent listener.Synopsis
synchronized voidremoveJoltOutputListener
(JoltOutputListenerlistener
)Parameters
listener
- The event listener to be removed.
Usage
Removes a JoltOutputEvent listener.
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.
The JoltSessionBean
constructor creates an instance of the JoltSessionBean.
Synopsis
JoltSessionBean()JoltSessionBean Methods
The following methods are used in conjunction with the JoltSessionBean class:
The
addJoltOutputListener()
method adds a JoltOutputEvent listener.Synopsis
synchronized voidaddJoltOutputListener
(JoltOutputListenerlistener
)Parameters
listener
- Event listener to be added.
Usage
Adds a JoltOutputEvent listener.
The
removeJoltOutputListener()
method removes a JoltOutputEvent listener.Synopsis
synchronized voidremoveJoltOutputListener
(JoltOutputListenerlistener
)Parameters
listener
- Event listener to be removed.
Usage
Removes a JoltOutputEvent listener.
The
isLoggedOn()
method determines if the session exists.Synopsis
booleanisLoggedOn
()Usage
Determines if the session exists.
Returns
True or false.
The specified PropertyChangeListener's
propertyChange()
method is called each time the value of the LoggedOn property changes.Synopsis
voidaddPropertyChangeListener
(PropertyChangeListenerl
)Parameters
l
- The PropertyChangeListener.
Usage
The specified PropertyChangeListener's
propertyChange()
method is called each time the value of the loggedOn property changes.
The
removePropertyChangeListener()
method removes the PropertyChangeListener from the internal list.Synopsis
voidremovePropertyChangeListener
(PropertyChangeListenerl
)Parameters
l
- The PropertyChangeListener.
Usage
Removes the PropertyChangeListener from the internal list.
The
logon()
method opens a new session to TUXEDO.Synopsis
voidlogon
()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
The
logoff()
method closes the session to TUXEDO.Synopsis
voidlogoff
()Usage
Closes the session to TUXEDO. Session attributes are not cleared after logoff. The LoggedOn property value changes to false.
Throws
SessionException
The
clear()
method resets all session attributes.Synopsis
voidclear
()Usage
Resets all session attributes.
Throws
SessionException
The
beginTransaction()
method starts the transaction.Synopsis
voidbeginTransaction
(inttimeout
)Parameters
timeout
- Transaction timeout
Usage
Starts a transaction. If this method is called twice without commitTransaction or abortTransaction, a TransactionException is raised.
Throws
TransactionException
The
commitTransaction()
method commits the transaction.Synopsis
voidcommitTransaction
()Usage
Commits the transaction.
Throws
TransactionException
The
rollbackTransaction()
method aborts the transaction.Synopsis
voidrollbackTransaction
()Usage
Aborts the transaction.
Throws
TransactionException
The
isInTransaction()
method returns true or false depending on whether there is a started transaction.Synopsis
booleanisInTransaction
()Returns
True if in a transaction, that is a transaction has started and not committed or aborted, and false otherwise.
The
getAppAddress()
method gets the IP address (host name and port number) of the JSL or the Jolt Relay.Synopsis
StringgetAppAddress
()Usage
Gets the IP address (host name and port number) of the JSL or the Jolt Relay.
Returns
The APPADDRESS.
The
setAppAddress()
method sets the IP address (host name and port number) of the JSL or the Jolt Relay.Synopsis
voidsetAppAddress
(Stringvalue
)Parameters
value
- The IP address (
//host:port
).Usage
Sets the IP address (host name and port number) of the JSL or the Jolt Relay.
The
getIdleTimeOut()
method gets the IDLETIMEOUT attribute.Synopsis
intgetIdleTimeOut
()Usage
Gets the IDLETIMEOUT attribute.
Returns
Timeout value.
The
setIdleTimeOut()
method sets the IDLETIMEOUT attribute.Synopsis
voidsetIdleTimeOut
(intvalue
)Parameters
value
- The new IDLETIMEOUT value.
Usage
Sets the IDLETIMEOUT attribute.
The
setReceiveTimeOut()
method sets the RECVTIMEOUT attribute.Synopsis
voidsetReceiveTimeOut
(intvalue
)Parameters
value
- The new RECVTIMEOUT value.
Usage
Sets the RECVTIMEOUT attribute.
The
getReceiveTimeOut()
method gets the RECVTIMEOUT attribute.Synopsis
intgetReceiveTimeOut
()Usage
Gets the RECVTIMEOUT attribute.
Returns
Receive timeout value.
The
setSendTimeOut()
method sets the SENDTIMEOUT attribute.Synopsis
voidsetSendTimeOut
(intvalue
)Parameters
value
- The new SENDTIMEOUT value.
Usage
Sets the SENDTIMEOUT attribute.
The
getSendTimeOut()
method gets the SENDTIMEOUT attribute.Synopsis
intgetSendTimeOut
()Usage
Gets the SENDTIMEOUT attribute.
Returns
Send timeout value.
The
getSessionTimeOut()
method gets the SESSIONTIMEOUT attribute.Synopsis
StringgetSessionTimeOut
()Usage
Gets the SESSIONTIMEOUT attribute.
Returns
Session timeout value.
The
setUserName()
method sets the TUXEDO user name to be used at logon.Synopsis
voidsetUserName
(Stringvalue
)Parameters
value
- TUXEDO user name.
Usage
Sets the TUXEDO user name to be used at logon.
The
getUserName()
method gets the TUXEDO user name to be used at logon.Synopsis
StringgetUserName
()Usage
Gets the TUXEDO user name to be used at logon.
Returns
TUXEDO user name.
The
setUserRole()
method sets the TUXEDO user role to be used at logon.Synopsis
voidsetUserRole
(Stringvalue
)Parameters
value
- TUXEDO user role.
Usage
Sets the TUXEDO user role to be used at logon.
The
getUserRole()
method gets the TUXEDO user role to be used at logon.Synopsis
StringgetUserRole
()Usage
Gets the TUXEDO user role to be used at logon.
Returns
TUXEDO user role.
The
setUserPassword()
method sets the TUXEDO user password to be used at logon.Synopsis
voidsetUserPassword
(Stringvalue
)Parameters
value
- TUXEDO user password.
Usage
Sets the TUXEDO user password to be used at logon.
The
getUserPassword()
method gets the TUXEDO user password to be used at logon.Synopsis
StringgetUserPassword
()Usage
Gets the TUXEDO user password to be used at logon.
Returns
TUXEDO user password
The
setAppPassword()
method sets the TUXEDO application password to be used at logon.Synopsis
voidsetAppPassword
(Stringvalue
)Parameters
value
- TUXEDO application password.
Usage
Sets the TUXEDO application password to be used at logon.
The
getAppPassword()
method gets the TUXEDO application password to be used at logon.Synopsis
StringgetAppPassword
()Usage
Gets the TUXEDO application password to be used at logon.
Returns
TUXEDO application password.
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.
The JoltUserEventBean constructor creates an instance of the JoltUserEventBean which can be used to subscribe to a TUXEDO event.
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:
The
propertyChange()
method is the event handler for PropertyChange events.Synopsis
voidpropertyChange
(PropertyChangeEventevt
)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.
The
setEventName()
method sets the regular expression of the user event that this bean represents.Synopsis
voidsetEventName
(Stringname
)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"
).
The
getEventName()
method gets the regular expression this bean represents.Synopsis
StringgetEventName
()Usage
Gets the regular expression this bean represents.
The
setFilter()
method sets the event filter.Synopsis
void
setFilter
(Stringfilter
)Parameters
filter
- The event filter.
Usage
Sets the event filter.
The
getFilter()
method gets the event filter.Synopsis
StringgetFilter
()Usage
Gets the event filter.
Returns
Regular expression
The
setSession()
method is used when the JoltUserEventBean is created after the logon event.Synopsis
voidsetSession
(JoltSessionBeanvalue
)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.
The
getSession()
method gets the JoltSessionBean used by this JoltUserEventBean.Synopsis
JoltSessionBeangetSession
()Usage
Gets the JoltSessionBean used by this JoltUserEventBean.
Returns
JoltSessionBean
The
unsubscribe()
method deletes the subscription to an event.Synopsis
voidunsubscribe
()Usage
This method is used to stop subcribing to the event represented by the JoltUserEventBean.
Throws
EventException
,SessionException
,JoltException
The
subscribe()
method activates the subscription to an event.Synopsis
voidsubscribe
()Usage
Activates the subscription to an event.
Throws
EventException
,SessionException
,JoltException