public interface AddAPIPortalAction extends CSOAction
AddAPIPortalAction
supports to add new API-Portal in CentraSite with the below details.
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getCentraSiteEndpoint()
Gets the centrasiteEndpoint of the API-Portal
|
java.util.List<Organization> |
getConsumerOrganizations()
Gets the applicable consumer organizations for the logged in user.
|
java.util.Collection<APIPortal> |
getFailedAPIPortals()
Get the Collection of Failed API Portal responses.
|
java.lang.String |
getPortalTenantId()
Gets the portal tenant id of the API-Portal
|
java.util.List<Organization> |
getProviderOrganizations()
Gets the applicable provider organizations for the logged in user.
|
java.lang.String |
getRetryCount()
Gets the retryCount for contacting API-Portal
|
java.lang.String |
getRetryIntervals()
Gets the Retry Interval between each retry
|
boolean |
isRetryEnabled()
Gets whether the Retry Mechanism is enabled or not
|
void |
setCentraSiteUserId(java.lang.String centrasiteUserId)
Sets CentraSite user id of the API-Portal.
|
void |
setCentraSiteUserPwd(java.lang.String centrasiteUserPwd)
Sets CentraSite user password of the API-Portal.
|
void |
setConsumerOrganization(Organization organization)
Sets the consumer organization to
APIPortal where the webMethods API-Portal users will be created in CentraSite when the user requests API key for an API. |
void |
setConsumerOrganizationName(java.lang.String consumerOrgName)
Sets the name of the consumer organization that is going to be created and dedicated for the API-Portal.
|
void |
setDedicatedConsumerOrganization(boolean isDedicatedConsumerOrgToBeCreated)
Sets whether it is required to create a dedicated consumer organization for the API-Portal.
|
void |
setDescription(java.lang.String portalDesc)
Sets description of the API-Portal.
|
void |
setEndpoint(java.lang.String endPoint)
Sets the end point of the webMethods API-Portal to
APIPortal |
void |
setName(java.lang.String portalName)
Sets name of the API-Portal
|
void |
setOrganization(Organization providerOrganization)
Sets the submitting organization for
APIPortal . |
void |
setPassword(java.lang.String password)
Sets the password to
APIPortal which will be used for authenticating against the API-Portal. |
void |
setPortalTenantId(java.lang.String portalTenantId)
Sets Portal tenant id of the API-Portal.
|
void |
setPublish(boolean isPublish)
Set whether the CentraSite should be registered with API-Portal along with the save
|
void |
setRetryCount(java.lang.String retryCount)
Sets retry count for reaching API-Portal.
|
void |
setRetryEnabled(boolean isRetryEnabled)
Sets whether the Retry Mechanism is enabled or not
|
void |
setRetryIntervals(java.lang.String retryInterval)
Sets the Retry Intervals between each retry
|
void |
setUserName(java.lang.String userName)
Sets the user id to
APIPortal which will be used for authenticating against the API-Portal. |
cancel, doesLoggedInUserHaveSufficientRolesOrPermissions, executeNextStep, executePreviousStep, finishAllSteps, getCurrentState, getGroup, getIconURL, getId, getName, getNonApplicableReason, getSkippedObjectsWithReason, isAllowed, isApplicable, setObjects
void setName(java.lang.String portalName)
portalName
- The name of the API-Portalvoid setDescription(java.lang.String portalDesc)
portalDesc
- The API-Portal description to setvoid setEndpoint(java.lang.String endPoint)
APIPortal
endPoint
- the endpoint of the webMethods API-Portalvoid setUserName(java.lang.String userName)
APIPortal
which will be used for authenticating against the API-Portal.userName
- String
value as user id.void setPassword(java.lang.String password)
APIPortal
which will be used for authenticating against the API-Portal.password
- String
value as password.void setDedicatedConsumerOrganization(boolean isDedicatedConsumerOrgToBeCreated)
isDedicatedConsumerOrgToBeCreated
- true if needs dedicated new organization; otherwise will be shared with any chosen existing organization.void setPublish(boolean isPublish)
isPublish
- If true
, then CentraSite will be registered with the API-Portal after savevoid setConsumerOrganizationName(java.lang.String consumerOrgName)
consumerOrgName
- String
value as the name of the consumer organization.void setConsumerOrganization(Organization organization)
APIPortal
where the webMethods API-Portal users will be created in CentraSite when the user requests API key for an API.organization
- the Organization
exists in CentraSite.void setPortalTenantId(java.lang.String portalTenantId)
portalTenantId
- The API-Portal tenant id.void setCentraSiteUserId(java.lang.String centrasiteUserId)
centrasiteUserId
- The username for CentraSitevoid setCentraSiteUserPwd(java.lang.String centrasiteUserPwd)
centrasiteUserPwd
- The CentraSite user's passwordjava.lang.String getCentraSiteEndpoint()
String
java.lang.String getPortalTenantId()
String
void setOrganization(Organization providerOrganization)
APIPortal
.providerOrganization
- The API provider's organizationjava.util.List<Organization> getProviderOrganizations() throws CLLException
CLLException
- If an error occurs while getting the organizationsjava.util.List<Organization> getConsumerOrganizations() throws CLLException
CLLException
- If an error occurs while getting the organizationsjava.util.Collection<APIPortal> getFailedAPIPortals() throws CLLException
Collection
of APIPortal
objects which had failures in registering CentraSiteCLLException
- If an error occurs while getting the failed API-Portal objectsvoid setRetryEnabled(boolean isRetryEnabled)
isRetryEnabled
- Retry Mechanism is enabled or notvoid setRetryCount(java.lang.String retryCount)
retryCount
- The retryCount to reach API-Portalvoid setRetryIntervals(java.lang.String retryInterval)
retryIntervals
- The Retry Interval between each retryboolean isRetryEnabled()
boolean
java.lang.String getRetryCount()
String
java.lang.String getRetryIntervals()
String