public interface APIPortal extends CentraSiteRegistryObject
APIPortal
represents the registered API Portal objects in CentraSite.
APIPortal
.
APIPortal
will capture the following details
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getCentraSiteUserId()
Gets the centrasite user id from
APIPortal which will be used for authenticating against the API-Portal. |
java.lang.String |
getCentrasitUserPwd()
Gets the centrasite user password from passman manager.
|
java.util.Collection<Community> |
getCommunities(java.util.Collection<java.lang.String> selectedAssets)
Get and prepare the communities of the API portal.
|
Organization |
getConsumerOrganization()
Gets the consumer organization configured for
APIPortal |
java.lang.String |
getEndPoint()
Gets the end point of the webMethods API-Portal.
|
java.lang.String |
getPortalTenantId()
Gets the portalTenantId
|
java.lang.String |
getPortalUserPwd()
Gets the portal user password from passman manager.
|
java.util.Collection<CentraSiteObject> |
getPublishedAPIs()
Gets the list of APIs that are published to the API-Portal.
|
java.lang.String |
getRetryCount()
Gets the retryCount for contacting API-Portal
|
java.lang.String |
getRetryIntervals()
Gets the Retry Interval between each retry
|
Category |
getSandbox() |
java.lang.String |
getUserName()
Gets the user id from
APIPortal which will be used for authenticating against the API-Portal. |
boolean |
hasOnboardedUsers()
Checks if the API-Portal's consumer organization has any API-Portal users who were
onboarded to CentraSite.
|
boolean |
isRegistered()
Tells weather the API-Portal instance in CentraSite is registered with the configured webMethods API-Portal.
|
boolean |
isRetryEnabled()
Gets whether the Retry Mechanism is enabled or not
|
void |
setCentraSiteUserId(java.lang.String centraSiteUserId)
Sets the centrasite user id to
APIPortal which will be used for authenticating against the API-Portal. |
void |
setCentraSiteUserPwd(java.lang.String centraSiteUserPwd)
Sets the centrasite user password to
APIPortal which will be used for authenticating against 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 |
setEndpoint(java.lang.String endPoint)
Sets the end point of the webMethods API-Portal to
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 the portalTenantId
|
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 retryIntervals)
Sets the Retry Intervals between each retry
|
void |
setSandbox(Category sandbox) |
void |
setUserName(java.lang.String userName)
Sets the user id to
APIPortal which will be used for authenticating against the API-Portal. |
getConsumedAssets, getConsumers, getDescription, getDescription, getDisplayVersion, getInitialVirtualAssetName, getLastModifiedTimeStamp, getLCMAssignment, getLocalName, getMandatoryAttributeProfiles, getName, getName, getNameSpace, getNextVersion, getNextVersions, getOrganization, getOwner, getPendingApprovals, getPreviousVersion, getPreviousVersions, getRegistryObject, getRelationShipValueMap, getRequestedUser, getSubscribers, getSystemVersion, getTitle, getType, getUserVersion, getVisiblePrimaryProfiles, getVisibleProfile, isDeployedOn, isLatestVersionObject, isPropagatePermissions, isPropagateProfilePermissions, removeConsumedAssets, removeConsumers, setDescription, setDescription, setDisplayVersion, setLCMState, setLocalName, setName, setName, setNameSpace, setOrganization, setOwner, setPropagatePermissions, setPropagateProfilePermissions, setRelationShipValueMap, setUserVersion
delete, getAttributeLink, getAttributeValue, getAttributeValue, getAttributeValue, getId, isModified, isPredefined, isReadOnly, save, setAttributeValue, setAttributeValue, setAttributeValue
void setEndpoint(java.lang.String endPoint) throws CLLException
APIPortal
endPoint
- the endpoint of the webMethods API-PortalCLLException
- If any internal error occurs while setting the end point to the APIPortal
object.java.lang.String getEndPoint() throws CLLException
String
The end point of the portal.CLLException
- If any internal error occurs while fetching the end point of the APIPortal
object.void setUserName(java.lang.String userName) throws CLLException
APIPortal
which will be used for authenticating against the API-Portal.userName
- String
value as user id.CLLException
- If any internal error occurs while setting the user id to the APIPortal
object.java.lang.String getUserName() throws CLLException
APIPortal
which will be used for authenticating against the API-Portal.String
the user id value.CLLException
- If any internal error occurs while fetching the user id from the APIPortal
object.void setPassword(java.lang.String password) throws CLLException
APIPortal
which will be used for authenticating against the API-Portal.password
- String
value as password.CLLException
- If any internal error occurs while setting the password to the APIPortal
object.void setConsumerOrganization(Organization organization) throws CLLException
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.CLLException
- If any internal error occurs while setting the consumer organization to the APIPortal
object.Organization getConsumerOrganization() throws CLLException
APIPortal
Organization
object.CLLException
- If any internal error occurs while fetching the consumer organization from the APIPortal
object.java.util.Collection<CentraSiteObject> getPublishedAPIs() throws CLLException
Collection
of CentraSiteObject
.CLLException
- If any internal error occurs while fetching the published APIs from APIPortal
object.void setPortalTenantId(java.lang.String portalTenantId) throws CLLException
portalTenantId
- String
value as portalTenantId.CLLException
- If any internal error occurs while setting the portalTenantId to the APIPortal
object.java.lang.String getPortalTenantId() throws CLLException
String
the portalTenantId value.CLLException
- If any internal error occurs while fetching the Portal TenantId from the APIPortal
object.void setCentraSiteUserId(java.lang.String centraSiteUserId) throws CLLException
APIPortal
which will be used for authenticating against the API-Portal.centraSiteUserId
- String
value as user id.CLLException
- If any internal error occurs while setting the user id to the APIPortal
object.java.lang.String getCentraSiteUserId() throws CLLException
APIPortal
which will be used for authenticating against the API-Portal.String
the centrasite user id value.CLLException
- If any internal error occurs while fetching the centrasite user id from the APIPortal
object.void setCentraSiteUserPwd(java.lang.String centraSiteUserPwd) throws CLLException
APIPortal
which will be used for authenticating against the API-Portal.centraSiteUserPwd
- String
value as password.CLLException
- If any internal error occurs while setting the centrasite user password to the APIPortal
object.java.lang.String getCentrasitUserPwd() throws CLLException
String
the centrasiteUserPwd value.CLLException
- If any internal error occurs while fetching the centrasite user password from passman manager.java.lang.String getPortalUserPwd() throws CLLException
String
the portaluserPwd value.CLLException
- If any internal error occurs while fetching the portal user password from passman manager.void setRetryEnabled(boolean isRetryEnabled) throws CLLException
isRetryEnabled
- Retry Mechanism is enabled or notCLLException
void setRetryIntervals(java.lang.String retryIntervals) throws CLLException
retryIntervals
- The Retry Interval between each retryCLLException
void setRetryCount(java.lang.String retryCount) throws CLLException
retryCount
- The retryCount to reach API-PortalCLLException
boolean isRetryEnabled() throws CLLException
boolean
CLLException
java.lang.String getRetryIntervals() throws CLLException
String
CLLException
java.lang.String getRetryCount() throws CLLException
String
CLLException
void setSandbox(Category sandbox) throws CLLException
CLLException
Category getSandbox() throws CLLException
CLLException
boolean hasOnboardedUsers() throws CLLException
true
if the consumer organization has atleast one user who
was onboarded from API-Portal and false
otherwise.CLLException
- If an error occurs while checking for onboarded users.java.util.Collection<Community> getCommunities(java.util.Collection<java.lang.String> selectedAssets) throws CLLException
selectedAssets
- assets selected with the API portal selectionCLLException
boolean isRegistered() throws CLLException
CLLException
- if any internal errors while checking weather the API-Portal object is registered or not.