com.ibm.twss.spm.admin.svc
Interface ServiceAdministrationInterface

All Superinterfaces:
java.rmi.Remote
All Known Implementing Classes:
ServiceAdministrationInterfaceBindingStub, ServiceAdministrationInterfaceProxy

public interface ServiceAdministrationInterface
extends java.rmi.Remote

Service administration interface. This interface allows an administrator to create, update, retrieve, and delete service / operation / service implementation definitions. Service definitions may be either individual services or service groups, and are arranged in a service hierarchy.

Each individual service may also have a list of associated operations and service implementations. Operations can only be defined for individual services, although both individual services and service groups possess a special 'ALL' operation. An individual service must have at least one service implementation in order to allow for subscriptions to that service.

This interface also provides operations for querying the service hierarchy, determine parent and child relationships.


Method Summary
 CreateOperationResponse createOperation(CreateOperationRequest request)
          Creates a new operation definition under the specified service name.
 CreateServiceResponse createService(CreateServiceRequest request)
          Creates a new service definition within the hierarchy.
 CreateServiceImplementationResponse createServiceImplementation(CreateServiceImplementationRequest request)
          Create a new service implementation under the specified service.
 FindMatchingServicesResponse findMatchingServices(FindMatchingServicesRequest request)
          Finds all service definitions matching the specified criteria.
 GetAllOperationsResponse getAllOperations(GetAllOperationsRequest request)
          Gets all operation definitions for the specified service.
 GetChildrenResponse getChildren(GetChildrenRequest request)
          Gets all child service definitions for the specified service group.
 GetOperationResponse getOperation(GetOperationRequest request)
          Gets an operation definition for the supplied service and operation name.
 GetParentChainResponse getParentChain(GetParentChainRequest request)
          Gets the chain of parent definitions from the specified service identifier up to the root definition.
 GetServiceResponse getService(GetServiceRequest request)
          Gets the service definition for the specified service name.
 GetServiceImplementationsResponse getServiceImplementations(GetServiceImplementationsRequest request)
          Gets a list of service implementation definitions for the supplied service name.
 RemoveOperationResponse removeOperation(RemoveOperationRequest request)
          Removes an operation from the specified service.
 RemoveServiceResponse removeService(RemoveServiceRequest request)
          Removes the the specified sevice identifier.
 RemoveServiceImplementationResponse removeServiceImplementation(RemoveServiceImplementationRequest request)
          Removes a service implementation definition from the specified service.
 ResolveOperationEnabledResponse resolveOperationEnabled(ResolveOperationEnabledRequest request)
          Performs hierarchical resolution to determine the enablement status of the specified operation.
 ResolveServiceEnabledResponse resolveServiceEnabled(ResolveServiceEnabledRequest request)
          Performs hierarchical resolution to determine the enablement status of the specified service identifier.
 UpdateOperationResponse updateOperation(UpdateOperationRequest request)
          Updates an operation definition.
 UpdateServiceResponse updateService(UpdateServiceRequest request)
          Updates the supplied service definition.
 UpdateServiceImplementationResponse updateServiceImplementation(UpdateServiceImplementationRequest request)
          Updates a service implementation definition.
 

Method Detail

createService

CreateServiceResponse createService(CreateServiceRequest request)
                                    throws java.rmi.RemoteException,
                                           ServicePolicyException
Creates a new service definition within the hierarchy. Allows for the creation of individual services or service groups. When creating a new service definition, the parent group definition must be provided in order to link the service into the hierarchy. Individual services may not have children. By default, a service that is created will have a corresponding special operation 'ALL'. In addition, individual services will start off with an empty list of associated service implementations.

The service may be an individual service or a service group.

Create service request operation input parameters. Specifies the service definition to create in the service policy manager.

Returns:
Create service response result. Contains empty content.

Throws:
ServicePolicyException - Raised if the supplied service definition is invalid, already exists, or if an internal error occurs.

