Oracle Secure Global Desktop Web Services API Documentation
Release 4.7

E21396-02

com.tarantella.tta.webservices
Interface IConstants

All Known Implementing Classes:
SessionMonitor

public interface IConstants

Definition of non-schema constants that might be needed by a SOAP client.


Field Summary
static java.lang.String ACTION_OBJECT_CREATED
          The event action is application assigned or print job created.
static java.lang.String ACTION_OBJECT_DELETED
          The event action is application assigned or print job deleted.
static java.lang.String ACTION_OBJECT_DISABLED
          The event action is assigned application disabled.
static java.lang.String ACTION_OBJECT_ENABLED
          The event action is assigned application enabled.
static java.lang.String ACTION_SESSION_ADDED
          The event action is application session added.
static java.lang.String ACTION_SESSION_CHANGED
          The event action is application session changed.
static java.lang.String ACTION_SESSION_REMOVED
          The event action is application session removed.
static java.lang.String ACTION_VIEW_REFRESH
          The event action is assigned applications or application session view refreshed.
static java.lang.String ALL_ATTRS
          This value requests that all attributes are retrieved.
static java.lang.String ALL_PREFERENCES
          This value requests that all user preferences are retrieved.
static java.lang.String APPLAUNCH_DELAY
          This value sets the time an application launch should be delayed to wait for a service launch to complete.
static java.lang.String APPLICATION_ATTRS
          Short-cut to retrieve attributes set by the application.
static java.lang.String APPLICATION_OBJECTS
          The name of the applications organization.
static java.lang.String APPSERVER_OBJECTS
          The name of the application servers organization.
static java.lang.String ARRAY_MASTER
          This value indicates the name of the primary server in this array
static java.lang.String AUTOMATIC_LOGOUT
          Attribute used to specify the desired behaviour for automatic logouts.
static java.lang.String AUTOMATIC_LOGOUT_CLOSED
          This value indicates the user session should be automatically logged out when the last application session is closed.
static java.lang.String AUTOMATIC_LOGOUT_EVT
          Name of the Automatic logout event.
static java.lang.String AUTOMATIC_LOGOUT_SUSPENDED
          This value indicates the user session should be automatically logged out when all application sessions are suspended.
static java.lang.String CLIENT_ATTRS
          Short-cut to retrieve attributes describing the client device, sent by the SGD Client.
static java.lang.String CONNECTION_ATTRS
          Short-cut to retrieve attributes relating to the connection between SGD Client and SGD server.
static java.lang.String CONNECTION_LOST_EVT
          Name of the Connection gone event.
static java.lang.String DEFAULT
          The value indicating that client-side messages should be sent to the default SGD Client Helper.
static java.lang.String DEPTH_ONELEVEL
          This value restricts the depth of searches to one-level.
static java.lang.String DEPTH_SUBTREE
          This value allows searches to traverse the sub-tree.
static java.lang.String EVT_ACTION
          Name of attribute containing the event action.
static java.lang.String EVT_AUTHSTATUS
          Name of attribute containing the authentication connection status.
static java.lang.String EVT_DATA
          Name of attribute containing the event data.
static java.lang.String EVT_EVENT
          Wrapper element for events
static java.lang.String EVT_NAME
          Name of attribute containing the event name.
static java.lang.String EVT_REFRESH
          Value sent in event data to indicate the frame must be refreshed.
static java.lang.String EVT_SERVERID
          Name of attribute containing the Server ID
static java.lang.String EVT_TCCSTATUS
          Name of attribute containing the SGD Client connection status.
static java.lang.String GRAB_EVT
          Name of the user session grab event.
static java.lang.String LOCAL_ATTRS
          Short-cut to retrieve attributes on application sessions that are readily available.
static java.lang.String LOCAL_BROWSER
          Deprecated.  
static java.lang.String LOGGED_OUT_EVT
          Name of the user session logged-out event.
static java.lang.String MODE_APPENDATTR
          Append the named attributes to those already stored.
static java.lang.String MODE_DIVIDER
          Divider for the store-mode string, e.g.
