com.ibm.twss.spm.admin.req
Interface RequesterAdministrationInterface

All Superinterfaces:
java.rmi.Remote
All Known Implementing Classes:
RequesterAdministrationInterfaceBindingStub, RequesterAdministrationInterfaceProxy

public interface RequesterAdministrationInterface
extends java.rmi.Remote

Requester administration interface. This interface allows an administrator to create, update, retrieve, and delete requester definitions. Retrieval functions allows for searching the requester hierarchy using a filter pattern and querying parent relationships for requesters in the hierarchy.


Method Summary
 CreateRequestersResponse createRequesters(CreateRequestersRequest request)
          Attempts to create one or more requester definitions in a single batch operation.
 FindMatchingRequestersResponse findMatchingRequesters(FindMatchingRequestersRequest request)
          Finds a list of requester identifiers that match the supplied input parameters.
 GetChildrenResponse getChildren(GetChildrenRequest request)
          Gets all immediate child requester definitions of the specified requester group.
 GetParentChainResponse getParentChain(GetParentChainRequest request)
          Returns the chain of requester group definitions for the specified requester identifier up to the root definition of the hierarchy.
 GetRequestersResponse getRequesters(GetRequestersRequest request)
          Get requesters operation input parameters.
 RemoveRequestersResponse removeRequesters(RemoveRequestersRequest request)
          Removes one or more requester definitions in a batch operation.
 ResolveRequestersEnabledResponse resolveRequestersEnabled(ResolveRequestersEnabledRequest request)
          Performs hierarchical resolution on a list of requester identifiers to determine their enablement status.
 UpdateRequestersResponse updateRequesters(UpdateRequestersRequest request)
          Updates one or more requester definitions in a batch operation.
 

Method Detail

createRequesters

CreateRequestersResponse createRequesters(CreateRequestersRequest request)
                                          throws java.rmi.RemoteException
Attempts to create one or more requester definitions in a single batch operation. The runtime will iterate through the list of supplied requester definitions and attempt to create them in sequence. Faults will be returned for any failures encountered during iteration. Encountering failures does not necessarily halt the iteration, and the runtime may continue in best effort to create as many of the supplied definitions as possible.

Create requesters operation input parameters. Contains a list of requester definitions to create in the service policy manager.

Returns:
Create requesters response result. This response contains a list of any faults that may have occurred while creating the supplied requester definitions.

Throws:
java.rmi.RemoteException

updateRequesters

UpdateRequestersResponse updateRequesters(UpdateRequestersRequest request)
                                          throws java.rmi.RemoteException
Updates one or more requester definitions in a batch operation. The runtime will iterate through the supplied requester definitions, performing the update in sequence. If an error occurs, then it will mark that position in the output array with a description of the error. Encountering a fault will not necessarily halt the update iteration.

Update requesters operation input parameters. Contains a list of requester definitions to update.

Returns:
Update requesters operation response result. This response contains a list of any faults that may have occurred while updating the supplied requester definitions.

Throws:
java.rmi.RemoteException

getRequesters

GetRequestersResponse getRequesters(GetRequestersRequest request)
                                    throws java.rmi.RemoteException,
                                           ServicePolicyException
Get requesters operation input parameters. Gets a list of requester definitions for each of the supplied requester identifiers. Requester identifiers may be individual requesters or requester groups.

Get requesters operation input parameters. Contains a list of requester identifiers whose definitions to fetch.

Returns:
Get requesters operation response result. Contains a list of requester definitions, whose position in the array corresponds to the position of the input requester identifier array.

Throws:
ServicePolicyException - Raised if a supplied requester identifier does not exist or an internal error occurs.

java.rmi.RemoteException

removeRequesters

RemoveRequestersResponse removeRequesters(RemoveRequestersRequest request)
                                          throws java.rmi.RemoteException
Removes one or more requester definitions in a batch operation. The runtime will iterate through the supplied requester definitions, performing the removal in sequence. If an error occurs, then it will mark that position in the output array with a description of the error. Encountering a fault will not necessarily halt the update iteration.

Note that removing a requester also removes the subscriptions associated with that requester, as well as any policies that have been defined in that requester's scope. Consider disabling the requester instead of removing the requester in order to preserve subscription and policy information associated with that requester.

Remove requesters operation input parameters. Contains a list of requester identifiers whose definitions to remove. Also indicates whether removal should prune children as well. If child nodes should not be removed and one of the specified requester identifiers has childeren, then an error will result.

Returns:
Remove requesters operation response result. This response contains a list of any faults that may have occurred while updating the supplied requester definitions.

Throws:
java.rmi.RemoteException

resolveRequestersEnabled

ResolveRequestersEnabledResponse resolveRequestersEnabled(ResolveRequestersEnabledRequest request)
                                                          throws java.rmi.RemoteException,
                                                                 ServicePolicyException
Performs hierarchical resolution on a list of requester identifiers to determine their enablement status. A requester identifier may be disabled due to its entry being marked disabled, or some requester group higher in the hierarchy that has been disabled.

The enablement status of a requester is resolved going top down in the hierarchy. If one of the parent nodes in the chain is disabled, then that requster identifier is considered disabled. If all parents are enabled and the requester identifier itself is enabled, then the requester is considered enabled.

Resolve requesters enabled operation input parameters. Contains a list of requester identifiers whose enablement status to resolve.

Returns:
Resolve requesters enabled operation response result. Contains a list of boolean flags indicating enablement status. The order of the results corresponds to the order of the input list of requesters.

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

java.rmi.RemoteException

findMatchingRequesters

FindMatchingRequestersResponse findMatchingRequesters(FindMatchingRequestersRequest request)
                                                      throws java.rmi.RemoteException,
                                                             ServicePolicyException
Finds a list of requester identifiers that match the supplied input parameters. An SQL92 'LIKE' clause pattern is supplied to filter requester identifier names. This can be used to limit the size of the output for a large number of requesters. In addition, the search can be limited to looking under a specified requester group definition or to searching for certain definition types (such as individual requesters only or requester groups only).

Find matching requesters operation input parameters. Specifies the search criteria used to match requester identifiers. Search criteria include an SQL 'LIKE' clause matching parameter, a limit to search under a specified requester group, or limiting returned results to certain requester definition types. At a minimum, a pattern must be supplied, although a full wildcard can be used.

Returns:
Find matching requesters operation response result. Contains a list of matching requester definitions per the specified criteria.

Throws:
ServicePolicyException - Raised if the specified pattern or requester definition type was invalid, or if an internal error occurred.

java.rmi.RemoteException

getChildren

GetChildrenResponse getChildren(GetChildrenRequest request)
                                throws java.rmi.RemoteException,
                                       ServicePolicyException
Gets all immediate child requester definitions of the specified requester group.

Get children operation input parameters. Specifies the requester group whose children to return.

Returns:
Get children operation response result. Returns a list of requester definitions whose immediate parent is the input requester group.

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

java.rmi.RemoteException

getParentChain

GetParentChainResponse getParentChain(GetParentChainRequest request)
                                      throws java.rmi.RemoteException,
                                             ServicePolicyException
Returns the chain of requester group definitions for the specified requester identifier up to the root definition of the hierarchy. The chain is returned in a bottom up order, going up the hierarchy.

Get parent chain operation input parameters. Specifies the requester identifier whose parent requster group chain to retrieve.

Returns:
Get parent chain operation response result. Returns a list of requester group definitions going up the chain from the specified requester identifier definition to the root requester group definition.

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

java.rmi.RemoteException


Copyright © IBM Corp. All Rights Reserved.