Visit Platform at http://www.platform.com

ServiceControllerService

Operation: CreateService The operation createService is used to create a new service according to a service definition. EGO will verify the service definition and decide whether to accept or reject it. The EGO will also save it into its service definition database and manage the lifecycle of the newly created service.
Input Message

The request to create a service has the following sub-elements:

  • ServiceName - the name of the service user want to create.
  • Description - the readable description for the service.
  • MaxInstances - the maximum number of service instances. The system will not instantiate more than maximum number of service instances.
  • MinInstances - the minimun number of service instances the system should keep running.
  • ActivityDescription - the activity description of the service.
  • AllocationSpecification - the allocation specificaton of the service.
  • ControlPolicy - the parameters which describe the lifecycle of the service.

Output Message

The response message is an empty element tag.


Operation: UpdateService The operation updateservice is used to update a existing service according to a service definition.
Input Message

The request to update a service has the following sub-elements:

  • ServiceName - the name of the service user want to create.
  • Description - the readable description for the service.
  • MaxInstances - the maximum number of service instances. The system will not instantiate more than maximum number of service instances.
  • MinInstances - the minimun number of service instances the system should keep running.
  • ActivityDescription - the activity description of the service.
  • AllocationSpecification - the allocation specificaton of the service.
  • ControlPolicy - the parameters which describe the lifecycle of the service.
Output Message

The response message is an empty element tag.


Operation: RemoveService The removeservice operation is used to remove an existing service. EGO will disable the existing service, destroy the service object and remove the service definition from configuration.
Input Message

The request to remove a service has the following sub-elements:

  • ServiceName - the name of the service user want to create.

Output Message

The response message is an empty element tag.


Operation: QueryService The operation queryservice is used to get information about the existing service, including service configuration, service runtime and service instance runtime.
Input Message

The request to query a service has the following sub-elements:

  • ServiceName - the name of service. If no name given, EGO will supply information of all existing.

Output Message

The response message for queryservicerequest has the following sub-element;

  • ServiceDefinition - the definition of the service.
  • ServiceState - the current state of the service.
  • ServiceAllocationInfo - the allocation information of the service.
  • NumServiceInstances - the instance number of the service.
  • ServiceInstanceInfo - the detail information of service instance.


Operation: ControlService This operation controlservice is used to control an existing service.
Input Message

The request to control a service has the following sub-elements:

  • ServiceName - the name of the service.
  • ServiceControlOperation - the control operation to the specify existing service.

Output Message

The response message is an empty element tag.


Operation: ControlServiceInstance The operation controlserviceinstance is used to control an instance of existing services.
Input Message

The request to control a service instance has the following sub-elements:

  • ServiceName - the name of the service. If no given service name, the operation is for all services.
  • InstanceSequenceId - the sequence number of the service instance.
  • ServiceInstanceControlOperation - the control operation to the instance of specified existing service. Currently, only "stop" operation is supported.
  • OptionArray - a optional element one of RELEASE_HOST_INTO_BLOCKLIST, REMOVE_HOST_FROM_BLOCKLIST, RELEASE_SERVICE_INSTANCE.

Output Message

The response message is an empty element tag.


Operation: ServiceNotificationSubscribe The operation ServiceNotificationSubscribe is used to subscribe to notifications from the Service Controller.
Input Message

The request to subscribe to service notification has the following sub-elements:

  • NotificationEndpoint - the SOAP endpoint provided by user for receiving the notification from Service Controller.

Output Message

The response message has the following sub-elements:

  • SubscriptionID - the SOAP endpoint provided in request.


Operation: ServiceNotificationUnsubscribe The operation ServiceNotificationUnsubscribe is used to unsubscribe to get notifications from the Service Controller.
Input Message

The request to query service have the following sub-elements:

  • SubscriptionID - the SOAP endpoint provided by user for receiving the notification from Service Controllor.

Output Message

The response message is an empty element tag.


Operation: ServiceNotificationCheck The operation ServiceNotificationCheck is used to verify if the notification mechanism is functional.
Input Message

The request to check service notification is an empty tag.

Output Message

The response message has the following sub-elements:

  • ServiceNotificationState - the state of service notification mechanism. There are 2 states currently, "ERROR" and "OK".




Date Modified: 26 Nov 2007
Platform Computing: www.platform.com

Platform Support: support@platform.com
Platform Information Development: doc@platform.com

Copyright © 1994-2007 Platform Computing Corporation. All rights reserved.