static java.lang.String MODE_REMOVEATTR
          Remove the named attributes and values.
static java.lang.String MODE_REPLACEALLATTR
          Remove all existing attributes and replace with named attributes and values.
static java.lang.String MODE_REPLACEATTR
          Replace the named attributes with new values.
static java.lang.String MULTIPLE_QUERYSTRING_SERVER
          Application launch-time option to specify the preferred host to launch on when multiple querystrings match the user.
static java.lang.String NO_CLIENT_PRINTER
          The value indicating that there is no client printer.
static java.lang.String OPTION_BASEURL
          Application launch-time option to supply a base URL for document launches.
static java.lang.String OPTION_BROWSER
          Application launch-time option to select the browser to host documents.
static java.lang.String OPTION_DYNAMIC
          Application launch-time prefix for dynamic launch
static java.lang.String OPTION_DYNAMIC_APP_TYPE
          Application launch-time option for os/type for a dynamic application
static java.lang.String OPTION_DYNAMIC_PERMANENT_ENS
          Application launch-time option to create a permanent ens host object
static java.lang.String OPTION_DYNAMIC_PERMANENT_NAME
          Application launch-time option for name of permanent ens host object
static java.lang.String OPTION_DYNAMIC_SERVER
          Application launch-time option for ip address of the host
static java.lang.String OPTION_DYNAMIC_SERVER_PORT
          Application launch-time option for port to connect to host on
static java.lang.String OPTION_FORCE_AUTHENTICATION
          Application launch-time option to force application server authentication.
static java.lang.String OPTION_FORCE_VSB_AUTHENTICATION
          Application launch-time option to force Virtual Server Broker authentication.
static java.lang.String OPTION_FQN
          Application launch-time option to restrict launches to API calls that supply the fully-qualified application name.
static java.lang.String OPTION_MAY_RESUME
          Application launch-time option to allow resumption of an existing application session rather than starting a new instance.
static java.lang.String OPTION_SESSION_NAME
          Application launch-time option to set an arbitrary session name.
static java.lang.String OPTION_TOGGLE_DISPLAY
          Deprecated.  
static java.lang.String PAUSED
          The value indicating that the client print queue is paused.
static java.lang.String PERMANENT
          This value requests permanent connections to server-side event listeners.
static java.lang.String PRINT_EVT
          Name of the print job event.
static java.lang.String PROFILE_ATTRS
          Short-cut to retrieve profile attributes.
static java.lang.String PROFILE_EVT
          Name of the Profile event.
static java.lang.String REAL_HOSTS
          Parameter to retrieve real hosts of applications.
static java.lang.String REFRESH_STATE
          Indicates that the state of the user session should be refreshed.
static java.lang.String REMOTE_BROWSER
          Document should be displayed in a remote browser.
static java.lang.String RESTART_EVT
          Name of the server restart event.
static java.lang.String RESUMED
          The value indicating that the client print queue is resumed.
static java.lang.String SAME_BROWSER
          Deprecated.  
static java.lang.String SERVER_ATTRS
          Short-cut to retrieve attributes set by the SGD server.
static java.lang.String SESSION_CHANGED_EVT
          Name of the application session changed event.
static java.lang.String SESSION_EVT
          Name of the application session event.
static java.lang.String STORE_APPLICATION
          Store for application attributes.
static java.lang.String STORE_CLIENT
          Store for client device attributes.
static java.lang.String STORE_CONNECTION
          Store for connection attributes.
static java.lang.String STORE_PROFILE
          Store for profile attributes.
static java.lang.String STORE_SERVER
          Store for server attributes.
static java.lang.String SYSTEM_OBJECTS
          The name of the Tarantella System Objects organization.
static java.lang.String TCC_EVT
          Name of the SGD Client event.
static java.lang.String THIRD_PARTY_PROFILE
          Value indicating that the user is logged-in via a third-party profile.
static java.lang.String TOKEN
          Token supplied when SGD Client starts first.
static java.lang.String TOP
          The value to request the retrieval of top level assigned application groups.
static java.lang.String TRANSIENT
          This value requests transient connections to server-side event listeners.
