|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RemoteHostSession
A host session connector that can be used to connect to a different
model from within an event handler. A connector is created using
the Event.createHostSession()
method. Once created, a connection
must be established to a Host Integrator Server before most of the
methods can be used.
Field Summary |
---|
Fields inherited from interface com.wrq.vhi.script.api.HostSession |
---|
ANY_COLUMN, ANY_ROW, CURRENT_COLUMN, CURRENT_ROW, DESIGN_TOOL_AND_SERVER, DESIGN_TOOL_ONLY, DONT_WAIT_FOR_ECHO, LINEAR_REGION, RECTANGULAR_REGION, SCROLL_END, SCROLL_HOME, SCROLL_LINE_DOWN, SCROLL_LINE_UP, SCROLL_PAGE_DOWN, SCROLL_PAGE_UP, SYNC_TO_HOST, WAIT_FOR_CURSOR_AUTOTAB, WAIT_FOR_CURSOR_MOVE, WAIT_FOR_ECHO_BEHIND_CURSOR, WAIT_FOR_ECHO_SAME_NUMBER, WAIT_FOR_ECHO_TAB_OR_BEHIND_CURSOR |
Method Summary | |
---|---|
void |
connectToModel(java.lang.String server,
java.lang.String modelName,
java.lang.String userid,
java.lang.String password,
java.util.Map modelVariables)
Establishes a connection to a Host Integrator Server and creates a host session with the specified model. |
void |
connectToModelViaDomain(java.lang.String directoryServer,
java.lang.String domainName,
java.lang.String modelName,
java.lang.String userid,
java.lang.String password,
java.util.Map modelVariables)
Establishes a connection to a Host Integrator Server and creates a host session with the specified model. |
void |
connectToSession(java.lang.String server,
java.lang.String session,
java.lang.String userid,
java.lang.String password,
java.util.Map modelVariables)
Establishes a connection to a Host Integrator Server and obtains a host session from the specified session pool. |
void |
connectToSessionViaDomain(java.lang.String directoryServer,
java.lang.String domainName,
java.lang.String session,
java.lang.String userid,
java.lang.String password,
java.util.Map modelVariables)
Establishes a connection to a Host Integrator Server and obtains a host session from the specified session pool. |
void |
disconnect()
Disconnects from a Host Integrator Server Session. |
int |
getConnectionTimeout()
Gets the connection timeout for a Host Integrator Server session. |
int |
getMethodTimeout()
Gets the method timeout for a Host Integrator Server session. |
java.lang.String |
getModelName()
Gets the name of the Host Integrator model for the current session. |
java.lang.String |
getServerName()
Gets the name of the Host Integrator Server for the current session. |
boolean |
isConnected()
Determines whether the Host Integrator Server session is connected. |
boolean |
isConnectionSecure()
Determines whether the Host Integrator Server session is using a secure connection. |
void |
requireSecureConnection(boolean require)
Requires a secure channel on the next connection to a Host Integrator Server. |
void |
resumeConnection(java.lang.String connectionToken)
Resumes the execution of a currently suspended Host Integrator server session. |
void |
setConnectionTimeout(int timeout)
Sets the connection timeout for a Host Integrator Server session. |
void |
setMethodTimeout(int timeout)
Sets the method timeout for a Host Integrator Server session. |
java.lang.String |
suspendConnection(int timeout)
Suspends the execution of a currently running Host Integrator Server session. |
Method Detail |
---|
void connectToModel(java.lang.String server, java.lang.String modelName, java.lang.String userid, java.lang.String password, java.util.Map modelVariables) throws ApptrieveException
Establishes a connection to a Host Integrator Server and creates a host session with the specified model.
Reasons for failure include:
The parameters userID and password are used by Host Integrator Server if the security option is enabled.
server
- name of the Host Integrator Server (DNS Name or IP Address)modelName
- name of a Host Integrator modeluserid
- user ID for authorization on the Host Integrator Serverpassword
- password for authorization on the Host Integrator ServermodelVariables
- model variables to set on connection (can be null)
ApptrieveException
- if the connection failsvoid connectToModelViaDomain(java.lang.String directoryServer, java.lang.String domainName, java.lang.String modelName, java.lang.String userid, java.lang.String password, java.util.Map modelVariables) throws ApptrieveException
Establishes a connection to a Host Integrator Server and creates a host session with the specified model. The connection is made using the specified AADS Server and Host Integrator Domain.
Reasons for failure include:
The parameters userID and password are used by Host Integrator Server if the security option is enabled.
directoryServer
- name of the Host Integrator authentication and
authorization directory server (AADS)domainName
- name of the Host Integrator domain to connect tomodelName
- name of a Host Integrator Modeluserid
- user ID for authorization on the Host Integrator Serverpassword
- password for authorization on the Host Integrator ServermodelVariables
- model variables to set on connection (can be null)
ApptrieveException
- if the connection failsvoid connectToSession(java.lang.String server, java.lang.String session, java.lang.String userid, java.lang.String password, java.util.Map modelVariables) throws ApptrieveException
Establishes a connection to a Host Integrator Server and obtains a host session from the specified session pool.
Reasons for failure include:
The parameters userID and password are used by Host Integrator Server if the security option is enabled.
server
- name of the Host Integrator Server (DNS Name or IP Address)session
- name of Host Integrator session pooluserid
- user ID for authorization on the Host Integrator Serverpassword
- password for authorization on the Host Integrator ServermodelVariables
- model variables to set on connection (can be null)
ApptrieveException
- if the connection failsvoid connectToSessionViaDomain(java.lang.String directoryServer, java.lang.String domainName, java.lang.String session, java.lang.String userid, java.lang.String password, java.util.Map modelVariables) throws ApptrieveException
Establishes a connection to a Host Integrator Server and obtains a host session from the specified session pool. The connection is made using the specified AADS Server and Host Integrator Domain.
Reasons for failure include:
The parameters userID and password are used by Host Integrator Server if the security option is enabled.
directoryServer
- name of the Host Integrator authentication and
authorization directory server (AADS)domainName
- name of the Host Integrator domain to connect tosession
- name of a Host Integrator session pooluserid
- user ID for authorization on the Host Integrator Serverpassword
- password for authorization on the Host Integrator ServermodelVariables
- model variables to set on connection (can be null)
ApptrieveException
- if the connection failsvoid disconnect()
int getMethodTimeout()
setMethodTimeout(int)
void setMethodTimeout(int timeout) throws ApptrieveException
timeout
- the timeout in milliseconds
ApptrieveException
getMethodTimeout()
int getConnectionTimeout()
setConnectionTimeout(int)
void setConnectionTimeout(int timeout)
timeout
- the timeout in secondsgetConnectionTimeout()
java.lang.String getModelName()
java.lang.String getServerName()
boolean isConnected()
The return value is true if AppConnSession believes it is currently connected to a Host Integrator server session. This method does not actually perform a server operation to determine whether connection is present. It is possible for the connection to have been lost without the connector detecting it. In this case isConnected() will return true, even though a connection is not present.
boolean isConnectionSecure()
void requireSecureConnection(boolean require)
Note: this call affects only subsequent connections to a Host Integrator Server. It has no affect on any already established connection.
require
- set to true to require a secure connection, false
otherwisejava.lang.String suspendConnection(int timeout) throws ApptrieveException
Reasons for failure include:
timeout
- the timeout value to use for the suspended session in minutes
ApptrieveException
- if the suspension failsresumeConnection(java.lang.String)
void resumeConnection(java.lang.String connectionToken) throws ApptrieveException
Reasons for failure include:
connectionToken
- the token received from the suspendConnection method
ApptrieveException
- if the resume failssuspendConnection(int)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |