com.ibm.twss.spm.admin.sub
Interface SubscriptionAdministrationInterface

All Superinterfaces:
java.rmi.Remote
All Known Implementing Classes:
SubscriptionAdministrationInterfaceBindingStub, SubscriptionAdministrationInterfaceProxy

public interface SubscriptionAdministrationInterface
extends java.rmi.Remote

Subscription administration interface. This interface allows an administrator to create, retrieve, and delete subscription definitions. A method is provided to perform hierarchical resolution of subscriptions for a given (requester, service, operation) scope.


Method Summary
 CreateSubscriptionResponse createSubscription(CreateSubscriptionRequest request)
          Creates a subscription between a requester identifier (an individual requester or a requester group), the specified service, operation, and service implementation.
 GetSubscriptionsResponse getSubscriptions(GetSubscriptionsRequest request)
          Gets a list of subscriptions for the supplied requester identifier.
 RemoveSubscriptionResponse removeSubscription(RemoveSubscriptionRequest request)
          Remove a subscription.
 ResolveSubscriptionResponse resolveSubscription(ResolveSubscriptionRequest request)
          Retrieves the subscription associated with a (requester, service, operation) scope.
 

Method Detail

createSubscription

CreateSubscriptionResponse createSubscription(CreateSubscriptionRequest request)
                                              throws java.rmi.RemoteException,
                                                     ServicePolicyException
Creates a subscription between a requester identifier (an individual requester or a requester group), the specified service, operation, and service implementation. The subscription may be made to an individual operation or the special 'ALL' operation. Each subscription creates a mapping between a service and a corresponding service implementation as part of the subscription; there can only be a single service implementation that processes a request for a given subscription.

Create subscription operation input parameters. Specifies the requester, service, operation, and service implementation that form the subscription.

Returns:
Create subscription operation response result. This response has empty content.

Throws:
ServicePolicyException - Raised if the supplied requester, service, operation, or service implementation identifies do not exist, or if an internal error occurred creating the subscription.

java.rmi.RemoteException

removeSubscription

RemoveSubscriptionResponse removeSubscription(RemoveSubscriptionRequest request)
                                              throws java.rmi.RemoteException,
                                                     ServicePolicyException
Remove a subscription. The subscription must match the provided information to be removed.

Remove subscription operation input parameters. Specifies the subscription information to remove. The subscription information in the service policy manager must match this input exactly to be removed.

Returns:
Create subscription operation response result. This response has empty content.

Throws:
ServicePolicyException - Raised if the supplied subscription information does not match an existing subscription, or if an internal error occurred.

java.rmi.RemoteException

getSubscriptions

GetSubscriptionsResponse getSubscriptions(GetSubscriptionsRequest request)
                                          throws java.rmi.RemoteException,
                                                 ServicePolicyException
Gets a list of subscriptions for the supplied requester identifier. The requester identifier may be an individual requester or a requester group. If there are no subscriptions associated with the supplied identifier, then an empty list will be returned.

Get subscription operation input parameters. Specifies the requester identifier whose list of subscriptions to fetch. May be an individual requester or a requester group.

Returns:
Get subscription operation response result. Returns a list of subscriptions associated with the supplied requester identifier. If the requester identifier has no subscriptions, then an empty list is returned.

Throws:
ServicePolicyException - Raised if the supplied requester identifier is invalid or does not exist, or if an internal error occurred.

java.rmi.RemoteException

resolveSubscription

ResolveSubscriptionResponse resolveSubscription(ResolveSubscriptionRequest request)
                                                throws java.rmi.RemoteException,
                                                       ServicePolicyException
Retrieves the subscription associated with a (requester, service, operation) scope. The service implementation is implied in this scoping as there can only be one service implementation per subscription. This operation performs hierarchical resolution when determining the matching subscription. If a requester does not possess a matching subscription but a parent requester group does, then the parent's subscription will be returned. Always the most specific match in terms of being lower in the hierarchy will be returned.

Resolve subscription operation input parameters. Specifies the (requester, service, operation) scope to use when searching the requester hierarchy to locate a matching subscription.

Returns:
Resolve subscription operation response result. Returns the matching subscription information.

Throws:
ServicePolicyException - Raised if an invalid (requester, service, operation) scope was supplied, if no subscription exists, or if an internal error occurred

java.rmi.RemoteException


Copyright © IBM Corp. All Rights Reserved.