public interface ManageRuntimeAliasAction extends CSOAction, RuntimeAliasesPublishAction
This is the First state where the user has configured the Type,Name and description of the Alias
In this stage the user enters the Default values and the Stage specific values for the Alias
This stage is a superset of the Above stage where the user enters the details ansd in addition deploys it to all gateways.
Modifier and Type | Method and Description |
---|---|
java.lang.String |
createExtrinsicObjectFromFile(CentraSiteFile centraSiteFile)
Create an Extrinsic object from the given ID
|
java.lang.String |
getAliasName()
Gets the Name of the Runtime alias.
|
java.util.Map<java.lang.String,java.lang.String> |
getAllAliasTypes()
Gets all the Alias Types available.
|
java.util.Map |
getAllAssociatedServices()
Get Collection of Services that are associated to this Runtime alias.
|
java.util.List<Gateway> |
getAllGateways()
Gets
Collection of Gateway for publish of the Runtime alias. |
java.util.Map<java.lang.String,java.lang.String> |
getAllSecureAliasAuthSchemes()
Gets Authentication Schemes available for Secure alias.
|
java.util.Map |
getApplicableAttibutesForAlias()
Gets the Applicable Attributes for the Runtime alias.
|
java.util.Map<java.lang.String,java.lang.String> |
getDefaultValues()
Get the default values for the Runtime alias.
|
java.lang.String |
getDescription()
Gets the description of the Runtime alias.
|
java.lang.String |
getSelectedAliasType()
Gets the Type of the Runtime alias .
|
java.lang.String |
getSelectedSecureAuthScheme()
Gets the Secure Alias authentication scheme.
|
boolean |
isDeployed()
Sets whether the Runtime alias is deployed to any
Gateway . |
boolean |
isEdit()
Gets whether the action is editing an already existing Runtime alias.
|
boolean |
isPrevious()
Gets whether to execute the previous state of the Action.
|
boolean |
isPublish()
Gets whether save of Runtime alias should be accompanished with a publish.
|
void |
setAliasName(java.lang.String name)
Sets the Name of the Runtime alias.
|
void |
setAllGateways(java.util.List<Gateway> allGateways)
Sets
Collection of Gateway for publish of the Runtime alias. |
void |
setAllSecureAliasAuthSchemes(java.util.Map<java.lang.String,java.lang.String> authScheme)
Sets Authentication Schemes for Secure alias.
|
void |
setApplicableAttributesForAlias(java.util.Map props)
Sets the Applicable Attributes for the Runtime alias.
|
void |
setDefaultValues(java.util.Map<java.lang.String,java.lang.String> val)
Sets the default values for the Alias.
|
void |
setDescription(java.lang.String policyDesc)
Sets the description of the Runtime alias .
|
void |
setEdit(boolean edit)
Sets whether the action is editing an already existing Runtime alias.
|
void |
setPrevious(boolean prev)
Sets whether to execute the previous state of the Action.
|
void |
setPublish(boolean pub)
Sets whether save of Runtime alias should be accompanished with a publish.
|
void |
setSelectedAliasType(java.lang.String type)
Sets the type of the Runtime alias.
|
void |
setSelectedSecureAuthScheme(java.lang.String type)
Sets the Secure Alias authentication scheme.
|
getAllAliasesToDeploy, getFailedAPIPortals, getFailedDeploymentResponses, setAliasesToDeploy
getAliases, 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
java.lang.String getAliasName() throws java.lang.Exception
java.lang.Exception
- If an error occurs while fetching the Runtime alias namevoid setAliasName(java.lang.String name) throws java.lang.Exception
name
- Name of the Runtime aliasjava.lang.Exception
- If an error occurs while setting the Runtime alias namejava.lang.String getSelectedAliasType() throws java.lang.Exception
java.lang.Exception
- If an error occurs while fetching the Runtime alias typevoid setSelectedAliasType(java.lang.String type) throws java.lang.Exception
type
- The type of the Runtime alias i.e Simple,End-point or Securejava.lang.Exception
- If an error occurs while setting the Runtime alias typejava.lang.String getSelectedSecureAuthScheme() throws java.lang.Exception
java.lang.Exception
- If an error occurs while fetching the Authentication schemevoid setSelectedSecureAuthScheme(java.lang.String type) throws java.lang.Exception
type
- Authentication scheme of the Secure Aliasjava.lang.Exception
- If an error occurs while setting the Authentication schemejava.lang.String getDescription() throws java.lang.Exception
java.lang.Exception
- If an error occurs while fetching the description of the Runtime Aliasvoid setDescription(java.lang.String policyDesc) throws java.lang.Exception
policyDesc
- The description of the Runtime aliasjava.lang.Exception
- If an error occurs while getting the description of the Runtime Aliasjava.util.Map getApplicableAttibutesForAlias()
Map
of attributes having the Runtime alias as key and attributes as values.void setApplicableAttributesForAlias(java.util.Map props)
props
- Map
of attributes having the Runtime alias as key and attributes as values.java.util.Map<java.lang.String,java.lang.String> getAllAliasTypes()
Map
of attributes having the Runtime alias type name as key and name (i.e Simple,Endpoint and Secure Aliases)as valuesvoid setAllGateways(java.util.List<Gateway> allGateways)
Collection
of Gateway
for publish of the Runtime alias.allGateways
- Collection
of Gateway
for publish of the Runtime aliasjava.util.List<Gateway> getAllGateways()
Collection
of Gateway
for publish of the Runtime alias.Collection
of Gateway
for publish of the Runtime aliasvoid setAllSecureAliasAuthSchemes(java.util.Map<java.lang.String,java.lang.String> authScheme)
authScheme
- Map
of Secure alias Authentication Schemes having the Scheme name as key and display name as value.java.util.Map<java.lang.String,java.lang.String> getAllSecureAliasAuthSchemes()
Map
of Secure alias Authentication Schemes having the Scheme name as key and display name as value.java.util.Map<java.lang.String,java.lang.String> getDefaultValues()
Map
of default values having the attribute name as key and the attribute value as value.void setDefaultValues(java.util.Map<java.lang.String,java.lang.String> val)
val
- Map
of default values having the attribute name as key and the attribute value as value.java.util.Map getAllAssociatedServices()
Map
of Services that are associated to the Runtime alias having the service key as key and the display name as nameboolean isPublish()
true
if the save of Runtime alias is accompanished with a publishvoid setPublish(boolean pub)
pub
- If true
then the save of Runtime alias is accompanished with a publishboolean isEdit()
true
if the action is editing an already existing Runtime alias,rather than creating onevoid setEdit(boolean edit)
edit
- If true
then action will edit an already existing Runtime alias,rather than creating oneboolean isPrevious()
true
if the action is executing the previous state of the current statevoid setPrevious(boolean prev)
prev
- If true
then the action executes the previous state of the current state.boolean isDeployed()
Gateway
.true
if the Runtime alias is deployed to any Gateway
.java.lang.String createExtrinsicObjectFromFile(CentraSiteFile centraSiteFile) throws CLLException
files
- CLLException