public interface VirtualizeAction extends PublishAction
The state change sequences of VirtualizeAction: _ _ _ _ _ _ _ _ _ _ _ _ | | | | | INITIAL | ---> CONFIGURE_ENDPOINTS ---> CONFIGURE_POLICY_ACTIONS ---> CONFIGURE_GATEWAYS ---> SHOW_DEPLOYMENT_STATUS ---> | COMPLETED | |_ _ _ _ _ _| |_ _ _ _ _ _|
Modifier and Type | Interface and Description |
---|---|
static class |
VirtualizeAction.ResourceCondition
This enum is applicable ONLY for virtualization of existing aliases for REST services.
|
Modifier and Type | Method and Description |
---|---|
java.util.List<CentraSiteRegistryObject> |
getAliases()
Returns the existing alias for the selected service.
|
java.util.List<java.lang.String> |
getAllRuntimeAliases(java.util.List<java.lang.String> type)
Returns all the runtime aliases for the given type.
|
java.util.List<Gateway> |
getDeployedGateways()
Gets the list of gateways to deploy.
|
java.lang.String |
getEndpointName(java.lang.String endpointId)
Gets the endpoint name from the endpoint id.
|
java.util.Map<java.lang.String,java.lang.String> |
getEndPoints()
Gets the endpoints supported by the Service.
|
boolean |
getEnforceActionCondition()
Gets the enforce action condition.
|
java.util.Map<java.lang.String,java.lang.String> |
getInvokeURLMap() |
MessageFlow |
getMessageFlow()
Gets the
MessageFlow . |
java.util.List<java.lang.String> |
getMessageFlowSteps(java.lang.String policyActionTemplateId)
This method gets the message flow steps applicable for the given policy action template.
|
PolicyActionTree |
getPolicyActionsTree()
Gets the
PolicyActionTree , which is used to render PolicyActionTemplates in
hierarchical order. |
java.util.Collection<APIPortal> |
getRegisteredApiPortals()
returns the list of registered API-Portals
|
java.util.List<Resource> |
getResources()
Gets the list of all resources that are applicable to be virtualized.
|
java.util.Map<Resource,VirtualizeAction.ResourceCondition> |
getResourcesForAliasSynchronization(CentraSiteRegistryObject virtualAlias)
For a given virtual alias, this method compares the native and virtual service resources
and gives a
Map indicating the state of synchronization between the two. |
java.util.List<Resource> |
getSelectableResources()
Gets the list of all resources from a native service that are applicable to be virtualized.
|
java.lang.String |
getSelectedEndPoint(java.lang.String aliasId)
Return the selected end point for the given alias.
|
java.util.List<CentraSiteRegistryObject> |
getVirtualizableAliases()
Returns the alias which are able to virtualize for the selected service.
|
java.lang.String |
getVirtualServiceId()
Return the VirtualService ID of the native service just virtualized
|
boolean |
isDuplicateAliasName(java.lang.String aliasName)
Checks if the given alias already exists with virtual instances.
|
boolean |
isToIgnoreResourcePath()
Check if to display the resource name only or together with its resource path
|
boolean |
isUserCanPublish()
Checks if the logged in user can publish to Mediator.
|
boolean |
isValidNcName(java.lang.String virtualAliasName)
Checks if the given alias name is NCName valid.
|
void |
setAliasName(java.lang.String aliasName)
Sets the alias name.
|
void |
setEndPointOrResource(java.lang.String endPointOrResourceId)
Sets the user selected end point for service or resource for REST/XML service.
|
void |
setEnforceActionCondition(boolean enforceActionCondition)
Sets the AND/OR condition for enforcing actions.
|
void |
setExistingAlias(java.lang.String aliasId)
Sets the existing alias id.
|
void |
setInvokeURL(java.lang.String invokeURL)
Checks if the given alias name is NCName valid else replace with '_' character.
|
void |
setMessageFlow(MessageFlow messageFlow)
Set the
MessageFlow constructed with the user selected policy Actions. |
void |
setResourcesForAliasSynchronization(java.util.Set<java.lang.String> resourcesToSynchronizeFromNative,
java.util.Set<java.lang.String> resourcesToRetainInVirtual)
This method is called to set the resources to retain with the Virtual service and
the resources to synchronize from the native service.
|
void |
setSelectedResources(java.util.List<java.lang.String> selectedResources)
Sets the Resources to be virtualized.
|
void |
setVirtualize(boolean virtualize)
In case this is set to true, perform the virtualization without publishing and Virtualize
Action gets completed.
|
getAliasListForUnDeploy, getApplicableGateways, getFailedDeploymentMessages, getProgress, getSelectedAliases, getUnPublishAliasList, isBaseType, setAliasListForUnDeploy, setGateways, setSelectedAliases, setVisibleToEveryOne
cancel, doesLoggedInUserHaveSufficientRolesOrPermissions, executeNextStep, executePreviousStep, finishAllSteps, getCurrentState, getGroup, getIconURL, getId, getName, getNonApplicableReason, getSkippedObjectsWithReason, isAllowed, isApplicable, setObjects
void setAliasName(java.lang.String aliasName)
aliasName
- the alias name to setjava.util.Map<java.lang.String,java.lang.String> getEndPoints() throws CLLException
Map
having the
service binding id as the key and the access URI as the value.CLLException
- If an error occurs while trying to find the service bindings for the service
or while trying to get the access URI for a service bindingvoid setEndPointOrResource(java.lang.String endPointOrResourceId)
endPointOrResourceId
- end point or resource identifier.java.util.List<Resource> getResources() throws CLLException
List
of Resource
s applicable for virtualizationCLLException
- If an error occurs while getting the applicable resourcesjava.util.List<Resource> getSelectableResources() throws CLLException
getResources()
.List
of Resource
s applicable for virtualizationCLLException
- If an error occurs while getting the applicable resourcesboolean isToIgnoreResourcePath() throws CLLException
CLLException
void setSelectedResources(java.util.List<java.lang.String> selectedResources) throws CLLException
selectedResources
- The List
of resource paths corresponding to the resources to be virtualizedCLLException
- If an error occurred while trying to set the resources to be virtualizedvoid setExistingAlias(java.lang.String aliasId)
aliasId
- set the exiting virtual alias id.java.util.List<CentraSiteRegistryObject> getAliases() throws CLLException
getAliases
in interface PublishAction
CLLException
- If an error is encountered while trying to get the aliasesjava.util.List<CentraSiteRegistryObject> getVirtualizableAliases() throws CLLException
CLLException
- If an error is encountered while trying to get the aliasesjava.util.Map<Resource,VirtualizeAction.ResourceCondition> getResourcesForAliasSynchronization(CentraSiteRegistryObject virtualAlias) throws CLLException
Map
indicating the state of synchronization between the two. For more
information, about the resource synchronization, refer to the example provided in
VirtualizeAction.ResourceCondition
.
This method is applicable ONLY when it is required to reconfigure an existing alias
to synchronize the resources between the native and virtual services. It also applies
only to REST/XML services.virtualAlias
- The virtual alias of the native service
with which the synchronization is to be performed.Map
indicating the VirtualizeAction.ResourceCondition
for each Resource
.
For VirtualizeAction.ResourceCondition.VIRTUAL_ONLY_RESOURCE
, the Resource
object in the
map's key will belong to the given virtual alias. All the other resources in the map's key
belong to the native service.CLLException
- If an error occurs while obtaining the resources for synchronizationvoid setResourcesForAliasSynchronization(java.util.Set<java.lang.String> resourcesToSynchronizeFromNative, java.util.Set<java.lang.String> resourcesToRetainInVirtual) throws CLLException
VirtualizeAction
is in the state CONFIGURE_ENDPOINTS after calling
the method setExistingAlias(String)
. If both the given parameters
are null or empty, then resource synchronization does not happen for the virtual service
and the existing resources of the virtual service are retained.resourcesToSynchronizeFromNative
- The Set
of resource paths
of the native service which should be cloned to the virtual REST/XML service. If
null
, no resources from the native service will be synchronized with the
virtual service.resourcesToRetainInVirtual
- The Set
of resource paths
of the virtual REST/XML service which should be retained during synchronization. If
null
, all existing resources of the virtual REST/XML service will be
removed and only the resources specified in resourcesToSynchronizeFromNative collection
will be available in the virtual service once the action has completed.CLLException
- If an error occurs while setting the resources for synchronization or if
the same path is given in both the parameters "resourcesToSynchronizeFromNative" and
"resourcesToRetainInVirtual" since this indicates ambiguity.void setVirtualize(boolean virtualize)
virtualize
- true - in case of user want to Virtualize with out publishing the asset.PolicyActionTree getPolicyActionsTree() throws CLLException
PolicyActionTree
, which is used to render PolicyActionTemplates in
hierarchical order.PolicyActionTree
instanceCLLException
- In case of a failure to construct the PolicyActionTree instanceMessageFlow getMessageFlow() throws CLLException
MessageFlow
.MessageFlow
instanceCLLException
- In case of a failure to get the MessageFlow instancevoid setMessageFlow(MessageFlow messageFlow)
MessageFlow
constructed with the user selected policy Actions.messageFlow
- MessageFlow
to setvoid setEnforceActionCondition(boolean enforceActionCondition)
enforceActionCondition
- true - means OR will be used for enforcing actions condition,
false - means AND will be used for enforcing actions conditionboolean getEnforceActionCondition() throws CLLException
CLLException
- If an error is encountered trying to get the valuejava.util.List<java.lang.String> getMessageFlowSteps(java.lang.String policyActionTemplateId) throws CLLException
policyActionTemplateId
- CentraSiteObject.getId()
List
of message flow steps identifiersCLLException
- In case of a failure to find the applicable message flow steps.java.lang.String getSelectedEndPoint(java.lang.String aliasId) throws CLLException
aliasId
- alias identifier.CLLException
- In case of a failure to find the selected endpoint for the given alias.java.lang.String getEndpointName(java.lang.String endpointId) throws CLLException
endpointId
- The endpoint id.CLLException
- If an error occurs while trying to get the endpoint nameboolean isUserCanPublish() throws CLLException
CLLException
- If an error occurs while trying to perform the checkjava.util.List<Gateway> getDeployedGateways() throws CLLException
List
of Gateway
s to deploy.CLLException
- If an error occurs while trying to get the deployed gatewaysboolean isDuplicateAliasName(java.lang.String aliasName) throws CLLException
aliasName
- The alias name to check.CLLException
- If an error occurs while trying to check for the duplicate aliasesjava.lang.String getVirtualServiceId()
java.util.List<java.lang.String> getAllRuntimeAliases(java.util.List<java.lang.String> type) throws CLLException
type
- The alias typesList
of runtime alias names as StringCLLException
- If an error occurs while getting the runtime aliases for the given typesboolean isValidNcName(java.lang.String virtualAliasName)
virtualAliasName
- The alias name to checktrue
if the alias is a valid NCName and false
otherwisejava.util.Collection<APIPortal> getRegisteredApiPortals() throws CLLException
List
of registered portals as APIPortalCLLException
void setInvokeURL(java.lang.String invokeURL)
virtualAliasName
- The alias name to checkjava.util.Map<java.lang.String,java.lang.String> getInvokeURLMap() throws CLLException
CLLException