public class APIPortalConfiguration
extends java.lang.Object
Constructor and Description |
---|
APIPortalConfiguration() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAPIPortalId()
Gets the API-Portal object id
|
java.util.Collection<java.lang.String> |
getAPIPortalIdsForDeletion() |
java.lang.String |
getCentraSiteAlias()
Gets the CentraSite alias of the API-Portal.
|
java.lang.String |
getCentrasiteUserId()
The CentraSite Username provided during registration
|
java.lang.String |
getCentrasiteUserPwd()
The password for the CentraSite user
|
java.lang.String |
getConsumerOrganizationId()
Gets the consumer organization configured for API-Portal.
|
java.lang.String |
getConsumerOrganizationName()
Gets the name of the consumer organization, where a dedicated consumer organization will be created with this name.
|
java.lang.String |
getDescription()
Gets the description of the API-Portal.
|
java.lang.String |
getEncodedCentraSiteCred()
The Base64 encoded CentraSite credentials that is used to register CentraSite with API-Portal
|
java.lang.String |
getEndPoint()
Gets the end point of the webMethods API-Portal.
|
java.lang.String |
getExternalTomcatUrl()
The external TomcatURL used for communication with API-Portal
|
java.lang.String |
getLoggedInUserId()
Gets the logged in user to be used for consumer organization administrator.
|
java.lang.String |
getName()
Gets name of the API-Portal.
|
java.lang.String |
getPassword()
Gets the password of the API-Portal which will be used for authenticating against the API-Portal.
|
java.lang.String |
getPortalAlias()
Gets the portal alias of the API-Portal.
|
java.lang.String |
getPortalTenantId()
Gets the API-Portal tenant id
|
java.lang.String |
getProviderOrganizationId()
Gets the organization to which the API-Portal will belongs to in CentraSite.
|
java.lang.String |
getRetryCount() |
java.lang.String |
getRetryIntervals() |
java.lang.String |
getSandboxClassification() |
java.lang.String |
getUserId()
Gets the user id of the API-Portal which will be used for authenticating against the API-Portal.
|
boolean |
isDedicatedConsumerOrgToBeCreated()
Tells whether it is required to create a dedicated consumer organization for the API-Portal.
|
boolean |
isRegistered() |
boolean |
isRetryEnabled() |
void |
setAPIPortalId(java.lang.String apiPortalId)
Sets the API-Portal object id
|
void |
setAPIPortalIdsForDeletion(java.util.Collection<java.lang.String> apiPortalIds) |
void |
setCentraSiteAlias(java.lang.String centraSiteAlias)
Sets the alias of the CentraSite, which will be used by the API-Portal to delegate API Key requests/renewals/revokes from API-Portal users to CentraSite.
|
void |
setCentrasiteUserId(java.lang.String centrasiteUserId)
The username for CentraSite
|
void |
setCentrasiteUserPwd(java.lang.String centrasiteUserPwd)
The password value to set for the user
|
void |
setConsumerOrganizationId(java.lang.String consumerOrganizationId)
Sets the consumer organization to API-Portal, 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 description)
Sets the description of the API-portal.
|
void |
setEncodedCentraSiteCred(java.lang.String encodedCentraSiteCred)
Sets the Base 64 encoded CentraSite credentials
|
void |
setEndPoint(java.lang.String endPoint)
Sets the end point of the webMethods API-Portal
|
void |
setExternalTomcatUrl(java.lang.String externalTomcatUrl)
Sets the value of the external Tomcat URL
|
void |
setLoggedInUserId(java.lang.String loggedInUserId)
Set the current logged in user; usually the API-Portal Administrator user who is creating the portal.
|
void |
setName(java.lang.String name)
Sets name of the API-Portal.
|
void |
setPassword(java.lang.String password)
Sets the password of the API-Portal which will be used for authenticating against the API-Portal.
|
void |
setPortalAlias(java.lang.String portalAlias)
Sets the unique alias of the API-Portal which will be used for API-Portal identification in CentraSite.
|
void |
setPortalTenantId(java.lang.String portalTenantId)
Sets the API-Portal tenant id
|
void |
setProviderOrganizationId(java.lang.String providerOrganizationId)
Sets the organization to API-Portal to which the API-Portal will belongs to in CentraSite.
|
void |
setRegistered(boolean isRegistered) |
void |
setRetryCount(java.lang.String retryCount) |
void |
setRetryEnabled(boolean isRetryEnabled) |
void |
setRetryIntervals(java.lang.String retryIntervals) |
void |
setSandboxClassification(java.lang.String sandboxClassification) |
void |
setUserId(java.lang.String userId)
Sets the user id of the API-Portal which will be used for authenticating against the API-Portal.
|
public java.lang.String getName()
String
as the value of the API-Portal name.public void setName(java.lang.String name)
name
- String
the name of the API-Portal.public java.lang.String getDescription()
String
as the value of the API-Portal.public void setDescription(java.lang.String description)
description
- String
the description of the API-Portal.public java.lang.String getEndPoint()
String
The end point of the portal.public void setEndPoint(java.lang.String endPoint)
endPoint
- the endpoint of the webMethods API-Portalpublic java.lang.String getUserId()
String
the user id value.public void setUserId(java.lang.String userId)
userId
- String
value as user id.public java.lang.String getPassword()
String
value as password.public void setPassword(java.lang.String password)
password
- String
value as password.public java.lang.String getProviderOrganizationId()
String
id of the organization object.public void setProviderOrganizationId(java.lang.String providerOrganizationId)
providerOrganizationId
- the String
to which the API-Portal object belong to.public void setDedicatedConsumerOrganization(boolean isDedicatedConsumerOrgToBeCreated)
isDedicatedConsumerOrgToBeCreated
- true if needs dedicated new organization; otherwise will be shared with any chosen existing organization.public boolean isDedicatedConsumerOrgToBeCreated()
public void setConsumerOrganizationName(java.lang.String consumerOrgName)
consumerOrgName
- String
value as the name of the consumer organization.public java.lang.String getConsumerOrganizationName()
String
as the name of the organization.public java.lang.String getConsumerOrganizationId()
String
id of the organization object.public void setConsumerOrganizationId(java.lang.String consumerOrganizationId)
consumerOrganizationId
- the String
exists in CentraSite.public void setLoggedInUserId(java.lang.String loggedInUserId)
loggedInUserId
- The logged in user's UUID keypublic java.lang.String getLoggedInUserId()
public java.lang.String getPortalAlias()
String
the value of portal alias.public void setPortalAlias(java.lang.String portalAlias)
portalAlias
- The String
value for portal alias.public java.lang.String getCentraSiteAlias()
String
public void setCentraSiteAlias(java.lang.String centraSiteAlias)
centraSiteAlias
- The String
value for CentraSite aliaspublic void setAPIPortalId(java.lang.String apiPortalId)
apiPortalId
- The API-Portal id of the objectpublic java.lang.String getAPIPortalId()
public java.lang.String getPortalTenantId()
String
the value of portal tenant id.public void setPortalTenantId(java.lang.String portalTenantId)
portalTenantId
- The API-Portal tenant IDpublic java.lang.String getCentrasiteUserId()
public void setCentrasiteUserId(java.lang.String centrasiteUserId)
centrasiteUserId
- the centrasiteUserId to setpublic java.lang.String getCentrasiteUserPwd()
public void setCentrasiteUserPwd(java.lang.String centrasiteUserPwd)
centrasiteUserPwd
- the centrasiteUserPwd to setpublic java.lang.String getExternalTomcatUrl()
public void setExternalTomcatUrl(java.lang.String externalTomcatUrl)
externalTomcatUrl
- the externalTomcatUrl to setpublic java.lang.String getEncodedCentraSiteCred()
public void setEncodedCentraSiteCred(java.lang.String encodedCentraSiteCred)
encodedCentraSiteCred
- the encodedCentraSiteCred to setpublic void setAPIPortalIdsForDeletion(java.util.Collection<java.lang.String> apiPortalIds)
public java.util.Collection<java.lang.String> getAPIPortalIdsForDeletion()
public java.lang.String getSandboxClassification()
public void setSandboxClassification(java.lang.String sandboxClassification)
public java.lang.String getRetryIntervals()
public void setRetryIntervals(java.lang.String retryIntervals)
public java.lang.String getRetryCount()
public void setRetryCount(java.lang.String retryCount)
public boolean isRetryEnabled()
public void setRetryEnabled(boolean isRetryEnabled)
public boolean isRegistered()
public void setRegistered(boolean isRegistered)