asjava.uniobjects
Class UniSession

java.lang.Object
  asjava.uniclientlibs.UniConnection
      asjava.uniobjects.UniSession

All Implemented Interfaces:

java.lang.Cloneable

public class UniSession

extends UniConnection

implements java.lang.Cloneable

UniSession acts as the central object for any database connection, controlling access to any and all child objects. It controls information regarding the connection. It is from this object that the various sub-objects are created, such as the UniSelectList, UniFile, UniSubroutine and other objects. Multiple sessions can be created, up to UniJava.getMaxSessions

Since:

UNIOBJECTS 1.0

Version:

Version 1.0

Author:

David T. Meeks

Field Summary

protected java.lang.String[]	atVariableArray
protected UniCommand	uniCommand
protected UniNLSlocale	uniNLSLocale
protected UniNLSmap	uniNLSMap
protected UniTransaction	uniTransaction

Fields inherited from class asjava.uniclientlibs.UniConnection

accountPath, compressionThreshold, connection, encryptionType, hostName, hostPort, hostType, inPacket, isActive, isNLSEnabled, isNLSLocalesEnabled, isNLSUnidataSession, isRPCError, licenseToken, outPacket, password, proxyHost, proxyPort, proxySecurityToken, timeout, transport, uniConnectionString, uniDataSourceType, uniMarkCharacters, uniSubKey, userName

Constructor Summary

UniSession()
Constructor for this class.

UniSession(int sslmode)
Constructor for this class.

UniSession(UniSession aSession)
Constructor for this class.

Method Summary

