com.ibm.twss.spm.admin.policy
Interface PolicyAdministrationInterface

All Superinterfaces:
java.rmi.Remote
All Known Implementing Classes:
PolicyAdministrationInterfaceBindingStub, PolicyAdministrationInterfaceProxy

public interface PolicyAdministrationInterface
extends java.rmi.Remote

Policy administration interface. This interface allows an adminstrator to create, retrieve, update, delete policy values. Two flavors of retrieval are provided: retrieval of policies at a specific scope and hierarchical retrieval. Hierarchical retrieval performs hierarchical resolution using the supplied policy scope context as the point to start resolution. In addition, a means of validating policy values is also supplied.


Method Summary
 CreatePoliciesResponse createPolicies(CreatePoliciesRequest request)
          Attempts to create one or more service policy attribute/value pairs in a single batch operation.
 GetInheritedPoliciesResponse getInheritedPolicies(GetInheritedPoliciesRequest request)
          Get all scoped policy values that are included in the specified scope or higher scopes per service policy manager hierarchical resolution.
 GetResolvedPoliciesResponse getResolvedPolicies(GetResolvedPoliciesRequest request)
          Performs hierarchical resolution to determine the set of policies visible at the provided (requester, service, operation) scope tuple.
 GetScopedPoliciesResponse getScopedPolicies(GetScopedPoliciesRequest request)
          Retrieves the scoped policy attribute/value pairs that have been defined only at the specified policy scope.
 RemovePoliciesResponse removePolicies(RemovePoliciesRequest request)
          Removes one or more policy attributes from a specified (requester, service, operation) scope tuple in a batch operation.
 UpdatePoliciesResponse updatePolicies(UpdatePoliciesRequest request)
          Updates one or more policy attribute/value pairs in a batch operation.
 ValidatePolicyValuesResponse validatePolicyValues(ValidatePolicyValuesRequest request)
          Performs validation of one or more policy values.
 

Method Detail

createPolicies

CreatePoliciesResponse createPolicies(CreatePoliciesRequest request)
                                      throws java.rmi.RemoteException
Attempts to create one or more service policy attribute/value pairs in a single batch operation. The runtime will iterate through the list of supplied policy pairs 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 values as possible.

Create policies operation input parameters. Contains a list of policy attribute/value pairs to create.

Returns:
Create policies operation response result. This response contains a list of any faults that may have occured while creating the supplied policy attribute/value pairs.

Throws:
java.rmi.RemoteException

updatePolicies

UpdatePoliciesResponse updatePolicies(UpdatePoliciesRequest request)
                                      throws java.rmi.RemoteException
Updates one or more policy attribute/value pairs in a batch operation. The runtime will iterate through the supplied attribute/value pairs, performing the update in sequence. If an error occurs, then it will mark that position in the output fault array with a description of the error. Encountering a fault will not necessarily halt the update iteration.

Only fields that are supplied in the policy data structure are updated. If an optional field is omitted in the request, then the corresponding information is not updated by the runtime.

Update one or more policies in one batch operation. Update policies operation input parameters. Contains a list of policy attribute/value pairs to update.

Returns:
Update policies operation response result. This response contains a list of any faults that may have occurred while updating the supplied policy attribute/value pairs.

Throws:
java.rmi.RemoteException

removePolicies

RemovePoliciesResponse removePolicies(RemovePoliciesRequest request)
                                      throws java.rmi.RemoteException
Removes one or more policy attributes from a specified (requester, service, operation) scope tuple in a batch operation. The runtime will iterate through the supplied list of attributes, performing the removal in sequence. If an error occurs, then it will mark that position in the output fault array with a description of th error. Encountering a fautl will not necessarily halt the removal iteration.

Remove policies operation input parameters. Specifies a policy scope and list of attributes to remove.

Returns:
Remove policies operation response result. This response contains a list of any faults that may have occurred while removing the supplied policy attribute names.

Throws:
java.rmi.RemoteException

getScopedPolicies

GetScopedPoliciesResponse getScopedPolicies(GetScopedPoliciesRequest request)
                                            throws java.rmi.RemoteException,
                                                   ServicePolicyException
Retrieves the scoped policy attribute/value pairs that have been defined only at the specified policy scope. This operation does not perform any hierarchical resolution, so policies may exist at other scopes.

Get scoped policies operation input parameters. Specifies the (requester, service, operation) scope tuple at which to fetch policies.

Returns:
Get scoped policies operation response result. Returns a list of scoped policies defined at that scope. The list may be empty if no policies are defined.

Throws:
ServicePolicyException - Raised if the provided policy scope is invalid or an internal error occurs.

java.rmi.RemoteException

getResolvedPolicies

GetResolvedPoliciesResponse getResolvedPolicies(GetResolvedPoliciesRequest request)
                                                throws java.rmi.RemoteException,
                                                       ServicePolicyException
Performs hierarchical resolution to determine the set of policies visible at the provided (requester, service, operation) scope tuple. Scoped policy values that are returned contain the most specific values determined during resolution, with non-overridden values inherited from higher level policy scopes.

Get resolved policies operation input parameters. Specifies the (requester, service, operation) scope tuple at which to fetch policies.

Returns:
Get resolved policies response result. Returns a list of scoped policies that were resolved hierarchically for the given scope. The list may be empty if no policies could be resolved.

Throws:
ServicePolicyException - Raised if the provided policy scope is invalid or an internal error occurs.

java.rmi.RemoteException

getInheritedPolicies

GetInheritedPoliciesResponse getInheritedPolicies(GetInheritedPoliciesRequest request)
                                                  throws java.rmi.RemoteException,
                                                         ServicePolicyException
Get all scoped policy values that are included in the specified scope or higher scopes per service policy manager hierarchical resolution. This returns the inheritance chain of policy values, returning from most general to most specific. This list may be empty if no policies can be located for the specific policy name.

Get inherited policies operation input parameters. Specifies the (requester, service, operation) scope tuple and policy name whose scoped policies to fetch.

Returns:
Get inherited policies response result. Returns a list of scoped policies for the specified scope tuple and policy name. The list may be empty if no policies for the specified policy name can be found.

Throws:
ServicePolicyException - Raised if the provided policy scope is invalid or an internal error occurs.

java.rmi.RemoteException

validatePolicyValues

ValidatePolicyValuesResponse validatePolicyValues(ValidatePolicyValuesRequest request)
                                                  throws java.rmi.RemoteException,
                                                         ServicePolicyException
Performs validation of one or more policy values. Each policy value has an associated type that's used to look up the validation mask to evaluate against the policy. A list of boolean is returned indicated which values were and were not valid, by position.

Validate policy values operation input parameters. Contains a list of policy values and types.

Returns:
Validate policy values response result. Returns a list of booleans indicating which entries were valid.

Throws:
ServicePolicyException - Raised if the input refers to invalid types or if an internal error occurs.

java.rmi.RemoteException


Copyright © IBM Corp. All Rights Reserved.