|
HATS 7.5.1 Web API ReferencePublicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product. |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface IRuntimeService
Class Name: IRuntimeService Provides the runtime service interface.
Class Type: Interface
Base Class: IService
Intf Class: None
Description:
| 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 |
|---|
static final String COPYRIGHT
static final String CLASSNAME
| Method Detail |
|---|
boolean createApplicationInstance(String clientId,
String applicationId,
String viewId,
IRequest request,
Hashtable appOverrides)
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
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.
true if an application instance (with its corresponding client session if necessary)
was created successfully, false otherwise.List getApplications()
Application objects representing all applications in the environment.
com.ibm.hats.runtime.AppManager getApplicationManager()
AppManager instance.
com.ibm.hats.runtime.ClientContainer getClientContainer()
ClientContainer instance for the runtime.
com.ibm.hats.runtime.connmgr.ConnMgr getConnectionManager()
ConnMgr instance.
IRuntimeService.getConnectionManager()
void processInitialRequest(IRequest request,
IResponse response)
request - The request.response - The response.
void processRequest(IRequest request,
IResponse response)
request - The request.response - The response.int start(IConfig config)
config - The configuration containing the default initialization properties used in starting the service.
int stop()
Hashtable getAppOverrides(IRequest request,
IResponse response,
IContext context,
com.ibm.hats.common.Application app)
This method checks to see whether prompting the user is necessary. If so, it fires the event to prompt the user and returns null.
request - The request.response - The response.context - The context.app - The application.
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||