com.softwareag.centrasite.policy.api
Interface PolicyLifeCycleManager


public interface PolicyLifeCycleManager

Defines Policy specific CRUD operations.


Method Summary
 PolicyActionCategory createActionCategory(java.lang.String categoryName, PolicyType policyType)
          Creates an action category with the given category name
 PolicyActionInstance createActionInstance(PolicyActionTemplate policyAction)
          Creates a Policy Action Instance for the given Policy Action
 PolicyActionParameter createActionParameter(java.lang.String type, java.lang.String name)
          Creates a Policy Action Parameter with the given name and type
 PolicyActionTemplate createActionTemplate(PolicyActionCategory actionCategory, java.lang.String name, java.lang.String description, javax.xml.registry.infomodel.Concept policyActionExecutionType)
          Creates a populated Policy Action Template instance
 Policy createCopy(Policy policy)
          Creates a copy of the policy
 Policy createPolicy(PolicyType policyType, java.lang.String name, java.lang.String description, boolean isGlobal)
          Creates a Policy object with the given parameters
 PolicyCondition createPolicyCondition(java.util.List<Condition> conditions)
          Creates a policy condition object with the given list of conditions
 PolicyParameter createPolicyParameter(PolicyActionParameter actionParameter)
          Creates a Policy Parameter for the given Action Parameter
 Policy createVersion(Policy oldVersion)
          Creates a new version of the policy
 PolicyActionTemplate createVersion(PolicyActionTemplate oldPolicyAction)
          Create a new version of the policy action
 void deleteActionCategory(PolicyActionCategory actionCategory)
          Deletes the given Policy Action Category along with the Policy Action Templates under it
 void deleteActionTemplate(PolicyActionTemplate actionTemplate)
          Deletes the given Policy Action Template along with the corresponding Policy Action Parameters
 void deletePolicy(Policy policy)
          Deletes the given Policy along with the corresponding Policy Parameters
 void deletePolicyRegistryObjects(java.util.Collection<PolicyRegistryObject> policyRegistryObjects)
          Delete the given collection of policy registry objects.
 void saveActionCategory(PolicyActionCategory actionCategory)
          Saves the given Policy Action Category
 void saveActionTemplate(PolicyActionTemplate actionTemplate)
          Saves the given Policy Action Template along with the corresponding Policy Action Parameters
 void savePolicy(Policy policy)
          Saves the given Policy along with the corresponding Policy Parameters
 

Method Detail

createActionCategory

PolicyActionCategory createActionCategory(java.lang.String categoryName,
                                          PolicyType policyType)
                                          throws javax.xml.registry.JAXRException,
                                                 PolicyException
Creates an action category with the given category name

Parameters:
categoryName - name of the action category
policyType - whether Design/Change Time or Runtime
Returns:
populated PolicyActionCategory instance
Throws:
javax.xml.registry.JAXRException
PolicyException

saveActionCategory

void saveActionCategory(PolicyActionCategory actionCategory)
                        throws javax.xml.registry.JAXRException
Saves the given Policy Action Category

Parameters:
actionCategory - Policy Action Category to be saved
Throws:
javax.xml.registry.JAXRException

deleteActionCategory

void deleteActionCategory(PolicyActionCategory actionCategory)
                          throws javax.xml.registry.JAXRException,
                                 PolicyException
Deletes the given Policy Action Category along with the Policy Action Templates under it

Parameters:
actionCategory - Policy Action Category to be deleted
Throws:
javax.xml.registry.JAXRException
PolicyException

createActionTemplate

PolicyActionTemplate createActionTemplate(PolicyActionCategory actionCategory,
                                          java.lang.String name,
                                          java.lang.String description,
                                          javax.xml.registry.infomodel.Concept policyActionExecutionType)
                                          throws PolicyException,
                                                 javax.xml.registry.JAXRException
Creates a populated Policy Action Template instance

Parameters:
actionCategory - Policy Action Category under which this Action Template is to be added
name - name of the Action Template
description - description of the Action Template
policyActionExecutionType - Type of the Policy Action Execution for example, Java, Groovy ,etc
Returns:
populated Policy Action Template instance
Throws:
PolicyException
javax.xml.registry.JAXRException

createVersion

PolicyActionTemplate createVersion(PolicyActionTemplate oldPolicyAction)
                                   throws javax.xml.registry.JAXRException,
                                          PolicyException
Create a new version of the policy action

Parameters:
oldPolicyAction - policy action which needs to be versioned
Returns:
new version of the policy action
Throws:
javax.xml.registry.JAXRException
PolicyException

