|
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 IServiceManager
Class Name: IServiceManager Provides the service interface for the service manager.
Class Type: Interface
Base Class: None
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 | |
|---|---|
void |
addServiceManagerListener(com.ibm.hats.runtime.events.ServiceManagerListener listener)
Adds a service manager listener. |
IApplicationService |
getApplicationService(String applicationId)
Factory method which returns the specified application service or creates one and returns it if none exists. |
IClientService |
getClientService(String clientId)
Factory method which returns the specified client service or creates one and returns it if none exists. |
IRuntimeService |
getRuntimeService()
Factory method which returns the current runtime service or creates one and returns it if none exists. |
int |
getServiceEntryCount(com.ibm.hats.runtime.services.ServiceType service)
Retrieve the current number of services registered in the specified service Map. |
Set |
getServiceIDs(com.ibm.hats.runtime.services.ServiceType service)
Retrieve the service IDs of the currently registered services in the specified service Map. |
ISessionService |
getSessionService(String clientId,
String applicationId,
String viewId)
Factory method which returns the specified session service or creates one and returns it if none exists. |
boolean |
isApplicationServiceValid(String applicationId)
Checks to determine if an application service has already been created for the specified ID. |
boolean |
isClientServiceValid(String clientId)
Checks to determine if a client service has already been created for the specified ID. |
boolean |
isRuntimeServiceValid()
Checks to determine if the runtime service has already been created. |
boolean |
isServiceMapEmpty(com.ibm.hats.runtime.services.ServiceType service)
Check the specified service Map for entries. |
boolean |
isSessionServiceValid(String clientId,
String applicationId,
String viewId)
Checks to determine if a session service has already been created for the specified ID. |
void |
removeApplicationService(String applicationId)
Removes the application service specified by the application ID. |
void |
removeClientService(String clientId)
Removes the client service specified by the client ID. |
void |
removeRuntimeService()
Removes the runtime service. |
void |
removeServiceManagerListener(com.ibm.hats.runtime.events.ServiceManagerListener listener)
Removes a service manager listener. |
void |
removeSessionService(String clientId,
String applicationId,
String viewId)
Removes the session service specified by the view Instance ID for the application specified by the application ID. |
Collection |
retrieveServiceEntries(com.ibm.hats.runtime.services.ServiceType service)
Retrieve the current registered services in the specified service Map. |
| Field Detail |
|---|
static final String CLASSNAME
static final String COPYRIGHT
| Method Detail |
|---|
void addServiceManagerListener(com.ibm.hats.runtime.events.ServiceManagerListener listener)
listener - The service manager listener to be added.IApplicationService getApplicationService(String applicationId)
applicationId - The application ID. This ID corresponds to the application name and identifies a unique
application. If this parameter is null or invalid, an exception is logged and null is
returned.
IClientService getClientService(String clientId)
clientId - The client ID specifies a unique client service and therefore, a unique Client Specific
Information object. If this parameter is null or invalid, an exception is logged and null is
returned.
IRuntimeService getRuntimeService()
int getServiceEntryCount(com.ibm.hats.runtime.services.ServiceType service)
service - The specified ServiceType ( APPLICATION, CLIENT, RUNTIME, SESSION ).
Set getServiceIDs(com.ibm.hats.runtime.services.ServiceType service)
service - The specified ServiceType ( APPLICATION, CLIENT, RUNTIME, SESSION ).
ISessionService getSessionService(String clientId,
String applicationId,
String viewId)
clientId - The client ID specifies a unique client service and therefore, a unique
Client Specific Information object.applicationId - The application ID of the application. This corresponds to the application name and
identifies a unique application.viewId - The view ID is used to uniquely identify a view and therefore represents an
application instance.
boolean isApplicationServiceValid(String applicationId)
applicationId - The application ID. This ID corresponds to the application name and identifies a unique
application. If this parameter is null or invalid, an exception is logged and
false is returned.
boolean isClientServiceValid(String clientId)
clientId - The client ID specifies a unique client service and therefore, a unique Client Specific
Information object. If this parameter is null or invalid, an exception is logged and
false is returned.
boolean isRuntimeServiceValid()
boolean isServiceMapEmpty(com.ibm.hats.runtime.services.ServiceType service)
service - The specified ServiceType ( APPLICATION, CLIENT, RUNTIME, SESSION ).
boolean isSessionServiceValid(String clientId,
String applicationId,
String viewId)
clientId - The client ID specifies a unique client service and therefore, a unique
Client Specific Information object.applicationId - The application ID of the application. This corresponds to the application name and
identifies a unique application.viewId - The view ID is used to uniquely identify a view and therefore represents an
application instance.
void removeApplicationService(String applicationId)
applicationId - The application ID. This ID corresponds to the application name and identifies a
unique application. If this parameter is null or invalid, an exception is logged and
false is returned.void removeClientService(String clientId)
clientId - The client ID specifies a unique client service and therefore, a unique Client Specific
Information object. If this parameter is null or invalid, an exception is logged and
false is returned.void removeRuntimeService()
void removeServiceManagerListener(com.ibm.hats.runtime.events.ServiceManagerListener listener)
listener - The service manager listener to be removed.
void removeSessionService(String clientId,
String applicationId,
String viewId)
clientId - The client ID specifies a unique client service and therefore, a unique
Client Specific Information object.applicationId - The application ID of the application. This corresponds to the application name and
identifies a unique application.viewId - The view ID is used to uniquely identify a view and therefore represents an
application instance.Collection retrieveServiceEntries(com.ibm.hats.runtime.services.ServiceType service)
service - The specified ServiceType ( APPLICATION, CLIENT, RUNTIME, SESSION ).
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||