java.lang.Object	clone()
protected java.lang.Object	clonePooled()
UniCommand	command() Creates the command object for this session
UniCommand	command(java.lang.Object aCommandString) Creates the command object for this session, uses the passed in argument as the default command to run
void	connect() Opens up the session on the host identified with the setHost method.
void	connect(java.lang.Object aHost, int aPortNumber, java.lang.Object aUser, java.lang.Object aPass, java.lang.Object aPath) Establishes connection to the Host/Port passed in, using the Username, Password, and initial account path passed in.
void	connect(java.lang.Object aHost, int aHostPort, java.lang.Object aUser, java.lang.Object aPass, java.lang.Object aPath, java.lang.Object aProxyHost, java.lang.Object aProxyToken) Establishes connection to the Host passed in, using the Username, Password, and initial account path passed in.
void	connect(java.lang.Object aHost, java.lang.Object aUser, java.lang.Object aPass, java.lang.Object aPath) Establishes connection to the Host passed in, using the Username, Password, and initial account path passed in.
void	connect(java.lang.Object aHost, java.lang.Object aUser, java.lang.Object aPass, java.lang.Object aPath, java.lang.Object aProxyHost, int aProxyPort, java.lang.Object aProxyToken) Establishes connection to the Host passed in, using the Username, Password, and initial account path passed in.
void	connect(java.lang.Object aHost, java.lang.Object aUser, java.lang.Object aPass, java.lang.Object aPath, java.lang.Object aProxyHost, java.lang.Object aProxyToken) Establishes connection to the Host passed in, using the Username, Password, and initial account path passed in.
protected void	connectInternal()
void	disconnect() Terminates an active connection.
protected void	disconnectServer()
UniDynArray	dynArray() Creates an empty dynamic array
UniDynArray	dynArray(java.lang.Object aString) Creates a dynamic array from the given object
protected void	finalize()
java.lang.String	getAtVariable(int aTokenVal) returns the current value of the @variable specified by the input parameter.
protected java.util.Date	getCreationTime()
int	getDefaultBlockingStrategy() returns the default blocking strategy for this session.
int	getDefaultLockStrategy() returns the default locking strategy for this session.
int	getDefaultReleaseStrategy() returns the default release strategy for this session.
protected java.util.Date	getFreedTime()
int	getMaxOpenFiles() returns the maximum number of UniFile objects we can open at any one time.
int	getNumOpenFiles() returns the current number of open UniFile objects.
protected boolean	getPooledSession()
UniSSLDescriptor	getSSLDescriptor()
int	getSSLMode()
protected java.lang.String	getValue(int key) used to get a AT value from the server
UniString	iconv(java.lang.Object aString, java.lang.Object aConvCode) converts an input string into a UniVerse internal storage format using the conversion format specified.
protected void	initDefaultValues() sets up the default values
protected boolean	isCommandActive() checks to see if a command is in an active state
protected boolean	IsCPSupported(java.lang.String ServerId)
boolean	isnSecure() returns false if the session is SSL secure session; true otherwise
UniNLSlocale	nlsLocale() If NLS is enabled on the server machine, this method will return an active UniNLSlocale object, which can then be used to manipulate server-side NLS Locale settings.
UniNLSmap	nlsMap() If NLS is enabled on the server machine, this method will return an active UniNLSmap object, which can then be used to manipulate server-side NLS Map settings.
UniString	oconv(java.lang.Object aString, java.lang.Object aConvCode) converts an output string into a UniVerse output storage format using the conversion format specified.
UniFile	open(java.lang.Object aFileName) returns a new UniFile object.
UniDictionary	openDict(java.lang.Object aFileName) returns a new UniDictionary object.
UniFile	openFile(java.lang.Object aFileName) returns a new UniFile object.
UniSequentialFile	openSeq(java.lang.Object aFileName, java.lang.Object aRecordID, boolean aCreateFlag) returns a new UniSequentialFile object.
void	releaseTaskLock(int aLockNum) used to release a TaskLock that was set previously using the setTaskLock method.
UniSelectList	selectList(int aSelectListNumber) returns a newly created UniSelectList object
void	setAtVariable(int aTokenVal, java.lang.Object aAtVariable) sets the given @variable to the value passed in.
void	setCompressionThreshold(int aCompressionThresholdVal) sets the current CompressionThreshold value.
protected void	setCreationTime(java.util.Date creationTime)
void	setDefaultBlockingStrategy(int aBlockingStrategy) sets the default blocking strategy
void	setDefaultEncryptionType(int aEncryptionType) sets the current default encryption type to be used for this session.
void	setDefaultLockStrategy(int aLockingStrategy) sets the default locking strategy
void	setDefaultReleaseStrategy(int aReleaseStrategy) sets the default release strategy
protected void	setFreedTime(java.util.Date freedTime)
protected void	setMarks(java.lang.String[] MarksArray) Sets the MArks from NLSMap Object
protected void	setPooledSession(boolean pooledSession)
void	setSSLDescriptor(UniSSLDescriptor ussld)
void	setTaskLock(int aLockNum) used to set on of the 64 UniVerse synchronization locks.
void	setTimeout(int aTimeoutVal) Sets the UniRPC timeout value.
int	status() returns information concerning the state of certain operations.
UniSubroutine	subroutine(java.lang.Object aSubName, int aNumArgs) returns a new UniSubroutine representing the new subroutine object created.
UniTransaction	transaction() returns a new UniTransaction object to allow transactional control of the session.
UniXML	xml() returns a new UniXML representing the new xml object created.

Methods inherited from class asjava.uniclientlibs.UniConnection

encrypt, getAccountPath, getCompressionThreshold, getConnectionString, getDataSourceType, getDefaultEncryptionType, getDeviceSubkey, getHostName, getHostPort, getHostType, getInPacket, getMarkCharacter, getOutPacket, getPassword, getProxyHost, getProxyPort, getProxyToken, getRPCError, getServerVersion, getTimeout, getTransport, getUserName, isActive, isCompressionEnabled, isEncryptionEnabled, isNLSEnabled, isNLSLocalesEnabled, setAccountPath, setAccountPath, setCompressionThresholdInt, setConnectionString, setConnectionString, setDataSourceType, setDataSourceType, setDefaultEncryptionTypeInt, setDeviceSubkey, setHostName, setHostName, setHostPort, setPassword, setPassword, setProxyHost, setProxyHost, setProxyPort, setProxyToken, setRPCError, setTimeoutInt, setTransport, setUserName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

uniTransaction

protected UniTransaction uniTransaction

uniCommand

protected UniCommand uniCommand

uniNLSLocale

protected UniNLSlocale uniNLSLocale

uniNLSMap

protected UniNLSmap uniNLSMap

atVariableArray

protected java.lang.String[] atVariableArray

Constructor Detail

UniSession

public UniSession()

Constructor for this class. It establishes the UniRPCConnection object.

Since:

UNIOBJECTS 1.0

UniSession

public UniSession(UniSession aSession)
           throws UniSessionException

Constructor for this class. It establishes the UniRPCConnection object. This version multiplexes the connection through an existing connection

Parameters:

aSession - UniSession representing an existing active session

Throws:

UniSessionException - is thrown if an error occurs

Since:

UNIOBJECTS 1.0

UniSession

public UniSession(int sslmode)
           throws UniSessionException

Constructor for this class. It establishes the UniRPCConnection object. Allows to create secure SSL session by setting sslflag to true

Since:

UNIOBJECTS ???

Method Detail

clone

public java.lang.Object clone()

finalize

protected void finalize()

command

public UniCommand command()
                   throws UniSessionException

Creates the command object for this session

Throws:

UniSessionException - is thrown if there is no active connection or if their is an error establishing the UniCommand object

Since:

UNIOBJECTS 1.0

command

public UniCommand command(java.lang.Object aCommandString)
                   throws UniSessionException

Creates the command object for this session, uses the passed in argument as the default command to run

Parameters:

aCommandString - String representing the server-side command/stored procedure to be run. Performs an automatic UniCommand.setCommand() as a convenience.

Throws:

UniSessionException - is thrown if there is no active connection or if their is an error establishing the UniCommand object

Since:

UNIOBJECTS 1.0

connectInternal

protected void connectInternal()
                        throws UniSessionException

Throws:

UniSessionException

connect

public void connect()
             throws UniSessionException

Opens up the session on the host identified with the setHost method. It uses the values established with the setUserName, setPassword, setAccountPath, setProxyHost, and setProxySecurityToken methods. If an error occurs during the connection request, a UniSessionException is thrown.

Throws:

UniSessionException - is thrown if the connection cannot be established

Since:

UNIOBJECTS 1.0

See Also:

UniConnection.setUserName(java.lang.Object), UniConnection.setHostName(java.lang.String), UniConnection.setHostPort(int), UniConnection.setPassword(java.lang.Object), UniConnection.setAccountPath(java.lang.Object), UniConnection.setProxyHost(java.lang.Object), UniConnection.setProxyPort(int), UniConnection.setProxyToken(java.lang.Object)

connect

public void connect(java.lang.Object aHost,
                    java.lang.Object aUser,
                    java.lang.Object aPass,
                    java.lang.Object aPath)
             throws UniSessionException

Establishes connection to the Host passed in, using the Username, Password, and initial account path passed in.

Parameters:

aHost - String representing the host to connect to. Either the name of the host or the IP address (ex. 192.102.111.1)

aUser - String representing the user name on the server machine.

aPass - String representing the password on the server machine

aPath - String representing the account path to log into on the server machine

Throws:

UniSessionException - is thrown if the connection cannot be made

Since:

UNIOBJECTS 1.0

connect

public void connect(java.lang.Object aHost,
                    int aPortNumber,
                    java.lang.Object aUser,
                    java.lang.Object aPass,
                    java.lang.Object aPath)
             throws UniSessionException

Establishes connection to the Host/Port passed in, using the Username, Password, and initial account path passed in.

Parameters:

aHost - String representing the host to connect to. Either the name of the host or the IP address (ex. 192.102.111.1)

aPortNumber - integer representing the port to connect to

aUser - String representing the user name on the server machine.

aPass - String representing the password on the server machine

aPath - String representing the account path to log into on the server machine

Throws:

UniSessionException - is thrown if the connection cannot be made

Since:

UNIOBJECTS 1.0

connect

public void connect(java.lang.Object aHost,
                    java.lang.Object aUser,
                    java.lang.Object aPass,
                    java.lang.Object aPath,
                    java.lang.Object aProxyHost,
                    java.lang.Object aProxyToken)
             throws UniSessionException

Establishes connection to the Host passed in, using the Username, Password, and initial account path passed in.

Parameters:

aHost - String representing the host to connect to. Either the name of the host or the IP address (ex. 192.102.111.1)

aUser - String representing the user name on the server machine.

aPass - String representing the password on the server machine

aPath - String representing the account path to log into on the server machine

aProxyHost - String representing the proxy host to connect to. Either the name of the host or the IP address.

aProxyToken - string representing the Proxy password

Throws:

UniSessionException - is thrown if the connection cannot be made

Since:

UNIOBJECTS 1.0

connect

public void connect(java.lang.Object aHost,
                    java.lang.Object aUser,
                    java.lang.Object aPass,
                    java.lang.Object aPath,
                    java.lang.Object aProxyHost,
                    int aProxyPort,
                    java.lang.Object aProxyToken)
             throws UniSessionException

Establishes connection to the Host passed in, using the Username, Password, and initial account path passed in.

Parameters:

aHost - String representing the host to connect to. Either the name of the host or the IP address (ex. 192.102.111.1)

aUser - String representing the user name on the server machine.

aPass - String representing the password on the server machine

aPath - String representing the account path to log into on the server machine

aProxyHost - String representing the proxy host to connect to. Either the name of the host or the IP address.

aProxyToken - string representing the Proxy password

Throws:

UniSessionException - is thrown if the connection cannot be made

Since:

UNIOBJECTS 1.0

connect

public void connect(java.lang.Object aHost,
                    int aHostPort,
                    java.lang.Object aUser,
                    java.lang.Object aPass,
                    java.lang.Object aPath,
                    java.lang.Object aProxyHost,
                    java.lang.Object aProxyToken)
             throws UniSessionException

Establishes connection to the Host passed in, using the Username, Password, and initial account path passed in.

Parameters:

aHost - String representing the host to connect to. Either the name of the host or the IP address (ex. 192.102.111.1)

aUser - String representing the user name on the server machine.

aPass - String representing the password on the server machine

aPath - String representing the account path to log into on the server machine

aProxyHost - String representing the proxy host to connect to. Either the name of the host or the IP address.

aProxyToken - string representing the Proxy password

Throws:

UniSessionException - is thrown if the connection cannot be made

Since:

UNIOBJECTS 1.0

disconnect

public void disconnect()
                throws UniSessionException

Terminates an active connection. If the connection has not been established, will just return

Throws:

UniSessionException - occurs is an error occurs during the termination

Since:

UNIOBJECTS 1.0

See Also:

connect()

disconnectServer

protected void disconnectServer()
                         throws UniSessionException

Throws:

UniSessionException

dynArray

public UniDynArray dynArray()

Creates an empty dynamic array

Since:

UNIOBJECTS 1.0

dynArray

public UniDynArray dynArray(java.lang.Object aString)

Creates a dynamic array from the given object

Parameters:

aString - object by which the dynamic array will be initialized with

Since:

UNIOBJECTS 1.0

getAtVariable

public java.lang.String getAtVariable(int aTokenVal)
                               throws UniSessionException

returns the current value of the @variable specified by the input parameter. Valid values for the input value are:

• Token (Value) UniVerse @Variable
• AT_LOGNAME(1) @LOGNAME
• AT_PATH(2) @PATH
• AT_USERNO(3) @USERNO
• AT_WHO(4) @WHO
• AT_TRANSACTION(5) @TRANSACTION
• AT_DATA_PENDING(6) @DATA.PENDING
• AT_USER_RETURN_CODE(7) @USER.RETURN.CODE
• AT_SYSTEM_RETURN_CODE(8) @SYSTEM.RETURN.CODE
• AT_NULL_STR(9) @NULL.STR
• AT_SCHEMA(10) @SCHEMA

Parameters:

aTokenVal - integer representing which @variable to return.

Returns:

String representing the @variable requested

Throws:

UniSessionException - is thrown if an illegal argument is passed in

Since:

UNIOBJECTS 1.0

See Also:

setAtVariable(int, java.lang.Object)

getDefaultBlockingStrategy

public int getDefaultBlockingStrategy()

returns the default blocking strategy for this session. This controls the default behavior of what requests that block on another lock do. It can be overriden by individual objects or requests. Valid values are:

• WAIT_ON_LOCKED (1) - If record is locked, wait until it is released.
• RETURN_ON_LOCKED (2) - Return a value to the status method to indicate the state of the lock. This is the default value.

Returns:

integer representing the current default blocking strategy

Since:

UNIOBJECTS 1.0

See Also:

setDefaultBlockingStrategy(int)

getDefaultLockStrategy

public int getDefaultLockStrategy()

returns the default locking strategy for this session. This controls the default behavior of what type of lock is to be set when data is manipulated. It can be overriden by individual objects or requests. Valid values are:

