HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.runtime.services
Interface IRuntimeService

All Superinterfaces:
IService

public interface IRuntimeService
extends IService

Class Name: IRuntimeService
Class Type:
Interface
Base Class:
IService
Intf Class:
None
Description:
Provides the runtime service interface.


Field Summary
static String CLASSNAME
          The fully-qualified name of this class.
static String COPYRIGHT
          The HATSCopyright.COPYRIGHT field will be updated each release, thereby "magically" updating this class file.
 
Method Summary
 boolean createApplicationInstance(String clientId, String applicationId, String viewId, IRequest request, Hashtable appOverrides)
          Create an instance of an application for the specified client ID.
 com.ibm.hats.runtime.AppManager getApplicationManager()
          Returns the default AppManager instance.
 List getApplications()
          Returns a list of Application objects representing all applications in the environment.
 Hashtable getAppOverrides(IRequest request, IResponse response, IContext context, com.ibm.hats.common.Application app)
          Get the application overrides.
 com.ibm.hats.runtime.ClientContainer getClientContainer()
          Returns the default ClientContainer instance for the runtime.
 com.ibm.hats.runtime.connmgr.ConnMgr getConnectionManager()
          Returns the default ConnMgr instance.
 void processInitialRequest(IRequest request, IResponse response)
          Process the user's initial request.
 void processRequest(IRequest request, IResponse response)
          Process the user's request.
 int start(IConfig config)
          Start the HATS runtime with the specified properties contained within the configuration object.
 int stop()
          The stop method used to stop the HATS runtime.
 
Methods inherited from interface com.ibm.hats.runtime.services.IService
getServiceManager
 

Field Detail

COPYRIGHT

static final String COPYRIGHT
The HATSCopyright.COPYRIGHT field will be updated each release, thereby "magically" updating this class file.

See Also:
Constant Field Values

CLASSNAME

static final String CLASSNAME
The fully-qualified name of this class. This is used for controlling and displaying traces.

Method Detail

createApplicationInstance

boolean createApplicationInstance(String clientId,
                                  String applicationId,
                                  String viewId,
                                  IRequest request,
                                  Hashtable appOverrides)
Create an instance of an application for the specified client ID. If the specified client ID does not exist, then a client session is created prior to creating the application instance for that client ID.

Note: The applicationId and the viewId are joined together to form a unique application identification tag for RCP HATS. For Web HATS, the viewId is null

Parameters:
clientId - This value corresponds to the httpSessionId for Web HATS and a fixed Id for RCP HATS. This value cannot be null.
applicationId - The application ID which is effectively the application name. This value cannot be null.
viewId - The view ID which is a separate ID for each unique instance of the application name (applicationId) for RCP HATS. This value must be null for Web HATS.
request - The request on whose behalf this application is being created.
appOverrides - The application overrides.
Returns:
Returns true if an application instance (with its corresponding client session if necessary) was created successfully, false otherwise.

getApplications

List getApplications()
Returns a list of Application objects representing all applications in the environment.

Returns:
Returns a List of applicatoin objects.

getApplicationManager

com.ibm.hats.runtime.AppManager getApplicationManager()
Returns the default AppManager instance.

Returns:
An instance of the application manager.

getClientContainer

com.ibm.hats.runtime.ClientContainer getClientContainer()
Returns the default ClientContainer instance for the runtime.

Returns:
An instance of the client container.

getConnectionManager

com.ibm.hats.runtime.connmgr.ConnMgr getConnectionManager()
Returns the default ConnMgr instance.

Returns:
The instance of the connection manager.
See Also:
IRuntimeService.getConnectionManager()

processInitialRequest

void processInitialRequest(IRequest request,
                           IResponse response)
Process the user's initial request. In general, the user has updated an input field which corresponds to input data on the host screen, and/or the user has pressed a button representing a host function key.

Parameters:
request - The request.
response - The response.

processRequest

void processRequest(IRequest request,
                    IResponse response)
Process the user's request. In general, the user has updated an input field which corresponds to input data on the host screen, and/or the user has pressed a button representing a host function key. Use the servlet object xmlLegacyProcess to send the new screen to the host, and to retreive the resulting screen from the host.

Parameters:
request - The request.
response - The response.

start

int start(IConfig config)
Start the HATS runtime with the specified properties contained within the configuration object.

Parameters:
config - The configuration containing the default initialization properties used in starting the service.
Returns:
The status of the start operation.

stop

int stop()
The stop method used to stop the HATS runtime. Allows up to 30 seconds for all registered session services to shutdown before shutting down the runtime.

Returns:
The status of the stop operation. Indicates the approximate time in seconds that elapsed before all of the registered session services shutdown.

getAppOverrides

Hashtable getAppOverrides(IRequest request,
                          IResponse response,
                          IContext context,
                          com.ibm.hats.common.Application app)
Get the application overrides.

This method checks to see whether prompting the user is necessary. If so, it fires the event to prompt the user and returns null.

Parameters:
request - The request.
response - The response.
context - The context.
app - The application.
Returns:
The application overrides or null.

HATS 7.5.1 (201005110649)