java.rmi.RemoteException

updateService

UpdateServiceResponse updateService(UpdateServiceRequest request)
                                    throws java.rmi.RemoteException,
                                           ServicePolicyException
Updates the supplied service definition. Only changed values are updated. If optional values are not provided, then they are considered not to have changed. The supplied service definition may refer to either an individual service or a service group.

Update service request operation input parameters. Only the changed values in the supplied definition are considered are updated.

Returns:
Update service response result. Contains empty content.

Throws:
ServicePolicyException - Raised if the updated definition refers a non-existant service, the update content is invalid, or if an internal error occurs.

java.rmi.RemoteException

getService

GetServiceResponse getService(GetServiceRequest request)
                              throws java.rmi.RemoteException,
                                     ServicePolicyException
Gets the service definition for the specified service name. May be an individual service or a service group.

Get service request operation input parameters. Specifies the service identifier whose definition to fetch. May be an individual service or a service group.

Returns:
Get service response result. Contains the service definition for the supplied input service identifier.

Throws:
ServicePolicyExeption - Raised if the specified service identifier is invalid or does not exist, or if an internal error occurs.

java.rmi.RemoteException
ServicePolicyException

removeService

RemoveServiceResponse removeService(RemoveServiceRequest request)
                                    throws java.rmi.RemoteException,
                                           ServicePolicyException
Removes the the specified sevice identifier. The service may be an individual service or a service group. If the includingChildren flag is set to true, then all service definition children will be removed along with this definition. If this flag is set to false and child definitions exist, then the service definition cannot be removed.

Removing a service will also remove any policies, subscriptions, operations, and service implementations associated with that service. Consider disabling the service status rather than removing the service to preserve that information.

Remove service operation input parameters. Specifies the service to remove. May be an individual service or a service group.

Returns:
Remove service response result. Contains empty content.

Throws:
ServicePolicyException - Raised if the specified service identifier does not exist, if an attempt was made to remove a definition that contains children without setting the includingChildren flag accordingly, or if an internal error occurs.

java.rmi.RemoteException

createOperation

CreateOperationResponse createOperation(CreateOperationRequest request)
                                        throws java.rmi.RemoteException,
                                               ServicePolicyException
Creates a new operation definition under the specified service name. Operations may only be created under individual services.

Create operation operation input parameters. Specifies the operation definition information to create in the service policy manager.

Returns:
Create operation response result. Contains empty content.

Throws:
ServicePolicyException - Raise if the given service does not exist, the given service is a service group, if the given operation already exists, or if an internal error occurs.

java.rmi.RemoteException

updateOperation

UpdateOperationResponse updateOperation(UpdateOperationRequest request)
                                        throws java.rmi.RemoteException,
                                               ServicePolicyException
Updates an operation definition. Only the changed attributes are updated. If an optional attribute is omitted, then it is considered not to have changed. The special 'ALL' operation definition may be updated.

Update operation operation input parameters. Updates the operation definition with the supplied information.

Returns:
Update operation response result. Contains empty content.

Throws:
ServicePolicyException - Raised if the supplied service or operation does not exist, or if an internal error occurs.

java.rmi.RemoteException

getOperation

GetOperationResponse getOperation(GetOperationRequest request)
                                  throws java.rmi.RemoteException,
                                         ServicePolicyException
Gets an operation definition for the supplied service and operation name. The supplied service may be an individual service or a group. The supplied operation may be the special operation 'ALL'. Service groups will only have the special operation 'ALL' defined.

Get operation operation input parameters. Specifies the operation under what service whose definition to fetch.

Returns:
Get operation response result. Returns the operation definition for the specified operation under the specified service.

Throws:
ServicePolicyException - Raised if the supplied service or operation does not exist, or if an internal error occurs.

java.rmi.RemoteException

removeOperation

