|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ServiceAdministrationInterface
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 |
---|
CreateServiceResponse createService(CreateServiceRequest request) throws java.rmi.RemoteException, ServicePolicyException
ServicePolicyException
- Raised if the supplied service definition is invalid,
already exists, or if an internal error occurs.
java.rmi.RemoteException
UpdateServiceResponse updateService(UpdateServiceRequest request) throws java.rmi.RemoteException, ServicePolicyException
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
GetServiceResponse getService(GetServiceRequest request) throws java.rmi.RemoteException, ServicePolicyException
ServicePolicyExeption
- Raised if the specified service identifier is invalid or does
not exist, or if an internal error occurs.
java.rmi.RemoteException
ServicePolicyException
RemoveServiceResponse removeService(RemoveServiceRequest request) throws java.rmi.RemoteException, ServicePolicyException
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
CreateOperationResponse createOperation(CreateOperationRequest request) throws java.rmi.RemoteException, ServicePolicyException
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
UpdateOperationResponse updateOperation(UpdateOperationRequest request) throws java.rmi.RemoteException, ServicePolicyException
ServicePolicyException
- Raised if the supplied service or operation does not exist, or
if an internal error occurs.
java.rmi.RemoteException
GetOperationResponse getOperation(GetOperationRequest request) throws java.rmi.RemoteException, ServicePolicyException
ServicePolicyException
- Raised if the supplied service or operation does not exist,
or if an internal error occurs.
java.rmi.RemoteException
RemoveOperationResponse removeOperation(RemoveOperationRequest request) throws java.rmi.RemoteException, ServicePolicyException
ServicePolicyException
- Raised if the supplied service or operation does not exist,
or if an internal error occurs.
java.rmi.RemoteException
CreateServiceImplementationResponse createServiceImplementation(CreateServiceImplementationRequest request) throws java.rmi.RemoteException, ServicePolicyException
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
UpdateServiceImplementationResponse updateServiceImplementation(UpdateServiceImplementationRequest request) throws java.rmi.RemoteException, ServicePolicyException
ServicePolicyException
- Raised if the supplied service or service implementation does
not exist, or if an internal error occurs.
java.rmi.RemoteException
GetServiceImplementationsResponse getServiceImplementations(GetServiceImplementationsRequest request) throws java.rmi.RemoteException, ServicePolicyException
ServicePolicyException
- Raised if the supplied service does not exist, is a service
group, or if an internal error occurs.
java.rmi.RemoteException
RemoveServiceImplementationResponse removeServiceImplementation(RemoveServiceImplementationRequest request) throws java.rmi.RemoteException, ServicePolicyException
ServicePolicyException
- Raised if the specified service or service implementation
does not exist, or if an internal error occurs.
java.rmi.RemoteException
ResolveServiceEnabledResponse resolveServiceEnabled(ResolveServiceEnabledRequest request) throws java.rmi.RemoteException, ServicePolicyException
ServicePolicyException
- Raised if the supplied service identifier does not exist,
or if an internal error occurs.
java.rmi.RemoteException
ResolveOperationEnabledResponse resolveOperationEnabled(ResolveOperationEnabledRequest request) throws java.rmi.RemoteException, ServicePolicyException
ServicePolicyException
- Raised if the supplied service or operation does not exist,
or if an internal error occurs.
java.rmi.RemoteException
FindMatchingServicesResponse findMatchingServices(FindMatchingServicesRequest request) throws java.rmi.RemoteException, ServicePolicyException
ServicePolicyException
- Raised if invalid criteria is supplied, or if an internal error
occurs.
java.rmi.RemoteException
GetAllOperationsResponse getAllOperations(GetAllOperationsRequest request) throws java.rmi.RemoteException, ServicePolicyException
ServicePolicyException
- Raised if the specified service does not exist, or if an internal
error occurs.
java.rmi.RemoteException
GetChildrenResponse getChildren(GetChildrenRequest request) throws java.rmi.RemoteException, ServicePolicyException
ServicePolicyException
- Raised if the specified service is an individual service,
does not exist, or if an internal error occurs.
java.rmi.RemoteException
GetParentChainResponse getParentChain(GetParentChainRequest request) throws java.rmi.RemoteException, ServicePolicyException
ServicePolicyException
- Raised if the specified service identifier does not exist, or
if an internal error occurs.
java.rmi.RemoteException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |