public interface ManageRuntimePolicyAction extends CSOAction
Action States : Initial ---> ConfigurePolicyDetails ---> ConfigurePolicyActions --> DeployAliases --> ShowDeploymentStatus --> Completed (Basic Information, Configure Policy Constraints) (Select the aliases need to reload) Policy Life Cycle : New --> Production --> Suspended --> Retried 1) current State is ConfigurePolicyActions and create flag set to true, Create the Policy( policy in New state ) 2) current State is DeployAliases and activate flag set to true, Create the Policy and Change the state of the policy to Production so this policy is applicable to the newly deployed virtual instances which satisfy the policy constraints. 3) current state is ConfigurePolicyDetails, mandatory properties are not specified like name, organization, asset types, then throw the meaning full exception. 4) current State is ConfigurePolicyActions and without configuring any actions trying to create or perform the execute next step, throw the meaning full exception. 5) current state is DeployAliases and without select any gateways, perform execute next step, throw the meaning full exception.
Modifier and Type | Method and Description |
---|---|
boolean |
canCreateGlobalPolicy()
return true - in case user can able to create the global policy.
|
java.util.Collection<? extends CentraSiteObject> |
getAliases()
get the list of aliases which are deployed.
|
java.util.Collection<CentraSiteObjectAttribute> |
getApplicableAttributes()
return the list of attribute which can be used in the filter criteria.
|
java.util.List<Gateway> |
getApplicableGateways()
return the list of gateways which are available.
|
java.util.List<Organization> |
getApplicableOrganizations()
Gets the applicable organizations for the logged in user.
|
java.util.Collection<CentraSiteRegistryObjectType> |
getApplicableTypes()
list of types, can be render in the filter
|
java.lang.String |
getDescription()
get the description about the policy
|
java.util.Map<Gateway,java.lang.String> |
getFailedDeploymentMessages()
in case deployment failed, return the reason for the deployment failure
respective gateway
|
MessageFlow |
getMessageFlow()
get the MessageFlow based on the configured runtime policy actions
|
Organization |
getOrganization()
get the policy organization
|
PolicyActionTree |
getPolicyActionTree()
return the PolicyActionTree which used to render the Accordian (Populate
the actions which are applicable to all the types specified in the scope)
|
java.lang.String |
getPolicyName()
get the name of the policy
|
int |
getProgress()
get the progress of the deployment
|
java.util.Collection<CSOSearchCondition> |
getSelectedConditions()
list of conditions which is created by the user , in case of editing the
existing runtime policy, return the condition configured to the runtime
policy
|
java.util.Collection<CentraSiteRegistryObjectType> |
getSelectedTypes()
list of types which is selected by user , in case of editing the existing
runtime policy , return the types configured to the runtime policy
|
java.lang.String |
getVersion()
get the policy version
|
boolean |
isEditEnabled()
Checks if edit is allowed based on the LCM state.
|
boolean |
isGlobal()
true in case of policy is applicable to all the organizations
|
boolean |
isUserCanPublish()
Check whether the logged in user has appropriate roles to perform the publish
|
void |
setActivate(boolean activate)
set the flag to true in case of policy need base created & change the
state of the policy to Production, so policy applied to the newly
published applicable assets
|
void |
setConditions(java.util.Collection<CSOSearchCondition> conditions)
construct the CSOSearchCondition based on the additional filter criteria
|
void |
setCreate(boolean create)
in case user set the create policy set true and perform the
executeNextStep policy get created and action state changes to completed
|
void |
setDescription(java.lang.String policyDesc)
set the description of the policy
|
void |
setGateways(java.util.Collection<Gateway> gatewaysForDeployment)
the gateways which are selected for by the user to redeploy the assets
which matches the policy contraints.
|
void |
setGlobal(boolean isApplicableToAllOrganizations)
set the flag to true in case of policy applicable to all the
organizations
|
void |
setMessageFlow(MessageFlow messageFlow)
set the MessageFlow constructed based on the configured runtime policy
actions
|
void |
setOrganization(Organization organization)
organization to which the policy is applicable
in case of the organization not specified, Administrator organization
assigned as submitting organization
|
void |
setPolicyName(java.lang.String policyName)
set the name for the policy
|
void |
setSelectedTypes(java.util.Collection<CentraSiteRegistryObjectType> types)
set the applicable type of the runtime policy
in case of empty or null specified throw an exception
|
void |
setVersion(java.lang.String version)
set the policy version
|
cancel, doesLoggedInUserHaveSufficientRolesOrPermissions, executeNextStep, executePreviousStep, finishAllSteps, getCurrentState, getGroup, getIconURL, getId, getName, getNonApplicableReason, getSkippedObjectsWithReason, isAllowed, isApplicable, setObjects
java.lang.String getPolicyName() throws CLLException
String
value for the name of the policy.CLLException
- If an error occurs while fetching the name of the policyvoid setPolicyName(java.lang.String policyName) throws CLLException
policyName
- the name for the policyCLLException
java.lang.String getDescription() throws CLLException
CLLException
void setDescription(java.lang.String policyDesc) throws CLLException
policyDesc
- description about the policyCLLException
java.lang.String getVersion() throws CLLException
CLLException
void setVersion(java.lang.String version) throws CLLException
version
- the policy versionCLLException
void setSelectedTypes(java.util.Collection<CentraSiteRegistryObjectType> types) throws CLLException
types
- the types to which belongsCLLException
- If an error occurs while setting the selected typesvoid setConditions(java.util.Collection<CSOSearchCondition> conditions) throws CLLException
conditions
- set of the condition which used to filter the assets to which
policy is applicableCLLException
void setOrganization(Organization organization) throws CLLException
organization
- The organization of this Runtime policy.CLLException
- If an error occurs while setting the OrganizationOrganization getOrganization() throws CLLException
CLLException
void setGlobal(boolean isApplicableToAllOrganizations) throws CLLException
isApplicableToAllOrganizations
- is applicable to organizationsCLLException
- If an error occurs while setting the global propertyboolean isGlobal() throws CLLException
CLLException
- If an error occurs while setting the global propertyPolicyActionTree getPolicyActionTree() throws CLLException
CLLException
- while populating the policy action tree with appropriate
actions applicable to object types specifiedvoid setMessageFlow(MessageFlow messageFlow) throws CLLException
messageFlow
- MessageFlow which contains the actions selected by the userCLLException
- If setting the messages flows throws an errorMessageFlow getMessageFlow() throws CLLException
CLLException
- in case of populating the default MessageFlow with the
configured policy actionsvoid setCreate(boolean create)
create
- true - create the policy with the configured filter criteria
and policy actionsvoid setActivate(boolean activate)
activate
- true - activate the policy, in case set to false and perform
the execute next step it appropriate inputs not specified to
perform the publish throws an exceptionjava.util.Collection<CentraSiteRegistryObjectType> getApplicableTypes() throws CLLException
CLLException
- in case failed to get the applicable typesjava.util.Collection<CentraSiteRegistryObjectType> getSelectedTypes() throws CLLException
CLLException
java.util.Collection<CSOSearchCondition> getSelectedConditions() throws CLLException
CLLException
- in case of failing to get the conditions of the runtime
policyjava.util.Collection<CentraSiteObjectAttribute> getApplicableAttributes() throws CLLException
CLLException
- in case of failed to construct the attributesjava.util.List<Organization> getApplicableOrganizations() throws CLLException
CLLException
java.util.List<Gateway> getApplicableGateways() throws CLLException
CLLException
- in case of failed to get the gateways availablevoid setGateways(java.util.Collection<Gateway> gatewaysForDeployment)
gatewaysForDeployment
- gateways which are selected for by the user to redeploy the assetsjava.util.Map<Gateway,java.lang.String> getFailedDeploymentMessages() throws CLLException
CLLException
- failed to get the Deployment failure messagesint getProgress() throws CLLException
CLLException
- in case of failed to get the progress count.java.util.Collection<? extends CentraSiteObject> getAliases() throws CLLException
CLLException
- in case of failed to get the deployed assetsboolean isUserCanPublish() throws CLLException
CLLException
- in case check weather user have appropriate roles.boolean canCreateGlobalPolicy() throws CLLException
CLLException
- in case failing to find weather user can able create the
global policyboolean isEditEnabled() throws CLLException
CLLException