saveActionTemplate

void saveActionTemplate(PolicyActionTemplate actionTemplate)
                        throws javax.xml.registry.JAXRException,
                               PolicyException
Saves the given Policy Action Template along with the corresponding Policy Action Parameters

Parameters:
actionTemplate - Policy Action Template to be saved
Throws:
javax.xml.registry.JAXRException
PolicyException

deleteActionTemplate

void deleteActionTemplate(PolicyActionTemplate actionTemplate)
                          throws javax.xml.registry.JAXRException,
                                 PolicyException
Deletes the given Policy Action Template along with the corresponding Policy Action Parameters

Parameters:
actionTemplate - Policy Action Template to be deleted
Throws:
javax.xml.registry.JAXRException
PolicyException

createActionParameter

PolicyActionParameter createActionParameter(java.lang.String type,
                                            java.lang.String name)
                                            throws javax.xml.registry.JAXRException,
                                                   PolicyException
Creates a Policy Action Parameter with the given name and type

Parameters:
type - type of the action parameter
name - name of the action parameter
Returns:
PolicyActionParameter
Throws:
javax.xml.registry.JAXRException
PolicyException

createPolicy

Policy createPolicy(PolicyType policyType,
                    java.lang.String name,
                    java.lang.String description,
                    boolean isGlobal)
                    throws javax.xml.registry.JAXRException,
                           PolicyException
Creates a Policy object with the given parameters

Parameters:
policyType - Type of the policy whether Design/Change Time or Runtime
name - name of the policy
description - description of the policy
isGlobal - whether this policy is to be applicable for all organizations or only the organization to which it belongs.
Returns:
Policy object populated with the given parameters
Throws:
javax.xml.registry.JAXRException
PolicyException

createVersion

Policy createVersion(Policy oldVersion)
                     throws javax.xml.registry.JAXRException,
                            PolicyException
Creates a new version of the policy

Parameters:
oldVersion -
Throws:
javax.xml.registry.JAXRException
PolicyException

createCopy

Policy createCopy(Policy policy)
                  throws javax.xml.registry.JAXRException,
                         PolicyException
Creates a copy of the policy

Parameters:
policy -
Throws:
javax.xml.registry.JAXRException
PolicyException

savePolicy

void savePolicy(Policy policy)
                throws javax.xml.registry.JAXRException,
                       PolicyException
Saves the given Policy along with the corresponding Policy Parameters

Parameters:
policy - policy to be saved
Throws:
javax.xml.registry.JAXRException
PolicyException

deletePolicy

void deletePolicy(Policy policy)
                  throws javax.xml.registry.JAXRException,
                         PolicyException
Deletes the given Policy along with the corresponding Policy Parameters

Parameters:
policy - policy to be deleted
Throws:
javax.xml.registry.JAXRException
PolicyException

deletePolicyRegistryObjects

void deletePolicyRegistryObjects(java.util.Collection<PolicyRegistryObject> policyRegistryObjects)
                                 throws javax.xml.registry.JAXRException,
                                        PolicyException
Delete the given collection of policy registry objects.

Parameters:
policyRegistryObjects -
Throws:
javax.xml.registry.JAXRException
PolicyException

createActionInstance

PolicyActionInstance createActionInstance(PolicyActionTemplate policyAction)
                                          throws javax.xml.registry.JAXRException,
                                                 PolicyException
Creates a Policy Action Instance for the given Policy Action

Parameters:
policyAction - Policy Action for which the action instance is to be created
Returns:
PolicyActionInstance
Throws:
javax.xml.registry.JAXRException
PolicyException

createPolicyParameter

PolicyParameter createPolicyParameter(PolicyActionParameter actionParameter)
                                      throws javax.xml.registry.JAXRException,
                                             PolicyException
Creates a Policy Parameter for the given Action Parameter

Parameters:
actionParameter - action parameter based on which the policy parameter is to be created
Returns:
instance of Policy Parameter based on the given action parameter
Throws:
javax.xml.registry.JAXRException
PolicyException

createPolicyCondition

PolicyCondition createPolicyCondition(java.util.List<Condition> conditions)
                                      throws javax.xml.registry.JAXRException,
                                             PolicyException
Creates a policy condition object with the given list of conditions

Parameters:
conditions - with which policy condition is to be constructed.
Returns:
PolicyCondition object with the given list of conditions
Throws:
javax.xml.registry.JAXRException
PolicyException