Oracle Secure Global Desktop Web Services API Documentation
Release 4.7

E21396-02

com.tarantella.tta.webservices.client.views
Class SessionMonitor

java.lang.Object
  extended by com.tarantella.tta.webservices.client.views.SessionMonitor
All Implemented Interfaces:
IConstants, IFaultCodes, java.io.Serializable

public class SessionMonitor
extends java.lang.Object
implements IConstants, IFaultCodes, java.io.Serializable

For internal use only Provides access to the server-side session cache for looking up session state. Can be used to query the server-side cache for session state information. On creation, SessionMonitor will register its session with the SGD server, enabling server-side events to be triggered for this session. The registration will then populate the server-side cache on the servlet container with the initial state of the session. Calling isSessionActive() can then be used to verify the state of the session in the cache.

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.tarantella.tta.webservices.IConstants
ACTION_OBJECT_CREATED, ACTION_OBJECT_DELETED, ACTION_OBJECT_DISABLED, ACTION_OBJECT_ENABLED, ACTION_SESSION_ADDED, ACTION_SESSION_CHANGED, ACTION_SESSION_REMOVED, ACTION_VIEW_REFRESH, ALL_ATTRS, ALL_PREFERENCES, APPLAUNCH_DELAY, APPLICATION_ATTRS, APPLICATION_OBJECTS, APPSERVER_OBJECTS, ARRAY_MASTER, AUTOMATIC_LOGOUT, AUTOMATIC_LOGOUT_CLOSED, AUTOMATIC_LOGOUT_EVT, AUTOMATIC_LOGOUT_SUSPENDED, CLIENT_ATTRS, CONNECTION_ATTRS, CONNECTION_LOST_EVT, DEFAULT, DEPTH_ONELEVEL, DEPTH_SUBTREE, EVT_ACTION, EVT_AUTHSTATUS, EVT_DATA, EVT_EVENT, EVT_NAME, EVT_REFRESH, EVT_SERVERID, EVT_TCCSTATUS, GRAB_EVT, LOCAL_ATTRS, LOCAL_BROWSER, LOGGED_OUT_EVT, MODE_APPENDATTR, MODE_DIVIDER, MODE_REMOVEATTR, MODE_REPLACEALLATTR, MODE_REPLACEATTR, MULTIPLE_QUERYSTRING_SERVER, NO_CLIENT_PRINTER, OPTION_BASEURL, OPTION_BROWSER, OPTION_DYNAMIC, OPTION_DYNAMIC_APP_TYPE, OPTION_DYNAMIC_PERMANENT_ENS, OPTION_DYNAMIC_PERMANENT_NAME, OPTION_DYNAMIC_SERVER, OPTION_DYNAMIC_SERVER_PORT, OPTION_FORCE_AUTHENTICATION, OPTION_FORCE_VSB_AUTHENTICATION, OPTION_FQN, OPTION_MAY_RESUME, OPTION_SESSION_NAME, OPTION_TOGGLE_DISPLAY, PAUSED, PERMANENT, PRINT_EVT, PROFILE_ATTRS, PROFILE_EVT, REAL_HOSTS, REFRESH_STATE, REMOTE_BROWSER, RESTART_EVT, RESUMED, SAME_BROWSER, SERVER_ATTRS, SESSION_CHANGED_EVT, SESSION_EVT, STORE_APPLICATION, STORE_CLIENT, STORE_CONNECTION, STORE_PROFILE, STORE_SERVER, SYSTEM_OBJECTS, TCC_EVT, THIRD_PARTY_PROFILE, TOKEN, TOP, TRANSIENT, UNIX_USER_PROFILE, VSB_CLASS_NAME_PARAM, VSB_INIT_PARAM_PREFIX, WEBTOP_CHANGED_EVT, WEBTOP_STATE_EVT, WEBTOPSESSION_CHANGED_EVT, WEBTOPSESSION_EVT
 
Fields inherited from interface com.tarantella.tta.webservices.IFaultCodes
CODE_ALREADY_AUTH, CODE_ALREADY_EXISTS, CODE_ALREADY_REGISTERED, CODE_AMBIGUOUS_APPLICATION, CODE_AMBIGUOUS_LOGIN, CODE_ANON_DISABLED, CODE_ARGS_MISSING, CODE_ATTRIBUTE_MISSING, CODE_CANNOT_DO, CODE_CLIENT_CONN_REJECTED, CODE_DATA_MISSING, CODE_DELETE_FAILED, CODE_DENIED, CODE_DOESNT_EXIST, CODE_EVAL_EXPIRED, CODE_EVENT_DEREGISTRATION, CODE_EVENT_FAILED, CODE_EXCEPTION, CODE_FAILED, CODE_FORWARD_ERROR, CODE_FORWARD_FAILED, CODE_FORWARD_TIMEOUT, CODE_GROUP_VALIDATION_FAILED, CODE_INCORRECT_CREDS, CODE_INVALID_ATTR, CODE_INVALID_COMBINATION, CODE_INVALID_DATA, CODE_INVALID_DYNAMIC_APP, CODE_INVALID_HOST, CODE_INVALID_SESSIONCOOKIE, CODE_INVALID_TYPE, CODE_INVALID_URNNAME, CODE_JOBS_NOT_FOUND, CODE_LAUNCH_FAILED, CODE_LIMIT_REACHED, CODE_LOGIN_FAILED, CODE_LOGIN_VETOED, CODE_LOGOUT_FAILED, CODE_MAX_SEARCHES, CODE_MAX_SESSIONS, CODE_MODE_NOT_SUPPORTED, CODE_MULTIPLE_POSSIBLE_HOSTS, CODE_NO_ACCESS, CODE_NO_ADAPTOR, CODE_NO_CMD_MATCH, CODE_NO_CONNECT, CODE_NO_CSO, CODE_NO_DEFINITION, CODE_NO_LICENSE, CODE_NO_MATCH, CODE_NO_OP_MATCH, CODE_NO_PRINTER, CODE_NO_RESPONSE, CODE_NO_RESUME, CODE_NO_SKID, CODE_NO_WRITE, CODE_NOT_IN_ARRAY, CODE_OBJECT_EXISTS, CODE_OBJECT_NOT_EMPTY, CODE_OBJECT_NOTEXIST, CODE_OBJECT_VALIDATION_FAILED, CODE_OPTIONAL_ARGS_MISSING, CODE_OVERRIDES_MISSING, CODE_PASSWORD_AGED, CODE_REDUCE_CPU, CODE_REQUEST_TOO_LARGE, CODE_RESPONSE_TOO_LARGE, CODE_SEARCH_FAILED, CODE_SEARCH_NOT_FOUND, CODE_SECURITY_REQ, CODE_SERVER_BUSY, CODE_SERVER_DISABLED, CODE_SESSION_NOT_EXIST, CODE_SESSION_NOT_FOUND, CODE_SESSION_NOT_IN_ARRAY, CODE_SKID_FAILED, CODE_SUSPEND_FAILED, CODE_UNKNOWNLOGIN, CODE_UPGRADE_SECURITY, CODE_USER_NOAUTH, CODE_USER_NOCTX, CODE_USER_NOFQ
 
Constructor Summary
SessionMonitor(java.lang.String sessionCookie, java.lang.String serverUrl, boolean allowServerLookup)
          Creates and registers a SessionMonitor.
 
Method Summary
 java.lang.String getSessionCookie()
          Gets the session cookie.
 java.lang.String getSessionId()
          Gets the session ID.
 boolean isSessionActive()
          Tests if the monitored session active by querying the server-side cache.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SessionMonitor

public SessionMonitor(java.lang.String sessionCookie,
                      java.lang.String serverUrl,
                      boolean allowServerLookup)
               throws TTAException
Creates and registers a SessionMonitor.

Parameters:
sessionCookie - the session to monitor
serverUrl - the location of the webserver in the format:
<scheme>://<hostname>[:<port>]

Note that the port only needs to be provided when using non-standard webserver ports. Standard ports (ie, 80 for HTTP and 443 for HTTPS) should not be provided.
allowServerLookup - true if server lookups are allowed when cache information is ambigous. False if server lookups are not allowed
Throws:
TTAException - if registration with the server failed. See IFaultCodes for a breakdown of the fault codes.
Method Detail

getSessionCookie

public java.lang.String getSessionCookie()
Gets the session cookie.

Returns:
the cookie of the session that is being monitored

getSessionId

public java.lang.String getSessionId()
Gets the session ID.

Returns:
the session ID of the session that is being monitored

isSessionActive

public boolean isSessionActive()
Tests if the monitored session active by querying the server-side cache.

Returns:
true if the session is active, false if not

Oracle Secure Global Desktop Web Services API Documentation
Release 4.7

E21396-02

Copyright © 2012, 2013, Oracle and/or its affiliates. All rights reserved.