• NO_LOCKS (0) - no locking is to be performed. This is the default.
• EXCLUSIVE_UPDATE (1) - Set an exclusive update lock (READU)
• SHARED_READ (2) - Sets a shared read lock (READL)

Returns:

integer representing the current default locking strategy

Since:

UNIOBJECTS 1.0

See Also:

setDefaultLockStrategy(int)

getDefaultReleaseStrategy

public int getDefaultReleaseStrategy()

returns the default release strategy for this session. This controls the default behavior of what requests that manipulate data does to existing locks. It can be overriden by individual objects or requests. Valid values are:

• WRITE_RELEASE (1) - Releases the lock when the record is written. This is the default.
• READ_RELEASE (2) - Releases the lock when the record is read.
• EXPLICIT_RELEASE (4) - maintains locks as specified by the LockStrategy. requires an unlockRecord method to unlock the record.
• CHANGE_RELEASE (8) - releases the lock whenever a new value is assigned to the recordID property via the setRecordID method.

  Returns:

  integer representing the current default release strategy

  Since:

  UNIOBJECTS 1.0

  See Also:

  setDefaultReleaseStrategy(int)

getMaxOpenFiles

public int getMaxOpenFiles()

returns the maximum number of UniFile objects we can open at any one time. A return value of 0 means there is no limit.

Returns:

integer representing the maximum number of files that can be opened.

Since:

UNIOBJECTS 1.0

getNumOpenFiles

public int getNumOpenFiles()

returns the current number of open UniFile objects.

Returns:

integer representing the number of currently active UniFile objects

Since:

UNIOBJECTS 1.0

getSSLDescriptor

public UniSSLDescriptor getSSLDescriptor()

iconv

public UniString iconv(java.lang.Object aString,
                       java.lang.Object aConvCode)
                throws UniStringException

converts an input string into a UniVerse internal storage format using the conversion format specified. The status function can be used after this method to determine the status of the iconv method.

Parameters:

aString - input string that is to be converted

aConvCode - conversion code used to convert the string

Returns:

UniString representing the newly converted string

Throws:

UniStringException - is thrown if an error occurs

Since:

UNIOBJECTS 1.0

See Also:

oconv(java.lang.Object, java.lang.Object), status()

isnSecure

public boolean isnSecure()

returns false if the session is SSL secure session; true otherwise

Since:

UNIOBJECTS ???

getSSLMode

public int getSSLMode()

nlsLocale

public UniNLSlocale nlsLocale()
                       throws UniSessionException

If NLS is enabled on the server machine, this method will return an active UniNLSlocale object, which can then be used to manipulate server-side NLS Locale settings.

Returns:

UniNLSlocale object representing the state of the server-side NLS Locale.

Throws:

UniSessionException - is thrown if an error occurs

Since:

UNIOBJECTS 1.0

See Also:

nlsMap()

nlsMap

public UniNLSmap nlsMap()
                 throws UniSessionException

If NLS is enabled on the server machine, this method will return an active UniNLSmap object, which can then be used to manipulate server-side NLS Map settings.

Returns:

UniNLSmap object representing the state of the server-side NLS map.

Throws:

UniSessionException - is thrown if an error occurs

Since:

UNIOBJECTS 1.0

See Also:

nlsLocale()

oconv

public UniString oconv(java.lang.Object aString,
                       java.lang.Object aConvCode)
                throws UniStringException

converts an output string into a UniVerse output storage format using the conversion format specified. The status function can be used after this method to determine the status of the oconv method.

Parameters:

aString - input string that is to be converted

aConvCode - conversion code used to convert the string

Returns:

UniString representing the newly converted string

Throws:

UniStringException - is thrown if an error occurs

Since:

UNIOBJECTS 1.0

See Also:

iconv(java.lang.Object, java.lang.Object), status()

openFile

public UniFile openFile(java.lang.Object aFileName)
                 throws UniSessionException

returns a new UniFile object.

Parameters:

aFileName - name of the universe file to be opened.

Returns:

UniFile object representing the newly opened file

Throws:

UniSessionException - is thrown if there is an error

Since:

UNIOBJECTS 1.0

open

public UniFile open(java.lang.Object aFileName)
             throws UniSessionException

returns a new UniFile object.

Parameters:

aFileName - name of the universe file to be opened.

Returns:

UniFile object representing the newly opened file

Throws:

