public interface ConsumeAction extends CSOAction
CentraSiteObject
.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
EVALUATE_HOSTNAME_ACTION_KEY |
static java.lang.String |
EVALUATE_HTTPAUTH_ACTION_KEY |
static java.lang.String |
EVALUATE_IPRANGE_ACTION_KEY |
static java.lang.String |
EVALUATE_IPRANGE_ACTION_KEY_FROM |
static java.lang.String |
EVALUATE_IPRANGE_ACTION_KEY_TO |
static java.lang.String |
EVALUATE_WSSUSERNAME_ACTION_KEY |
static java.lang.String |
EVALUATE_WSSX509_ACTION_KEY |
static java.lang.String |
EVALUATE_WSSX509_ACTION_KEY_FILENAME |
static java.lang.String |
EVALUATE_XPATH_ACTION_KEY |
Modifier and Type | Method and Description |
---|---|
java.util.Collection<java.lang.String> |
getApplicableEnforcements()
Gets the list of enforcements applicable for the consumer.
|
boolean |
hasApiKeyGeneratorPolicy()
Checks if there is an API key generator policy.
|
boolean |
hasOauth2KeyGeneratorPolicy()
Checks if there is an OAuth2 key generation policy.
|
boolean |
isUserOnboarded(java.lang.String emailId)
Checks if a user is already on-boarded with the given emailId.
|
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 |
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)
Sets the selected CentraSite objects as consumer applications.
|
cancel, executeNextStep, executePreviousStep, finishAllSteps, getCurrentState, getGroup, getIconURL, getId, getName, getSkippedObjectsWithReason, isAllowed, isApplicable, setObjects
static final java.lang.String EVALUATE_IPRANGE_ACTION_KEY
static final java.lang.String EVALUATE_XPATH_ACTION_KEY
static final java.lang.String EVALUATE_HOSTNAME_ACTION_KEY
static final java.lang.String EVALUATE_WSSUSERNAME_ACTION_KEY
static final java.lang.String EVALUATE_WSSX509_ACTION_KEY
static final java.lang.String EVALUATE_HTTPAUTH_ACTION_KEY
static final java.lang.String EVALUATE_IPRANGE_ACTION_KEY_FROM
static final java.lang.String EVALUATE_IPRANGE_ACTION_KEY_TO
static final java.lang.String EVALUATE_WSSX509_ACTION_KEY_FILENAME
void setSelectedConsumerApplications(java.util.Collection<CentraSiteObject> consumerApplications) throws CLLException
consumerApplications
- The list of consumer applications to consume the assets.CLLException
- If an error occurs while setting the consumer applicationsvoid 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()