com.ibm.twss.spm.admin.type
Interface TypeAdministrationInterface

All Superinterfaces:
java.rmi.Remote
All Known Implementing Classes:
TypeAdministrationInterfaceBindingStub, TypeAdministrationInterfaceProxy

public interface TypeAdministrationInterface
extends java.rmi.Remote

Type administration interface. This interface allows an administrator to create, update, retrieve, and delete types in the service policy manager system. Types are used for validating the form factor of policy attribute values. They do not assign any semantics or meaning to the contents of the value, but instead ensure that the value is of the right "form" for a corresponding type.

As removing a type can potentially be a dangerous operation, removal of a type is only allowed provided there are no existing policy attributes in the system that have been assigned to that type.


Method Summary
 CreatePolicyTypeResponse createPolicyType(CreatePolicyTypeRequest request)
          Creates a new policy type in the service policy manager.
 GetAllPolicyTypesResponse getAllPolicyTypes(GetAllPolicyTypesRequest request)
          Retrieve all the policy type definitions from the service policy manager system.
 GetPolicyTypeResponse getPolicyType(GetPolicyTypeRequest request)
          Gets the policy type definition for the supplied type name.
 RemovePolicyTypeResponse removePolicyType(RemovePolicyTypeRequest request)
          Removes a policy type from the service policy manager.
 UpdatePolicyTypeResponse updatePolicyType(UpdatePolicyTypeRequest request)
          Updates the specified policy type definition.
 

Method Detail

createPolicyType

CreatePolicyTypeResponse createPolicyType(CreatePolicyTypeRequest request)
                                          throws java.rmi.RemoteException,
                                                 ServicePolicyException
Creates a new policy type in the service policy manager. The type name must be unique across all types defined in the system. Both the editable and editMask fields must be present during creation of the type definition. The editMask may need to be sent as CDATA in order to pass the regular expression content.

Create policy type operation input parameters. Specifies the type definition to create in the service policy manager. Both editable and editMask fields must be present.

Returns:
Create policy type response result. Contains empty content.

Throws:
ServicePolicyException - Raised if an invalid type defintion is specified, if the type already exists, or if an internal error occurs.

java.rmi.RemoteException

updatePolicyType

UpdatePolicyTypeResponse updatePolicyType(UpdatePolicyTypeRequest request)
                                          throws java.rmi.RemoteException,
                                                 ServicePolicyException
Updates the specified policy type definition. Only changed fields are updated in the system. Omitted optional fields are considered not to have changed.

Note: this is a potentially dangerous operation for policy values that are already in use in the system. Thus, any changes to policy values should be made with extreme caution.

Update policy type operation input parameters. The supplied definition will be updated in the service policy manager system.

Returns:
Update policy type response result. Contains empty content.

Throws:
ServicePolicyException - Raised if the specified policy type does not exist, if an invalid change is made, or if an internal error occurs.

java.rmi.RemoteException

getPolicyType

GetPolicyTypeResponse getPolicyType(GetPolicyTypeRequest request)
                                    throws java.rmi.RemoteException,
                                           ServicePolicyException
Gets the policy type definition for the supplied type name.

Get policy type operation input parameters. Specifies the type name whose definition to fetch.

Returns:
Get policy type response result. Returns the policy type definition for the supplied type name.

Throws:
ServicePolicyException - Raised if the supplied type name does not exist, or if an internal error occurs.

java.rmi.RemoteException

removePolicyType

RemovePolicyTypeResponse removePolicyType(RemovePolicyTypeRequest request)
                                          throws java.rmi.RemoteException,
                                                 ServicePolicyException
Removes a policy type from the service policy manager. Due to the dangerous nature of this operation, this operation will not be allowed to succeed provided there are existing policy attribute values in the system that reference this type. Those policy attributes must be removed from the system before this operation can succeed.

Remove policy type operation input parameters. Specifies the name of the policy type definition to remove from the service policy manager system.

Returns:
Remove policy type response result. Contains empty content.

Throws:
ServicePolicyException - Raised if the specified policy type is still in use by the system, if the specified type does not exist, or if an internal error occurs.

java.rmi.RemoteException

getAllPolicyTypes

GetAllPolicyTypesResponse getAllPolicyTypes(GetAllPolicyTypesRequest request)
                                            throws java.rmi.RemoteException,
                                                   ServicePolicyException
Retrieve all the policy type definitions from the service policy manager system.

Get all policy types operation input parameters. Contains empty content.

Returns:
Get all policy types response result. Returns a list of all policy definitions in the service policy manager system.

Throws:
ServicePolicyException - Raised if an internal error occurs.

java.rmi.RemoteException


Copyright © IBM Corp. All Rights Reserved.