static java.lang.String UNIX_USER_PROFILE
          Value indicating that the user is logged-in via a UNIX user profile.
static java.lang.String VSB_CLASS_NAME_PARAM
          The parameter name used to specify the VSB Class to use in web.xml
static java.lang.String VSB_INIT_PARAM_PREFIX
          The prefix used to specify that a web.xml parameter is a VSB initialisation parameter.
static java.lang.String WEBTOP_CHANGED_EVT
          Name of the assigned applications changed event.
static java.lang.String WEBTOP_STATE_EVT
          Name of the assigned applications state changed event.
static java.lang.String WEBTOPSESSION_CHANGED_EVT
          Name of the user session event.
static java.lang.String WEBTOPSESSION_EVT
          Name of the user session event.
 

Field Detail

WEBTOP_CHANGED_EVT

static final java.lang.String WEBTOP_CHANGED_EVT
Name of the assigned applications changed event. This event is fired when applications are assigned or removed.

See Also:
Constant Field Values

WEBTOP_STATE_EVT

static final java.lang.String WEBTOP_STATE_EVT
Name of the assigned applications state changed event. This event is fired when applications are enabled or disabled.

See Also:
Constant Field Values

SESSION_EVT

static final java.lang.String SESSION_EVT
Name of the application session event. This event is fired when application sessions are added or removed.

See Also:
Constant Field Values

WEBTOPSESSION_EVT

static final java.lang.String WEBTOPSESSION_EVT
Name of the user session event. This event is fired when user sessions are added or removed.

See Also:
Constant Field Values

SESSION_CHANGED_EVT

static final java.lang.String SESSION_CHANGED_EVT
Name of the application session changed event. This event would be fired when application sessions are suspended or resumed. Currently not used.

See Also:
Constant Field Values

WEBTOPSESSION_CHANGED_EVT

static final java.lang.String WEBTOPSESSION_CHANGED_EVT
Name of the user session event. This event is fired when user sessions are changed.

See Also:
Constant Field Values

PRINT_EVT

static final java.lang.String PRINT_EVT
Name of the print job event. This event is fired when print jobs are added or removed.

See Also:
Constant Field Values

RESTART_EVT

static final java.lang.String RESTART_EVT
Name of the server restart event. This event is fired when the server restarts.

See Also:
Constant Field Values

GRAB_EVT

static final java.lang.String GRAB_EVT
Name of the user session grab event. This event is fired when user sessions are grabbed.

See Also:
Constant Field Values

LOGGED_OUT_EVT

static final java.lang.String LOGGED_OUT_EVT
Name of the user session logged-out event. This event is fired when user sessions are logged-out.

See Also:
Constant Field Values

TCC_EVT

static final java.lang.String TCC_EVT
Name of the SGD Client event. This event is fired when the status of the SGD Client connection changes.

See Also:
Constant Field Values

CONNECTION_LOST_EVT

static final java.lang.String CONNECTION_LOST_EVT
Name of the Connection gone event. This event is fired when the client loses its connection.

See Also:
Constant Field Values

PROFILE_EVT

static final java.lang.String PROFILE_EVT
Name of the Profile event. This event is fired by the Profile Editor when a profile is modified.

See Also:
Constant Field Values

AUTOMATIC_LOGOUT_EVT

static final java.lang.String AUTOMATIC_LOGOUT_EVT
Name of the Automatic logout event. This event is fired when all the application sessions reach a pre-defined state.

See Also:
Constant Field Values

EVT_NAME

static final java.lang.String EVT_NAME
Name of attribute containing the event name.

See Also:
Constant Field Values

EVT_ACTION

static final java.lang.String EVT_ACTION
Name of attribute containing the event action.

See Also:
Constant Field Values

EVT_DATA

static final java.lang.String EVT_DATA
Name of attribute containing the event data.

See Also:
Constant Field Values

EVT_REFRESH

static final java.lang.String EVT_REFRESH
Value sent in event data to indicate the frame must be refreshed.

See Also:
Constant Field Values

EVT_TCCSTATUS