RemoveOperationResponse removeOperation(RemoveOperationRequest request)
                                        throws java.rmi.RemoteException,
                                               ServicePolicyException
Removes an operation from the specified service. Removing an operation removes all associated policy information and subscriptions associated with that operation. Consider disabling the operation rather than removing the operation to preserve policy and subscription information.

The special operation 'ALL' cannot be removed.

Remove operation operation input parameters. Specifies which operation under what service to remove. The special operation 'ALL' cannot be removed.

Returns:
Remove operation response result. Contains empty content.

Throws:
ServicePolicyException - Raised if the supplied service or operation does not exist, or if an internal error occurs.

java.rmi.RemoteException

createServiceImplementation

CreateServiceImplementationResponse createServiceImplementation(CreateServiceImplementationRequest request)
                                                                throws java.rmi.RemoteException,
                                                                       ServicePolicyException
Create a new service implementation under the specified service. A service implementation must refer to a valid service.

Create service implementation operation input parameters. Creates the service implementation definition in the service policy manager under the specified individual service.

Returns:
Create service implementation response result. Contains empty content.

Throws:
ServicePolicyException - Raised if the supplied service does not exist, the supplied service name corresponds to a service group, the service implementation already exists, or if an internal error occurs.

java.rmi.RemoteException

updateServiceImplementation

UpdateServiceImplementationResponse updateServiceImplementation(UpdateServiceImplementationRequest request)
                                                                throws java.rmi.RemoteException,
                                                                       ServicePolicyException
Updates a service implementation definition. Only the values that have changed are updated. The parent service for a service implementation cannot be updated after creation. Optional fields that are omitted are considered not to have changed.

Update service implementation operation input parameters. Updates all changed definition data in the service policy manager.

Returns:
Update service implementation response result. Contains empty content.

Throws:
ServicePolicyException - Raised if the supplied service or service implementation does not exist, or if an internal error occurs.

java.rmi.RemoteException

getServiceImplementations

GetServiceImplementationsResponse getServiceImplementations(GetServiceImplementationsRequest request)
                                                            throws java.rmi.RemoteException,
                                                                   ServicePolicyException
Gets a list of service implementation definitions for the supplied service name. The supplied service must be an individual service and not a service group, as service implementations can only be registered under individual services.

Get sevice implementation operation input parameters. Specifies the service whose service implementations to fetch.

Returns:
Get service implementation response result. Returns a list of all service implementations registered for the specified service.

Throws:
ServicePolicyException - Raised if the supplied service does not exist, is a service group, or if an internal error occurs.

java.rmi.RemoteException

removeServiceImplementation

RemoveServiceImplementationResponse removeServiceImplementation(RemoveServiceImplementationRequest request)
                                                                throws java.rmi.RemoteException,
                                                                       ServicePolicyException
Removes a service implementation definition from the specified service. Removing a service implementation removes corresponding policy information defined at the service implementation scope, and corresponding subscription information. Consider disabling the service implementation rather than removing it in order to preserve policy and subscription information.

Remove service implementation operation input parameters. Specifies the service implementation name, under the which service, to remove from service policy manager.

Returns:
Remove service implementation response result. Contains empty content.

Throws:
ServicePolicyException - Raised if the specified service or service implementation does not exist, or if an internal error occurs.

java.rmi.RemoteException

resolveServiceEnabled

ResolveServiceEnabledResponse resolveServiceEnabled(ResolveServiceEnabledRequest request)
                                                    throws java.rmi.RemoteException,
                                                           ServicePolicyException
Performs hierarchical resolution to determine the enablement status of the specified service identifier. The service identifier may be an individual service or a service group. The service policy manager will search the hierarchy to determine whether the supplied identifier is enabled. If the service identifier itself or any parent definition along the path up to the root definition in the hierarchy has been disabled, then the specified service identifier is considered disabled.

Resolve service enabled operation input parameters. Specifies the service identifier whose enablement status to resolve.

