http://www.ibm.com/schema/twss/spm/admin/subscription/v2_0/interface
The SubscriptionAdministrationInterface Port Type

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.

 Collapse Operations
SubscriptionAdministrationInterface_createSubscriptionResponse  createSubscription (createSubscriptionRequest request) [faults:  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.

Input: SubscriptionAdministrationInterface_createSubscriptionRequest

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

Output: SubscriptionAdministrationInterface_createSubscriptionResponse

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

Fault:
ServicePolicyException  : 

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


SubscriptionAdministrationInterface_getSubscriptionsResponse  getSubscriptions (getSubscriptionsRequest request) [faults:  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.

Input: SubscriptionAdministrationInterface_getSubscriptionsRequest

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

Output: SubscriptionAdministrationInterface_getSubscriptionsResponse

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.

Fault:
ServicePolicyException  : 

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


SubscriptionAdministrationInterface_removeSubscriptionResponse  removeSubscription (removeSubscriptionRequest request) [faults:  ServicePolicyException  ]

Remove a subscription. The subscription must match the provided information to be removed.

Input: SubscriptionAdministrationInterface_removeSubscriptionRequest

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.

Output: SubscriptionAdministrationInterface_removeSubscriptionResponse

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

Fault:
ServicePolicyException  : 

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


SubscriptionAdministrationInterface_resolveSubscriptionResponse  resolveSubscription (resolveSubscriptionRequest request) [faults:  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.

Input: SubscriptionAdministrationInterface_resolveSubscriptionRequest

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

Output: SubscriptionAdministrationInterface_resolveSubscriptionResponse

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

Fault:
ServicePolicyException  : 

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


 Collapse XML
-<wsdl:portType  name="SubscriptionAdministrationInterface">
-<wsdl:documentation>
<xhtml:p>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.</xhtml:p>
</wsdl:documentation>
-<wsdl:operation  name="createSubscription">
-<wsdl:documentation>
<xhtml:p>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.</xhtml:p>
</wsdl:documentation>
-<wsdl:documentation>
<xhtml:p>Create subscription operation input parameters. Specifies the requester, service, operation, and service implementation that form the subscription.</xhtml:p>
</wsdl:documentation>
</wsdl:input>
-<wsdl:documentation>
<xhtml:p>Create subscription operation response result. This response has empty content.</xhtml:p>
</wsdl:documentation>
</wsdl:output>
-<wsdl:fault  message="admin_sub_interface:ServicePolicyException"  name="ServicePolicyException">
-<wsdl:documentation>
<xhtml:p>Raised if the supplied requester, service, operation, or service implementation identifies do not exist, or if an internal error occurred creating the subscription.</xhtml:p>
</wsdl:documentation>
</wsdl:fault>
</wsdl:operation>
-<wsdl:operation  name="removeSubscription">
-<wsdl:documentation>
<xhtml:p>Remove a subscription. The subscription must match the provided information to be removed.</xhtml:p>
</wsdl:documentation>
-<wsdl:documentation>
<xhtml:p>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.</xhtml:p>
</wsdl:documentation>
</wsdl:input>
-<wsdl:documentation>
<xhtml:p>Create subscription operation response result. This response has empty content.</xhtml:p>
</wsdl:documentation>
</wsdl:output>
-<wsdl:fault  message="admin_sub_interface:ServicePolicyException"  name="ServicePolicyException">
-<wsdl:documentation>
<xhtml:p>Raised if the supplied subscription information does not match an existing subscription, or if an internal error occurred.</xhtml:p>
</wsdl:documentation>
</wsdl:fault>
</wsdl:operation>
-<wsdl:operation  name="getSubscriptions">
-<wsdl:documentation>
<xhtml:p>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.</xhtml:p>
</wsdl:documentation>
-<wsdl:documentation>
<xhtml:p>Get subscription operation input parameters. Specifies the requester identifier whose list of subscriptions to fetch. May be an individual requester or a requester group.</xhtml:p>
</wsdl:documentation>
</wsdl:input>
-<wsdl:documentation>
<xhtml:p>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.</xhtml:p>
</wsdl:documentation>
</wsdl:output>
-<wsdl:fault  message="admin_sub_interface:ServicePolicyException"  name="ServicePolicyException">
-<wsdl:documentation>
<xhtml:p>Raised if the supplied requester identifier is invalid or does not exist, or if an internal error occurred.</xhtml:p>
</wsdl:documentation>
</wsdl:fault>
</wsdl:operation>
-<wsdl:operation  name="resolveSubscription">
-<wsdl:documentation>
<xhtml:p>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.</xhtml:p>
</wsdl:documentation>
-<wsdl:documentation>
<xhtml:p>Resolve subscription operation input parameters. Specifies the (requester, service, operation) scope to use when searching the requester hierarchy to locate a matching subscription.</xhtml:p>
</wsdl:documentation>
</wsdl:input>
-<wsdl:documentation>
<xhtml:p>Resolve subscription operation response result. Returns the matching subscription information.</xhtml:p>
</wsdl:documentation>
</wsdl:output>
-<wsdl:fault  message="admin_sub_interface:ServicePolicyException"  name="ServicePolicyException">
-<wsdl:documentation>
<xhtml:p>Raised if an invalid (requester, service, operation) scope was supplied, if no subscription exists, or if an internal error occurred</xhtml:p>
</wsdl:documentation>
</wsdl:fault>
</wsdl:operation>
</wsdl:portType>
 Collapse Used-By
Service Port Binding
SubscriptionAdministrationService SubscriptionAdministrationService SubscriptionAdministrationInterfaceBinding
Generated by WSDLdoc ©