UniSessionException - is thrown if there is an error

Since:

UNIOBJECTS 1.0

openDict

public UniDictionary openDict(java.lang.Object aFileName)
                       throws UniSessionException

returns a new UniDictionary object.

Parameters:

aFileName - name of the universe dictionary file to be opened.

Returns:

UniDictionary object representing the newly opened dictionary file

Throws:

UniSessionException - is thrown if there is an error

Since:

UNIOBJECTS 1.0

openSeq

public UniSequentialFile openSeq(java.lang.Object aFileName,
                                 java.lang.Object aRecordID,
                                 boolean aCreateFlag)
                          throws UniSessionException

returns a new UniSequentialFile object.

Parameters:

aFileName - name of the sequential file to be opened. A UniVerse Type 1 or 19 file

aRecordID - refers to a record within the file, optionally created if it does not exist

aCreateFlag - boolean denoting whether or not the file should be created if it does not exist.

Returns:

UniSequentialFile object representing the newly opened sequential file

Throws:

UniSessionException - is thrown if there is an error

Since:

UNIOBJECTS 1.0

releaseTaskLock

public void releaseTaskLock(int aLockNum)
                     throws UniSessionException

used to release a TaskLock that was set previously using the setTaskLock method.

Parameters:

aLockNum - integer representing which of the 64 UniVerse task locks is to be set.

Throws:

UniSessionException - is thrown if an error occurs.

Since:

UNIOBJECTS 1.0

See Also:

setTaskLock(int)

selectList

public UniSelectList selectList(int aSelectListNumber)
                         throws UniSessionException

returns a newly created UniSelectList object

Parameters:

aSelectListNumber - which UniVerse select list to create

Returns:

UniSelectList object

Throws:

UniSessionException - is thrown if an error occurs

Since:

UNIOBJECTS 1.0

setAtVariable

public void setAtVariable(int aTokenVal,
                          java.lang.Object aAtVariable)
                   throws UniSessionException

sets the given @variable to the value passed in. Only affects UniObjectsTokens.AT_USER_RETURN_CODE (value = 7 )

Parameters:

aTokenVal - integer representing which @variable to set

aAtVariable - String representing the @variables new value

Throws:

UniSessionException - is thrown if an invalid aTokenVal is passed in

Since:

UNIOBJECTS 1.0

See Also:

getAtVariable(int)

setCompressionThreshold

public void setCompressionThreshold(int aCompressionThresholdVal)
                             throws UniSessionException

sets the current CompressionThreshold value.

Parameters:

aCompressionThresholdVal - integer representing the amount, in bytes, to set the compression threshold to

Throws:

UniSessionException - is thrown if an invalid aCompressionThresholdVal is passed in

Since:

UNIOBJECTS 1.0

setDefaultBlockingStrategy

public void setDefaultBlockingStrategy(int aBlockingStrategy)
                                throws UniSessionException

sets the default blocking strategy

Parameters:

aBlockingStrategy - integer representing the default blocking strategy

Throws:

UniSessionException - is thrown if an invalid aBlockingStrategy is passed in

Since:

UNIOBJECTS 1.0

See Also:

getDefaultBlockingStrategy()

setDefaultEncryptionType

public void setDefaultEncryptionType(int aEncryptionType)
                              throws UniSessionException

sets the current default encryption type to be used for this session. All subobjects will inherit this value unless specifically overriden. It controls the type of encryption that is to be used for data transfer. Valid values are:

• NO_ENCRYPTION (0) - no encryption is to be done. This is the default value.
• INTERNAL_ENCRYPTION (1) - use UniVerse internal encryption. /ul>

  Parameters:

  aEncryptionType - integer representing the type of encryption that is to be used.

  Throws:

  UniSessionException - is thrown if an invalid aType is passed in

  Since:

  UNIOBJECTS 1.0

setDefaultLockStrategy

public void setDefaultLockStrategy(int aLockingStrategy)
                            throws UniSessionException

sets the default locking strategy

Parameters:

aLockingStrategy - integer representing the default locking strategy

Throws:

UniSessionException - is thrown if an invalid aLockingStrategy is passed in

Since:

UNIOBJECTS 1.0

See Also:

getDefaultLockStrategy()

setDefaultReleaseStrategy

