org.csapi.jr.se.fw.fw_service.service_lifecycle
Interface ServiceInstanceLifecycleManager

All Superinterfaces:
CsapiInterface, java.io.Serializable

public interface ServiceInstanceLifecycleManager
extends CsapiInterface

The IpServiceInstanceLifecycleManager interface allows the Framework to create and destroy Service Manager Instances. This interface and the createServiceManager() and destroyServiceManager() methods shall be implemented by a Service.


Method Summary
 org.csapi.jr.se.Service createServiceManager(java.lang.String application, org.csapi.jr.se.fw.ServiceProperty[] serviceProperties, java.lang.String serviceInstanceID)
          This method returns a new service manager interface reference for the specified application.
 void destroyServiceManager(java.lang.String serviceInstance)
          This method destroys an existing service manager interface reference.
 

Method Detail

createServiceManager

public org.csapi.jr.se.Service createServiceManager(java.lang.String application,
                                                    org.csapi.jr.se.fw.ServiceProperty[] serviceProperties,
                                                    java.lang.String serviceInstanceID)
                                             throws CommonException,
                                                    InvalidPropertyException,
                                                    PlatformException
This method returns a new service manager interface reference for the specified application. The service instance will be configured for the client application using the properties agreed in the service level agreement. In case there is already a service manager available for the specified application and serviceInstanceID this reference is returned and no new service manager is created. Returns : Specifies the service manager interface reference for the specified application ID.

Parameters:
application - Specifies the application for which the service manager interface is requested.
serviceProperties - Specifies the service properties and their values that are to be used to configure the service instance. These properties form a part of the service level agreement. An example of these properties is a list of methods that the client application is allowed to invoke on the service interfaces.
serviceInstanceID - Specifies the Service Instance ID that the new Service Manager is to be identified by.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
InvalidPropertyException - The framework does not recognise the property supplied by the client
PlatformException - The implementation detected an internal (for example, communication) error

destroyServiceManager

public void destroyServiceManager(java.lang.String serviceInstance)
                           throws CommonException,
                                  PlatformException
This method destroys an existing service manager interface reference. This will result in the client application being unable to use the service manager any more.

Parameters:
serviceInstance - Identifies the Service Instance to be destroyed.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
PlatformException - The implementation detected an internal (for example, communication) error