Returns:
Resolve service enabled response result. Returns a boolean indicating the enablement status of the specified service.

Throws:
ServicePolicyException - Raised if the supplied service identifier does not exist, or if an internal error occurs.

java.rmi.RemoteException

resolveOperationEnabled

ResolveOperationEnabledResponse resolveOperationEnabled(ResolveOperationEnabledRequest request)
                                                        throws java.rmi.RemoteException,
                                                               ServicePolicyException
Performs hierarchical resolution to determine the enablement status of the specified operation. The service policy manager will search the hierarchy to determine whether the supplied operation is enabled. If any service higher up in the hierarchy for the parent service of the operation is disabled, or if any parent service's 'ALL' operation is disabled, or if the 'ALL' operation is disabled for the operation's parent service, or if the operation itself is disabled, then the specified operation will be considered disabled.

Resolve operation enabled operation input parameters. Specifies the operation name, under which service, whose enablement status to resolve.

Returns:
Resolve operation enable response result. Returns a boolean indicating the enablement status of the specified operation.

Throws:
ServicePolicyException - Raised if the supplied service or operation does not exist, or if an internal error occurs.

java.rmi.RemoteException

findMatchingServices

FindMatchingServicesResponse findMatchingServices(FindMatchingServicesRequest request)
                                                  throws java.rmi.RemoteException,
                                                         ServicePolicyException
Finds all service definitions matching the specified criteria. A pattern can be specified to match different service identifier names, or the search may be restricted to searching under a particular service group in the hierarchy or to a certain type of idenitifer (individual service or service group).

Find matching services operation input parameters. Specifies criteria used to find all matching services while searching the service hierarchy.

Returns:
Find matching sevices response result. Returns a list of service definitions that matched the specified criteria. If there are no matches, then an empty list will be returned.

Throws:
ServicePolicyException - Raised if invalid criteria is supplied, or if an internal error occurs.

java.rmi.RemoteException

getAllOperations

GetAllOperationsResponse getAllOperations(GetAllOperationsRequest request)
                                          throws java.rmi.RemoteException,
                                                 ServicePolicyException
Gets all operation definitions for the specified service. The service may an individual service or a service group.

Get all operations operation input paremeters. Specifies the service whose operations definitions to fetch. May be an individual service or a service group.

Returns:
Get all operations response result. Returns a list of operation definitions for the specified service.

Throws:
ServicePolicyException - Raised if the specified service does not exist, or if an internal error occurs.

java.rmi.RemoteException

getChildren

GetChildrenResponse getChildren(GetChildrenRequest request)
                                throws java.rmi.RemoteException,
                                       ServicePolicyException
Gets all child service definitions for the specified service group. An individual service cannot be specified, as it has no children in the service hierarchy. The list of child service definitions may contain both individual services and service groups.

Get children operation input parameters. Specifies the service group whose children to fetch.

Returns:
Get children operation response result. Contains a list of service definitions that are the children of the specified service group.

Throws:
ServicePolicyException - Raised if the specified service is an individual service, does not exist, or if an internal error occurs.

java.rmi.RemoteException

getParentChain

GetParentChainResponse getParentChain(GetParentChainRequest request)
                                      throws java.rmi.RemoteException,
                                             ServicePolicyException
Gets the chain of parent definitions from the specified service identifier up to the root definition. The specified service identifier may be an individual service or a service group. The specified service identifier will not appear in the list. The list of parent definitions will be provided in order of traversing up the hierarchy to the root definition.

Get parent chain operation input parameters. Specifies the service identifier whose parent chain to fetch.

Returns:
Get parent chain operation response result. Returns a list of service definitions, starting from the parent of the specified service up to the root definition.

Throws:
ServicePolicyException - Raised if the specified service identifier does not exist, or if an internal error occurs.

java.rmi.RemoteException


Copyright © IBM Corp. All Rights Reserved.