|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jafer.zclient.ZSession
public class ZSession
Manages a zclient session and sets up connection with zserver using org.jafer.util.PDUDriver. A session can be anonymous or if authentication is required by target, the client sets properties for user/group/password. Changing these properties will terminate an existing session and establish a new one.
Field Summary | |
---|---|
private java.lang.String |
group
|
private java.lang.String |
host
|
private static java.util.logging.Logger |
logger
|
private java.lang.String |
name
|
private java.lang.String |
password
|
private PDUDriver |
pduDriver
|
private int |
port
|
private static int |
sessionId
|
private java.net.Socket |
socket
|
private static int |
SOCKET_CONNECT_TIMEOUT
double SOCKET_CONNECT_TIMEOUT Timeout in milliseconds for the Socket.connect () function. |
private java.lang.String |
targetInfo
|
private int |
targetVersion
|
private int |
timeout
|
private java.lang.String |
username
|
Constructor Summary | |
---|---|
ZSession(java.lang.String host,
int port,
int timeout)
|
Method Summary | |
---|---|
void |
close()
This method closes the current connection and any underlying binding classes |
private void |
connect()
|
java.lang.String |
getGroup()
Returns the group for this session. |
int |
getId()
Return the session Identifier |
java.lang.String |
getName()
Return the name allocatted to this session |
java.lang.String |
getPassword()
Return the password for the user connecting via this session |
PDUDriver |
getPDUDriver()
|
java.lang.String |
getUsername()
Return the username for the user connecting via this session |
void |
init(java.lang.String group,
java.lang.String username,
java.lang.String password)
Initalise the session |
java.util.Vector |
present(int nRecord,
int nRecords,
int[] recordOID,
java.lang.String eSpec,
java.lang.String resultSetName)
Obtain the requested records via the sessions connection to the server and return them to the caller |
java.util.Vector |
scan(java.lang.String[] databases,
int nTerms,
int step,
int position,
org.w3c.dom.Node term)
Performs a scan on the sessions connection to the sever to retrieve a list of related terms |
java.util.Vector |
scan(java.lang.String[] databases,
int nTerms,
int step,
int position,
java.lang.Object termObject)
Performs a scan on the sessions connection to the sever to retrieve a list of related terms |
SearchResult[] |
search(java.lang.Object queryObject,
java.lang.String[] databases,
java.lang.String resultSetName)
Performs a search on the sessions connection to the sever to work out how many results would be returned for the search query |
private void |
setName(java.lang.String group,
java.lang.String username,
java.lang.String password)
|
void |
setPDUDriver(PDUDriver pduDriver)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private static java.util.logging.Logger logger
private static int sessionId
private PDUDriver pduDriver
private java.net.Socket socket
private java.lang.String name
private java.lang.String host
private java.lang.String group
private java.lang.String username
private java.lang.String password
private java.lang.String targetInfo
private int port
private int timeout
private int targetVersion
private static final int SOCKET_CONNECT_TIMEOUT
Constructor Detail |
---|
public ZSession(java.lang.String host, int port, int timeout)
Method Detail |
---|
private void connect() throws ConnectionException
ConnectionException
public void init(java.lang.String group, java.lang.String username, java.lang.String password) throws ConnectionException
Session
init
in interface Session
group
- The group name for this sessionusername
- The username of the user connecting via this sessionpassword
- The password of the user connecting via this session
ConnectionException
public void close()
Session
close
in interface Session
public SearchResult[] search(java.lang.Object queryObject, java.lang.String[] databases, java.lang.String resultSetName) throws JaferException, ConnectionException
Session
search
in interface Session
queryObject
- The query object to search against. Normally RPNNode
or a simple Node that represents a JaferQuerydatabases
- The list of databases to be searchedresultSetName
- The name to be given to the result set
JaferException
ConnectionException
public java.util.Vector present(int nRecord, int nRecords, int[] recordOID, java.lang.String eSpec, java.lang.String resultSetName) throws PresentException, ConnectionException
Session
present
in interface Session
nRecord
- The index of the record that the retrieve should start atnRecords
- The maximum number of records that should be returnedrecordOID
- The record object identifiereSpec
- The element spec attribute of the ZClientresultSetName
- The result set name
PresentException
ConnectionException
public java.util.Vector scan(java.lang.String[] databases, int nTerms, int step, int position, org.w3c.dom.Node term) throws JaferException, ConnectionException
Session
scan
in interface Session
databases
- An array of database names that are being scannednTerms
- The maximum number of terms to returnstep
- ?????????????????????????????????????????????????????????position
- ?????????????????????????????????????????????????????term
- ?????????????????????????????????????????????????????????
JaferException
ConnectionException
public java.util.Vector scan(java.lang.String[] databases, int nTerms, int step, int position, java.lang.Object termObject) throws JaferException, ConnectionException
Session
scan
in interface Session
databases
- An array of database names that are being scannednTerms
- The maximum number of terms to returnstep
- ?????????????????????????????????????????????????????????position
- ?????????????????????????????????????????????????????termObject
- ???????????????????????????????????????????????????
JaferException
ConnectionException
public void setPDUDriver(PDUDriver pduDriver)
public PDUDriver getPDUDriver()
private void setName(java.lang.String group, java.lang.String username, java.lang.String password)
public int getId()
Session
getId
in interface Session
public java.lang.String getName()
Session
getName
in interface Session
public java.lang.String getGroup()
Session
getGroup
in interface Session
public java.lang.String getUsername()
Session
getUsername
in interface Session
public java.lang.String getPassword()
Session
getPassword
in interface Session
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |