All Packages Class Hierarchy This Package Previous Next Index
Class asjava.uniobjects.UniJava
java.lang.Object
|
+----asjava.uniobjects.UniJava
- public class UniJava
- extends Object
UniJava
is the base class for the UniObjects for Java product. Its primary
purpose is object marshalling and enumeration, as well as instantiation of all
UniSession
objects. One UniJava
object MUST be created by every
application that uses this API.
- Version:
- Version 1.0
- Author:
- David T. Meeks
-
UniJava()
- Constructs a
UniJava
object.
-
closeAllSessions()
- This method will close all open sessions by going through the uniSessionsVector list
and calling the
UniSession.disconnect()
method for each individual session.
-
closeSession(UniSession)
- This method will close the session passed into it.
-
getMaxSessions()
- The maximum number of open sessions that can be open.
-
getNumSessions()
- The current number of open sessions that are open.
-
getVersionNumber()
- The current version number
-
openSession()
- Instantiates a new
UniSession
object.
UniJava
public UniJava()
- Constructs a
UniJava
object.
closeAllSessions
public void closeAllSessions() throws UniSessionException
- This method will close all open sessions by going through the uniSessionsVector list
and calling the
UniSession.disconnect()
method for each individual session. It will
then eliminate all entries from the uniSessionsVector.
- Throws: UniSessionException
- is thrown if an error occurs
- See Also:
- closeSession
closeSession
public void closeSession(UniSession aSession) throws UniSessionException
- This method will close the session passed into it. It will do this by calling the
UniSession.disconnect()
method, allowing the session to properly close.
It will also remove the entry from the uniSessionsVector.
- Parameters:
- aSession - the UniSession object that should be closed
- Throws: UniSessionException
- is thrown if an error occurs
- See Also:
- closeAllSessions
getMaxSessions
public int getMaxSessions()
- The maximum number of open sessions that can be open. If a 0 is returned, there is
no set limit.
- Returns:
- the maximum number of open sessions, or a 0 for unlimited session support
getNumSessions
public int getNumSessions()
- The current number of open sessions that are open.
- Returns:
- the current number of open sessions
getVersionNumber
public String getVersionNumber()
- The current version number
- Returns:
- the current version number
openSession
public UniSession openSession() throws UniSessionException
- Instantiates a new
UniSession
object. It also stores the reference into
the uniSessionsVector. If an error occurs, it throws a UniSessionException
- Returns:
- a UniSession object
- Throws: UniSessionException
- if it encounters an error during creation.
All Packages Class Hierarchy This Package Previous Next Index