static final java.lang.String EVT_TCCSTATUS
Name of attribute containing the SGD Client connection status.

See Also:
Constant Field Values

EVT_AUTHSTATUS

static final java.lang.String EVT_AUTHSTATUS
Name of attribute containing the authentication connection status.

See Also:
Constant Field Values

EVT_SERVERID

static final java.lang.String EVT_SERVERID
Name of attribute containing the Server ID

See Also:
Constant Field Values

EVT_EVENT

static final java.lang.String EVT_EVENT
Wrapper element for events

See Also:
Constant Field Values

ACTION_SESSION_CHANGED

static final java.lang.String ACTION_SESSION_CHANGED
The event action is application session changed.

See Also:
Constant Field Values

ACTION_SESSION_ADDED

static final java.lang.String ACTION_SESSION_ADDED
The event action is application session added.

See Also:
Constant Field Values

ACTION_SESSION_REMOVED

static final java.lang.String ACTION_SESSION_REMOVED
The event action is application session removed.

See Also:
Constant Field Values

ACTION_OBJECT_CREATED

static final java.lang.String ACTION_OBJECT_CREATED
The event action is application assigned or print job created.

See Also:
Constant Field Values

ACTION_OBJECT_DELETED

static final java.lang.String ACTION_OBJECT_DELETED
The event action is application assigned or print job deleted.

See Also:
Constant Field Values

ACTION_OBJECT_ENABLED

static final java.lang.String ACTION_OBJECT_ENABLED
The event action is assigned application enabled.

See Also:
Constant Field Values

ACTION_OBJECT_DISABLED

static final java.lang.String ACTION_OBJECT_DISABLED
The event action is assigned application disabled.

See Also:
Constant Field Values

ACTION_VIEW_REFRESH

static final java.lang.String ACTION_VIEW_REFRESH
The event action is assigned applications or application session view refreshed.

See Also:
Constant Field Values

MODE_APPENDATTR

static final java.lang.String MODE_APPENDATTR
Append the named attributes to those already stored.

See Also:
Constant Field Values

MODE_REPLACEATTR

static final java.lang.String MODE_REPLACEATTR
Replace the named attributes with new values.

See Also:
Constant Field Values

MODE_REMOVEATTR

static final java.lang.String MODE_REMOVEATTR
Remove the named attributes and values.

See Also:
Constant Field Values

MODE_REPLACEALLATTR

static final java.lang.String MODE_REPLACEALLATTR
Remove all existing attributes and replace with named attributes and values.

See Also:
Constant Field Values

STORE_APPLICATION

static final java.lang.String STORE_APPLICATION
Store for application attributes.

See Also:
Constant Field Values

STORE_PROFILE

static final java.lang.String STORE_PROFILE
Store for profile attributes.

See Also:
Constant Field Values

STORE_CONNECTION

static final java.lang.String STORE_CONNECTION
Store for connection attributes.

See Also:
Constant Field Values

STORE_CLIENT

static final java.lang.String STORE_CLIENT
Store for client device attributes.

See Also:
Constant Field Values

STORE_SERVER

static final java.lang.String STORE_SERVER
Store for server attributes.

See Also:
Constant Field Values

MODE_DIVIDER

static final java.lang.String MODE_DIVIDER
Divider for the store-mode string, e.g. [store:]mode.

See Also:
Constant Field Values

DEPTH_ONELEVEL

static final java.lang.String DEPTH_ONELEVEL
This value restricts the depth of searches to one-level.

See Also:
Constant Field Values

DEPTH_SUBTREE

static final java.lang.String DEPTH_SUBTREE
This value allows searches to traverse the sub-tree.

See Also:
Constant Field Values

TOP

static final java.lang.String TOP
The value to request the retrieval of top level assigned application groups.

See Also:
Constant Field Values

DEFAULT

static final java.lang.String DEFAULT
The value indicating that client-side messages should be sent to the default SGD Client Helper.

See Also:
Constant Field Values

PERMANENT

static final java.lang.String PERMANENT
This value requests permanent connections to server-side event listeners.

See Also:
Constant Field Values

TRANSIENT

