com.ibm.twss.spm.admin.type
Class TypeAdministrationInterfaceProxy

java.lang.Object
  extended by com.ibm.twss.spm.admin.type.TypeAdministrationInterfaceProxy
All Implemented Interfaces:
TypeAdministrationInterface, java.rmi.Remote

public class TypeAdministrationInterfaceProxy
extends java.lang.Object
implements TypeAdministrationInterface


Constructor Summary
TypeAdministrationInterfaceProxy()
           
 
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.
 java.lang.String getEndpoint()
           
 GetPolicyTypeResponse getPolicyType(GetPolicyTypeRequest request)
          Gets the policy type definition for the supplied type name.
 TypeAdministrationInterface getTypeAdministrationInterface()
           
 RemovePolicyTypeResponse removePolicyType(RemovePolicyTypeRequest request)
          Removes a policy type from the service policy manager.
 void setEndpoint(java.lang.String endpoint)
           
 UpdatePolicyTypeResponse updatePolicyType(UpdatePolicyTypeRequest request)
          Updates the specified policy type definition.
 void useJNDI(boolean useJNDI)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TypeAdministrationInterfaceProxy

public TypeAdministrationInterfaceProxy()
Method Detail

useJNDI

public void useJNDI(boolean useJNDI)

getEndpoint

public java.lang.String getEndpoint()

setEndpoint

public void setEndpoint(java.lang.String endpoint)

getTypeAdministrationInterface

public TypeAdministrationInterface getTypeAdministrationInterface()

createPolicyType

public CreatePolicyTypeResponse createPolicyType(CreatePolicyTypeRequest request)
                                          throws java.rmi.RemoteException,
                                                 ServicePolicyException
Description copied from interface: TypeAdministrationInterface
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.

Specified by:
createPolicyType in interface TypeAdministrationInterface
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

public UpdatePolicyTypeResponse updatePolicyType(UpdatePolicyTypeRequest request)
                                          throws java.rmi.RemoteException,
                                                 ServicePolicyException
Description copied from interface: TypeAdministrationInterface
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.

Specified by:
updatePolicyType in interface TypeAdministrationInterface
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

public GetPolicyTypeResponse getPolicyType(GetPolicyTypeRequest request)
                                    throws java.rmi.RemoteException,
                                           ServicePolicyException
Description copied from interface: TypeAdministrationInterface
Gets the policy type definition for the supplied type name.

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

Specified by:
getPolicyType in interface TypeAdministrationInterface
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

public RemovePolicyTypeResponse removePolicyType(RemovePolicyTypeRequest request)
                                          throws java.rmi.RemoteException,
                                                 ServicePolicyException
Description copied from interface: TypeAdministrationInterface
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.

Specified by:
removePolicyType in interface TypeAdministrationInterface
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

public GetAllPolicyTypesResponse getAllPolicyTypes(GetAllPolicyTypesRequest request)
                                            throws java.rmi.RemoteException,
                                                   ServicePolicyException
Description copied from interface: TypeAdministrationInterface
Retrieve all the policy type definitions from the service policy manager system.

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

Specified by:
getAllPolicyTypes in interface TypeAdministrationInterface
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.