public interface ConsumeAction extends CSOAction
CentraSiteObject
.
Modifier and Type | Interface and Description |
---|---|
static class |
ConsumeAction.RelevantOption
List of options allowed for the ConsumeAction
|
Modifier and Type | Method and Description |
---|---|
java.util.Collection<java.lang.String> |
getApplicableEnforcements()
Gets the list of enforcements applicable for the consumer.
|
CSOSearch |
getConsumableObjectsSearch()
Gets the CentraSite search object which can be used to obtain the consumable objects of the asset.
|
CentraSiteObject |
getNewlyCreatedApplicationAsset() |
java.util.Collection<CentraSiteRegistryObjectType> |
getTopLevelConsumableTypes()
Returns the collection of top level consumable asset types defined for the selected objects for this action.
|
boolean |
hasApiKeyGeneratorPolicy()
Checks if there is an API key generator policy.
|
boolean |
hasOauth2KeyGeneratorPolicy()
Checks if there is an OAuth2 key generation policy.
|
boolean |
isOptionPermitted(ConsumeAction.RelevantOption option)
Checks whether the given option is allowed for the ConsumeAction.
|
boolean |
isUserOnboarded(java.lang.String emailId)
Checks if a user is already on-boarded with the given emailId.
|
void |
performSelectedOption(ConsumeAction.RelevantOption option)
Performs the given option.
|
void |
setApiKeyRequested(boolean isApiKeyRequested)
Sets if an API key is requested by the consumer or not.
|
void |
setConsumerName(java.lang.String consumerName)
Sets the consumer name.
|
void |
setConsumerObjects(java.util.Collection<CentraSiteRegistryObject> consumerObjects)
Sets the consumer objects to be registered as consumers of the asset
|
void |
setConsumptionReason(java.lang.String reasonComment)
Sets the reasoning for the current consumption request.
|
void |
setEmailAddress(java.lang.String emailAddress)
If the consumer does not have an email address as part of user preferences, it can
be specified using this API.
|
void |
setEnforcementValues(java.util.Map<java.lang.String,java.lang.Object> value)
Sets the given enforcement values.
|
void |
setMailMeAPIKey(boolean isMailMeAPIKey)
Enable/disable the "mail me API key" option.
|
void |
setOnboardingRequest(OnboardingRequest request)
Sets the given consumer on-boarding request.
|
void |
setSelectedConsumerApplications(java.util.Collection<CentraSiteObject> consumerApplications)
Deprecated.
use
setConsumerObjects(Collection) instead |
cancel, doesLoggedInUserHaveSufficientRolesOrPermissions, executeNextStep, executePreviousStep, finishAllSteps, getCurrentState, getGroup, getIconURL, getId, getName, getNonApplicableReason, getSkippedObjectsWithReason, isAllowed, isApplicable, setObjects
@Deprecated void setSelectedConsumerApplications(java.util.Collection<CentraSiteObject> consumerApplications) throws CLLException
setConsumerObjects(Collection)
insteadconsumerApplications
- The list of consumer applications to consume the assets.CLLException
- If an error occurs while setting the consumer applicationsvoid setConsumerObjects(java.util.Collection<CentraSiteRegistryObject> consumerObjects) throws CLLException
consumerAssets
- CLLException
CSOSearch getConsumableObjectsSearch()
CSOSearch
The search object created with the consumable types of the asset as search scope.java.util.Collection<CentraSiteRegistryObjectType> getTopLevelConsumableTypes() throws CLLException
Collection
of CentraSiteRegistryObjectType
instancesCLLException
- If an error occurs while fetching the consumable types.boolean isOptionPermitted(ConsumeAction.RelevantOption option) throws CLLException
option
- The ConsumeAction.RelevantOption
that must be checked for permittancetrue
if the given option is permitted for this instance of ConsumeAction
and
false
otherwiseCLLException
- If an error occurs while trying to check if the option is permitted.void performSelectedOption(ConsumeAction.RelevantOption option)
isOptionPermitted(RelevantOption)
.
Otherwise, the selected option will not be performed.option
- The selected ConsumeAction.RelevantOption
CentraSiteObject getNewlyCreatedApplicationAsset()
void setConsumptionReason(java.lang.String reasonComment)
reasonComment
- The comment proving the reason for the requestvoid setMailMeAPIKey(boolean isMailMeAPIKey)
isMailMeAPIKey
- If true, user needs to be intimated via email about the generated API keyvoid setEmailAddress(java.lang.String emailAddress)
emailAddress
- The email address for the consumerjava.util.Collection<java.lang.String> getApplicableEnforcements() throws CLLException
Collection
of applicable enforcementsCLLException
- If an error occurs while fetching the applicable enforcementsvoid setEnforcementValues(java.util.Map<java.lang.String,java.lang.Object> value)
value
- The enforcement values to setvoid setOnboardingRequest(OnboardingRequest request)
request
- The consumer's on-boarding requestboolean isUserOnboarded(java.lang.String emailId) throws CLLException
emailId
- The email Id of the user to check.CLLException
- If an error occurs while checking if a user is on-boardedvoid setApiKeyRequested(boolean isApiKeyRequested)
isApiKeyRequested
- If true, the consumer has requested an API key.void setConsumerName(java.lang.String consumerName)
consumerName
- The consumer name to setboolean hasApiKeyGeneratorPolicy()
boolean hasOauth2KeyGeneratorPolicy()