static final java.lang.String TRANSIENT
This value requests transient connections to server-side event listeners.

See Also:
Constant Field Values

PAUSED

static final java.lang.String PAUSED
The value indicating that the client print queue is paused.

See Also:
Constant Field Values

NO_CLIENT_PRINTER

static final java.lang.String NO_CLIENT_PRINTER
The value indicating that there is no client printer.

See Also:
Constant Field Values

RESUMED

static final java.lang.String RESUMED
The value indicating that the client print queue is resumed.

See Also:
Constant Field Values

APPLICATION_ATTRS

static final java.lang.String APPLICATION_ATTRS
Short-cut to retrieve attributes set by the application.

See Also:
Constant Field Values

CLIENT_ATTRS

static final java.lang.String CLIENT_ATTRS
Short-cut to retrieve attributes describing the client device, sent by the SGD Client.

See Also:
Constant Field Values

CONNECTION_ATTRS

static final java.lang.String CONNECTION_ATTRS
Short-cut to retrieve attributes relating to the connection between SGD Client and SGD server.

See Also:
Constant Field Values

SERVER_ATTRS

static final java.lang.String SERVER_ATTRS
Short-cut to retrieve attributes set by the SGD server.

See Also:
Constant Field Values

PROFILE_ATTRS

static final java.lang.String PROFILE_ATTRS
Short-cut to retrieve profile attributes.

See Also:
Constant Field Values

LOCAL_ATTRS

static final java.lang.String LOCAL_ATTRS
Short-cut to retrieve attributes on application sessions that are readily available.

See Also:
Constant Field Values

REAL_HOSTS

static final java.lang.String REAL_HOSTS
Parameter to retrieve real hosts of applications.

See Also:
Constant Field Values

OPTION_BROWSER

static final java.lang.String OPTION_BROWSER
Application launch-time option to select the browser to host documents.

See Also:
Constant Field Values

OPTION_FORCE_AUTHENTICATION

static final java.lang.String OPTION_FORCE_AUTHENTICATION
Application launch-time option to force application server authentication.

See Also:
Constant Field Values

OPTION_FORCE_VSB_AUTHENTICATION

static final java.lang.String OPTION_FORCE_VSB_AUTHENTICATION
Application launch-time option to force Virtual Server Broker authentication.

See Also:
Constant Field Values

OPTION_FQN

static final java.lang.String OPTION_FQN
Application launch-time option to restrict launches to API calls that supply the fully-qualified application name. Restricting launches to fully qualified names can improve performance.

See Also:
Constant Field Values

OPTION_MAY_RESUME

static final java.lang.String OPTION_MAY_RESUME
Application launch-time option to allow resumption of an existing application session rather than starting a new instance.

See Also:
Constant Field Values

OPTION_SESSION_NAME

static final java.lang.String OPTION_SESSION_NAME
Application launch-time option to set an arbitrary session name.

See Also:
Constant Field Values

OPTION_TOGGLE_DISPLAY

static final java.lang.String OPTION_TOGGLE_DISPLAY
Deprecated. 
Application launch-time option to switch application placement.

See Also:
Constant Field Values

OPTION_BASEURL

static final java.lang.String OPTION_BASEURL
Application launch-time option to supply a base URL for document launches.

See Also:
Constant Field Values

UNIX_USER_PROFILE

static final java.lang.String UNIX_USER_PROFILE
Value indicating that the user is logged-in via a UNIX user profile.

See Also:
Constant Field Values

THIRD_PARTY_PROFILE

static final java.lang.String THIRD_PARTY_PROFILE
Value indicating that the user is logged-in via a third-party profile.

See Also:
Constant Field Values

SYSTEM_OBJECTS

static final java.lang.String SYSTEM_OBJECTS
The name of the Tarantella System Objects organization.

See Also:
Constant Field Values

APPLICATION_OBJECTS

static final java.lang.String APPLICATION_OBJECTS
The name of the applications organization.

See Also:
Constant Field Values

APPSERVER_OBJECTS

static final java.lang.String APPSERVER_OBJECTS
The name of the application servers organization.

See Also:
Constant Field Values

TOKEN

static final java.lang.String TOKEN
Token supplied when SGD Client starts first.

See Also:
Constant Field Values

REFRESH_STATE

static final java.lang.String REFRESH_STATE
Indicates that the state of the user session should be refreshed.

See Also:
Constant Field Values

SAME_BROWSER

static final java.lang.String SAME_BROWSER
Deprecated. 
Application session or document should be placed on the standard frameset.

See Also:
Constant Field Values

LOCAL_BROWSER

static final java.lang.String LOCAL_BROWSER
Deprecated. 
Application session or document should be placed in a new browser window.

See Also:
Constant Field Values

REMOTE_BROWSER

static final java.lang.String REMOTE_BROWSER
Document should be displayed in a remote browser.

See Also:
Constant Field Values

ALL_ATTRS

static final java.lang.String ALL_ATTRS
This value requests that all attributes are retrieved.

See Also:
Constant Field Values

ALL_PREFERENCES

static final java.lang.String ALL_PREFERENCES
This value requests that all user preferences are retrieved.

See Also:
Constant Field Values

AUTOMATIC_LOGOUT

static final java.lang.String AUTOMATIC_LOGOUT
Attribute used to specify the desired behaviour for automatic logouts.

See Also:
Constant Field Values

AUTOMATIC_LOGOUT_SUSPENDED

static final java.lang.String AUTOMATIC_LOGOUT_SUSPENDED
This value indicates the user session should be automatically logged out when all application sessions are suspended.

See Also:
Constant Field Values

AUTOMATIC_LOGOUT_CLOSED

static final java.lang.String AUTOMATIC_LOGOUT_CLOSED
This value indicates the user session should be automatically logged out when the last application session is closed.

See Also:
Constant Field Values

APPLAUNCH_DELAY

static final java.lang.String APPLAUNCH_DELAY
This value sets the time an application launch should be delayed to wait for a service launch to complete.

See Also:
Constant Field Values

ARRAY_MASTER

static final java.lang.String ARRAY_MASTER
This value indicates the name of the primary server in this array

See Also:
Constant Field Values

OPTION_DYNAMIC

static final java.lang.String OPTION_DYNAMIC
Application launch-time prefix for dynamic launch

See Also:
Constant Field Values

OPTION_DYNAMIC_SERVER

static final java.lang.String OPTION_DYNAMIC_SERVER
Application launch-time option for ip address of the host

See Also:
Constant Field Values

OPTION_DYNAMIC_SERVER_PORT

static final java.lang.String OPTION_DYNAMIC_SERVER_PORT
Application launch-time option for port to connect to host on

See Also:
Constant Field Values

OPTION_DYNAMIC_PERMANENT_ENS

static final java.lang.String OPTION_DYNAMIC_PERMANENT_ENS
Application launch-time option to create a permanent ens host object

See Also:
Constant Field Values

OPTION_DYNAMIC_PERMANENT_NAME

static final java.lang.String OPTION_DYNAMIC_PERMANENT_NAME
Application launch-time option for name of permanent ens host object

See Also:
Constant Field Values

OPTION_DYNAMIC_APP_TYPE

static final java.lang.String OPTION_DYNAMIC_APP_TYPE
Application launch-time option for os/type for a dynamic application

See Also:
Constant Field Values

MULTIPLE_QUERYSTRING_SERVER

static final java.lang.String MULTIPLE_QUERYSTRING_SERVER
Application launch-time option to specify the preferred host to launch on when multiple querystrings match the user.

See Also:
Constant Field Values

VSB_CLASS_NAME_PARAM

static final java.lang.String VSB_CLASS_NAME_PARAM
The parameter name used to specify the VSB Class to use in web.xml

See Also:
Constant Field Values

VSB_INIT_PARAM_PREFIX

static final java.lang.String VSB_INIT_PARAM_PREFIX
The prefix used to specify that a web.xml parameter is a VSB initialisation parameter.

See Also:
Constant Field Values

Oracle Secure Global Desktop Web Services API Documentation
Release 4.7

E21396-02

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