All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class bea.jolt.beans.JoltSessionBean

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

public class JoltSessionBean
extends Object
implements Serializable

The JoltSessionBean represents the TUXEDO session. It encapsulates the functionality of JoltSession, JoltSessionAttributes and JoltTransaction. The JoltSessionBean offers properties to set session attributes and methods to open and to close a TUXEDO session. It also sends a PropertyChange event for its "LoggedOn" property once the TUXEDO session is established. In addition, the JoltSessionBean provides methods to control transactions. The JoltSessionBean is an event source for JoltOutputEvents as well. These events are sent if an unsolicited message or TUXEDO user event notification arrives.

JoltSessionBean()

addJoltOutputListener(JoltOutputListener): Add a JoltOutputEvent listener.
addPropertyChangeListener(PropertyChangeListener): The specified PropertyChangeListener's propertyChange method is called each time the value of the loggedOn property is changed.
beginTransaction(int): Start a transaction.
clear(): This method clears all session attributes.
commitTransaction(): Commits the transaction.
getAppAddress(): Gets the IP address (host name) and port number of the JSL or the Jolt Relay.
getAppPassword(): Gets the TUXEDO application password to be used at logon.
getIdleTimeOut(): Gets the IDLETIMEOUT attribute.
getPropertyChangeEvent(): Constructor
getReceiveTimeOut(): Gets the RECVTIMEOUT attribute.
getSendTimeOut(): Gets the SENDTIMEOUT attribute.
getSessionTimeOut(): Gets the SESSIONTIMEOUT attribute.
getUserName(): Gets the TUXEDO user name to be used at logon.
getUserPassword(): Gets the TUXEDO user password to be used at logon.
getUserRole(): Gets the TUXEDO user role to be used at logon.
isInTransaction(): Returns true or false depending on whether there is a started transaction.
isLoggedOn(): Does the session exist?
logoff(): This method closes the session to TUXEDO.
logon(): This method opens a new session to TUXEDO.
removeJoltOutputListener(JoltOutputListener): Remove a JoltOutputEvent listener.
removePropertyChangeListener(PropertyChangeListener): Remove this PropertyChangeListener from the internal list.
rollbackTransaction(): Aborts the transaction.
setAppAddress(String): Sets the IP address (host name) and port number of the JSL or the Jolt Relay.
setAppPassword(String): Sets the TUXEDO application password to be used at logon.
setIdleTimeOut(int): Sets the IDLETIMEOUT attribute.
setReceiveTimeOut(int): Sets the RECVTIMEOUT attribute.
setSendTimeOut(int): Sets the SENDTIMEOUT attribute.
setUserName(String): Sets the TUXEDO user name to be used at logon.
setUserPassword(String): Sets the TUXEDO user password to be used at logon.
setUserRole(String): Sets the TUXEDO user role to be used at logon.

JoltSessionBean

 public JoltSessionBean()

getPropertyChangeEvent

 public PropertyChangeEvent getPropertyChangeEvent()

Constructor

addJoltOutputListener

 public synchronized void addJoltOutputListener(JoltOutputListener listener)

Add a JoltOutputEvent listener.

Parameters:: listener - Event listener to be added.

removeJoltOutputListener

 public synchronized void removeJoltOutputListener(JoltOutputListener listener)

Remove a JoltOutputEvent listener.

Parameters:: listener - Event listener to be removed.

isLoggedOn

 public boolean isLoggedOn()

Does the session exist?

Returns:: true or false.

addPropertyChangeListener

 public void addPropertyChangeListener(PropertyChangeListener l)

The specified PropertyChangeListener's propertyChange method is called each time the value of the loggedOn property is changed. The PropertyListener object is addded to a list of PropertyChangeListeners managed by this bean, it can be removed with removePropertyChangeListener. Note: the JavaBeans specification does not require PropertyChangeListeners to run in any particular order.

Parameters:: l - The PropertyChangeListener.

removePropertyChangeListener

 public void removePropertyChangeListener(PropertyChangeListener l)

Remove this PropertyChangeListener from the internal list. If the PropertyChangeListener isn't on the list, do nothing.

Parameters:: l - The PropertyChangeListener.

logon

 public void logon() throws SessionException

This method opens a new session to TUXEDO. If a session is already open it throws a SessionException. Upon successful logon the LoggedOn property is changed to true.

logoff

 public void logoff() throws SessionException

This method closes the session to TUXEDO. Session attributes are not cleared after logoff. The LoggedOn property is changed to false.

clear

 public void clear() throws SessionException

This method clears all session attributes.

beginTransaction

 public void beginTransaction(int timeout) throws TransactionException

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

Parameters:: timeout - Transaction timeout.

commitTransaction

 public void commitTransaction() throws TransactionException

Commits the transaction.

rollbackTransaction

 public void rollbackTransaction() throws TransactionException

Aborts the transaction.

isInTransaction

 public boolean isInTransaction()

Returns true or false depending on whether there is a started transaction.

Returns:: True if in transaction, false otherwise.

getAppAddress

 public String getAppAddress()

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

Returns:: The APPADDRESS.

setAppAddress

 public void setAppAddress(String value)

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

Parameters:: value - The address of the application (APPADDRESS) attribute.

getIdleTimeOut

 public int getIdleTimeOut()

Gets the IDLETIMEOUT attribute.

Returns:: Timeout value.

setIdleTimeOut

 public void setIdleTimeOut(int value)

Sets the IDLETIMEOUT attribute.

Parameters:: value - The new IDLETIMEOUT attribute value.

setReceiveTimeOut

 public void setReceiveTimeOut(int value)

Sets the RECVTIMEOUT attribute.

Parameters:: value - The new RECVTIMEOUT attribute value.

getReceiveTimeOut

 public int getReceiveTimeOut()

Gets the RECVTIMEOUT attribute.

Returns:: Receive timeout value.

setSendTimeOut

 public void setSendTimeOut(int value)

Sets the SENDTIMEOUT attribute.

Parameters:: value - The new SENDTIMEOUT attribute value.

getSendTimeOut

 public int getSendTimeOut()

Gets the SENDTIMEOUT attribute.

Returns:: Send timeout value.

getSessionTimeOut

 public String getSessionTimeOut()

Gets the SESSIONTIMEOUT attribute.

Returns:: Session timeout value.

setUserName

 public void setUserName(String value)

Sets the TUXEDO user name to be used at logon.

Parameters:: value - TUXEDO user name.

getUserName

 public String getUserName()

Gets the TUXEDO user name to be used at logon.

Returns:: TUXEDO user name.

setUserRole

 public void setUserRole(String value)

Sets the TUXEDO user role to be used at logon.

Parameters:: value - TUXEDO user role.

getUserRole

 public String getUserRole()

Gets the TUXEDO user role to be used at logon.

Returns:: TUXEDO user role.

setUserPassword

 public void setUserPassword(String value)

Sets the TUXEDO user password to be used at logon.

Parameters:: value - TUXEDO user password.

getUserPassword

 public String getUserPassword()

Gets the TUXEDO user password to be used at logon.

Returns:: TUXEDO user password.

setAppPassword

 public void setAppPassword(String value)

Sets the TUXEDO application password to be used at logon.

Parameters:: value - TUXEDO application password.

getAppPassword

 public String getAppPassword()

Gets the TUXEDO application password to be used at logon.

Returns:: TUXEDO application password.

All Packages  Class Hierarchy  This Package  Previous  Next  Index