All Packages Class Hierarchy This Package Previous Next Index
Class bea.jolt.JoltSessionAttributes
java.lang.Object
|
+----bea.jolt.JoltSessionAttributes
- public class JoltSessionAttributes
- extends Object
The JoltSessionAttributes class defines the set of attributes that the
JoltSession constructor accepts. The set and get (for example, setByte,
setInt, getByte, getInt) methods set and get various attributes. A set
method adds an attribute if it does not exist; otherwise, the set method
overwrites the old value. The set and get methods throw the
java.lang.NoSuchFieldError or java.lang.IllegalAccessError. By default,
these errors are caught by the Java virtual machine.
- See Also:
- JoltSession
-
ANY
- The connection mode of ANY is equivalent to either RECONNECT
or RETAINED.
-
APPADDRESS
- Attribute name, used with setString(), for application addresses
in "//host:port" string format.
-
APPASSWORD
- Authentication level: System authentication is required.
-
AUTHLEVEL
- Attribute name for authentication level.
-
CLIENT_VERSION
- Current Jolt class library version.
-
CONNECTIONMODE
- Attribute name for connection mode allowed by the Jolt Server.
-
IDLETIMEOUT
- Attribute name for network idle timeout (in seconds),
used with setInt().
-
JOLTVERSION
- Attribute name for Jolt server version.
-
NOAUTH
- Authentication level: No authentication is required to access
the system.
-
RECONNECT
- The connection mode of RECONNECT means the client establishes
a transient connection, brings it down when an idle timeout
is reached, and reconnects for new requests within a session.
-
RECVTIMEOUT
- Attribute name for network receive timeout (in seconds)),
used with setInt().
-
RETAINED
- The connection mode of RETAINED means a client must maintain a
network connection with the Jolt Server throughout the session.
-
SENDTIMEOUT
- Attribute name for network send timeout (in seconds)),
used with setInt().
-
SESSIONTIMEOUT
- Attribute name for Jolt Server session timeout in seconds
(-T option in JSL).
-
TUXVERSION
- Attribute name for TUXEDO version.
Deprecated.
-
USRPASSWORD
- Authentication level: System authentication is required.
-
VERSION
- Current Jolt class library version in string format.
-
JoltSessionAttributes()
- The constructor resets all the attributes to their initial
values.
-
checkAuthenticationLevel()
- Determine the authentication level set up by the administrator.
-
clear()
- This method clears all the attributes and resets the send
timeout and receive timeout to their default values.
-
getByteDef(String, byte)
- Get the byte (8-bit) value of an attribute.
-
getBytesDef(String, byte[])
- Get the byte-array value of the first item specified for an
attribute.
-
getDoubleDef(String, double)
- Get the double precision (64-bit) value of an attribute.
-
getFloatDef(String, float)
- Get the floating point (32-bit) value of an attribute.
-
getIntDef(String, int)
- Get the integer (32-bit) value of an attribute.
-
getKeys()
- Enumerate the attribute names.
-
getShortDef(String, short)
- Get the short integer (16-bit) value of an attribute.
-
getStringDef(String, String)
- Get the string value of an attribute.
-
setByte(String, byte)
- Set the value of the attribute named in the key parameter
to the byte (8-bit) value specified in the value parameter.
-
setBytes(String, byte[], int)
- Set the value of the attribute named in the key parameter
to the byte-array value specified in the value parameter.
-
setDouble(String, double)
- Set the value of the attribute named in the key parameter
to the double precision (64-bit) value specified in the value
parameter.
-
setFloat(String, float)
- Set the value of the attribute named in the key parameter
to the floating point (32-bit) value specified in the value
parameter.
-
setInt(String, int)
- Set the value of the attribute named in the key parameter
to the integer (16-bit) value specified in the value parameter.
-
setShort(String, short)
- Set the value of the attribute named in the key parameter
to the short integer (16-bit) value specified in the value
parameter.
-
setString(String, String)
- Set the value of the attribute named in the key parameter
to the string value specified in the value parameter.
NOAUTH
public static final int NOAUTH
- Authentication level: No authentication is required to access
the system.
APPASSWORD
public static final int APPASSWORD
- Authentication level: System authentication is required.
Clients must provide a user name, a user role, and an
application password to access the system.
USRPASSWORD
public static final int USRPASSWORD
- Authentication level: System authentication is required.
Clients must provide a user password in addition to the
user name, user role, and application password to access
the system.
APPADDRESS
public static final String APPADDRESS
- Attribute name, used with setString(), for application addresses
in "//host:port" string format. If multiple addresses are specified,
the addresses must be separated by commas. The host can be a
machine name or Internet Address (x.x.x.x). The port must be a
numeric value between 1 and 65535.
- See Also:
- setString, getStringDef
IDLETIMEOUT
public static final String IDLETIMEOUT
- Attribute name for network idle timeout (in seconds),
used with setInt(). If 0 is specified, the Jolt client
attempts to connect the Jolt Server Handler in
RETAINED mode. If > 0 is specified, the Jolt client attempts
to connect JSH in RECONNECT mode.
- See Also:
- setInt, getIntDef
SENDTIMEOUT
public static final String SENDTIMEOUT
- Attribute name for network send timeout (in seconds)),
used with setInt(). If the data
cannot be sent to the network within this amount of time, an
exception is generated.
- See Also:
- setInt, getIntDef
RECVTIMEOUT
public static final String RECVTIMEOUT
- Attribute name for network receive timeout (in seconds)),
used with setInt(). If the
expected network data is not received within this amount of time,
an exception is generated.
- See Also:
- setInt, getIntDef
JOLTVERSION
public static final String JOLTVERSION
- Attribute name for Jolt server version. Current version is 2000.
- See Also:
- getIntDef
TUXVERSION
public static final String TUXVERSION
- Note: TUXVERSION is deprecated.
- Attribute name for TUXEDO version. Current supported versions are
6400 (TUXEDO 6.4) and 6500 (TUXEDO 6.5).
- See Also:
- getIntDef
AUTHLEVEL
public static final String AUTHLEVEL
- Attribute name for authentication level. Permitted values:
NOAUTH, APPASSWORD, or USRPASSWORD.
- See Also:
- getIntDef
SESSIONTIMEOUT
public static final String SESSIONTIMEOUT
- Attribute name for Jolt Server session timeout in seconds
(-T option in JSL).
- See Also:
- getIntDef
CONNECTIONMODE
public static final String CONNECTIONMODE
- Attribute name for connection mode allowed by the Jolt Server.
See the -c option of JSL, as described in the BEA Jolt 1.2
Installation and Configuration Guide. Possible values for this
attribute are:
ANY, RECONNECT, or RETAINED.
- See Also:
- getIntDef
ANY
public static final int ANY
- The connection mode of ANY is equivalent to either RECONNECT
or RETAINED.
RETAINED
public static final int RETAINED
- The connection mode of RETAINED means a client must maintain a
network connection with the Jolt Server throughout the session.
RECONNECT
public static final int RECONNECT
- The connection mode of RECONNECT means the client establishes
a transient connection, brings it down when an idle timeout
is reached, and reconnects for new requests within a session.
CLIENT_VERSION
public static final int CLIENT_VERSION
- Current Jolt class library version.
VERSION
public static final String VERSION
- Current Jolt class library version in string format. The
string is suitable for display.
JoltSessionAttributes
public JoltSessionAttributes()
- The constructor resets all the attributes to their initial
values. It sets the default send timeout to 10 seconds, and
the receive timeout to 2 minutes.
clear
public void clear()
- This method clears all the attributes and resets the send
timeout and receive timeout to their default values.
getByteDef
public byte getByteDef(String key,
byte defaultValue)
- Get the byte (8-bit) value of an attribute. If the attribute
does not exist, the default value is returned.
- Parameters:
- key - The attribute name.
- defaultValue - The default value to be returned.
- Returns:
- The byte value.
getShortDef
public short getShortDef(String key,
short defaultValue)
- Get the short integer (16-bit) value of an attribute.
If the attribute
does not exist, the default value is returned.
- Parameters:
- key - The attribute name.
- defaultValue - The default value to be returned.
- Returns:
- The short value.
getIntDef
public int getIntDef(String key,
int defaultValue)
- Get the integer (32-bit) value of an attribute. If the
attribute does not exist, the default value is returned.
- Parameters:
- key - The attribute name.
- defaultValue - The default value to be returned.
- Returns:
- The int value.
getFloatDef
public float getFloatDef(String key,
float defaultValue)
- Get the floating point (32-bit) value of an attribute.
If the attribute
does not exist, the default value is returned.
- Parameters:
- key - The attribute name.
- defaultValue - The default value to be returned.
- Returns:
- The float value.
getDoubleDef
public double getDoubleDef(String key,
double defaultValue)
- Get the double precision (64-bit) value of an attribute.
If the attribute
does not exist, the default value is returned.
- Parameters:
- key - The attribute name.
- defaultValue - The default value to be returned.
- Returns:
- The double value.
getStringDef
public String getStringDef(String key,
String defaultValue)
- Get the string value of an attribute. If the attribute
does not exist, the default value is returned.
- Parameters:
- key - The attribute name.
- defaultValue - The default value to be returned.
- Returns:
- The string value.
getBytesDef
public byte[] getBytesDef(String key,
byte defaultValue[])
- Get the byte-array value of the first item specified for an
attribute. If the attribute
does not exist, the default value is returned.
- Parameters:
- key - The attribute name.
- defaultValue - The default value to be returned.
- Returns:
- The byte-array value.
setByte
public void setByte(String key,
byte value)
- Set the value of the attribute named in the key parameter
to the byte (8-bit) value specified in the value parameter.
If the attribute already exists, it is overwritten.
- Parameters:
- key - The attribute name.
- value - The byte value.
- Throws: IllegalAccessError
- This attribute is not settable.
setShort
public void setShort(String key,
short value)
- Set the value of the attribute named in the key parameter
to the short integer (16-bit) value specified in the value
parameter. If the attribute already exists, it is overwritten.
- Parameters:
- key - The attribute name.
- value - The short value.
- Throws: IllegalAccessError
- This attribute is not settable.
setInt
public void setInt(String key,
int value)
- Set the value of the attribute named in the key parameter
to the integer (16-bit) value specified in the value parameter.
If the attribute already exists, it is overwritten.
- Parameters:
- key - The attribute name.
- value - The int value
- Throws: IllegalAccessError
- This attribute is not settable.
setFloat
public void setFloat(String key,
float value)
- Set the value of the attribute named in the key parameter
to the floating point (32-bit) value specified in the value
parameter.
If the attribute already exists, it is overwritten.
- Parameters:
- key - The attribute name.
- value - The float value.
- Throws: IllegalAccessError
- This attribute is not settable.
setDouble
public void setDouble(String key,
double value)
- Set the value of the attribute named in the key parameter
to the double precision (64-bit) value specified in the value
parameter.
If the attribute already exists, it is overwritten.
- Parameters:
- key - The attribute name.
- value - The double value.
- Throws: IllegalAccessError
- This attribute is not settable.
setString
public void setString(String key,
String value)
- Set the value of the attribute named in the key parameter
to the string value specified in the value parameter.
If the attribute already exists, it is overwritten.
- Parameters:
- key - the attribute name.
- value - the string value.
- Throws: IllegalAccessError
- This attribute is not settable.
setBytes
public void setBytes(String key,
byte value[],
int len)
- Set the value of the attribute named in the key parameter
to the byte-array value specified in the value parameter.
If the attribute already exists, it is overwritten.
- Parameters:
- key - The attribute name.
- value - The byte-array value.
- len - The length of byte-array.
- Throws: IllegalAccessError
- This attribute is not settable.
getKeys
public Enumeration getKeys()
- Enumerate the attribute names.
- Returns:
- The enumeration of attribute names.
checkAuthenticationLevel
public int checkAuthenticationLevel() throws SessionException
- Determine the authentication level set up by the administrator.
- Returns:
- NOAUTH, APPASSWORD or USRPASSWORD.
- Throws: SessionException
- The APPADDRESS is not specified or it
contains an invalid host and port.
All Packages Class Hierarchy This Package Previous Next Index