public void setDefaultReleaseStrategy(int aReleaseStrategy)
                               throws UniSessionException

sets the default release strategy

Parameters:

aReleaseStrategy - integer representing the default release strategy

Throws:

UniSessionException - is thrown if an invalid aReleaseStrategy is passed in

Since:

UNIOBJECTS 1.0

See Also:

getDefaultReleaseStrategy()

setSSLDescriptor

public void setSSLDescriptor(UniSSLDescriptor ussld)

setTaskLock

public void setTaskLock(int aLockNum)
                 throws UniSessionException

used to set on of the 64 UniVerse synchronization locks.

Parameters:

aLockNum - integer representing which one of the 64 UniVerse synchronization locks is to be set

Throws:

UniSessionException - is thrown is an error occurs in obtaining the task lock

Since:

UNIOBJECTS 1.0

See Also:

releaseTaskLock(int)

setTimeout

public void setTimeout(int aTimeoutVal)
                throws UniSessionException

Sets the UniRPC timeout value. Initially, it is set to 0, indicating no timeout is to occur. If it is set to a value > 0, the UniRPC will timeout after that many seconds.

Parameters:

aTimeoutVal - integer representing the number of seconds the UniRPC should wait until it times out.

Throws:

UniSessionException - is thrown if the timeout cannot be set

Since:

UNIOBJECTS 1.0

setMarks

protected void setMarks(java.lang.String[] MarksArray)
                 throws UniSessionException

Sets the MArks from NLSMap Object

Parameters:

MarksArray - integer representing the number of seconds the UniRPC should wait until it times out.

Throws:

UniSessionException - is thrown if the timeout cannot be set

Since:

UNIOBJECTS 1.0

status

public int status()

returns information concerning the state of certain operations. See those methods for more details

Returns:

integer representing the status of the last operation performed.

Since:

UNIOBJECTS 1.0

See Also:

connect()

subroutine

public UniSubroutine subroutine(java.lang.Object aSubName,
                                int aNumArgs)
                         throws UniSessionException

returns a new UniSubroutine representing the new subroutine object created.

Parameters:

aSubName - String representing the name of the subroutine to be executed on the server.

aNumArgs - integer representing the number of arguments this subroutine has

Returns:

UniSubroutine object representing the new subroutine

Throws:

UniSessionException - is thrown if an error occurs

Since:

UNIOBJECTS 1.0

xml

public UniXML xml()
           throws UniSessionException

returns a new UniXML representing the new xml object created.

Returns:

UniXML object representing the new xml

Throws:

UniSessionException - is thrown if an error occurs

Since:

UNIOBJECTS 2.4

transaction

public UniTransaction transaction()
                           throws UniSessionException

returns a new UniTransaction object to allow transactional control of the session.

Returns:

UniTransaction object allow modification of the sessions transactional behavior

Throws:

UniSessionException - is thrown if an error occurs

Since:

UNIOBJECTS 1.0

getValue

protected java.lang.String getValue(int key)
                             throws UniSessionException

used to get a AT value from the server

Parameters:

key - integer representing the key value requested

Returns:

String representing the UniVerse session @variable

Throws:

UniSessionException - is thrown if an error occurs

Since:

UNIOBJECTS 1.0

isCommandActive

protected boolean isCommandActive()

checks to see if a command is in an active state

Returns:

boolean stating whether we are in the middle of a command execution or not

Since:

UNIOBJECTS 1.0

clonePooled

protected java.lang.Object clonePooled()
                                throws UniSessionException

Throws:

UniSessionException

IsCPSupported

protected boolean IsCPSupported(java.lang.String ServerId)

getCreationTime

protected java.util.Date getCreationTime()

Returns:

Returns the creationTime.

setCreationTime

protected void setCreationTime(java.util.Date creationTime)

Parameters:

creationTime - The creationTime to set.

getPooledSession

protected boolean getPooledSession()

Returns:

Returns the pooledSession.

setPooledSession

protected void setPooledSession(boolean pooledSession)

Parameters:

pooledSession - The pooledSession to set.

getFreedTime

protected java.util.Date getFreedTime()

Returns:

Returns the freedTime.

setFreedTime

protected void setFreedTime(java.util.Date freedTime)

Parameters:

freedTime - The freedTime to set.

initDefaultValues

protected void initDefaultValues()

sets up the default values