public interface APIKey extends CentraSiteRegistryObject
Modifier and Type | Method and Description |
---|---|
boolean |
canBeRenewedAsProvider(User user)
Checks if this API key can be renewed as a Provider for the given
User . |
boolean |
canBeRevokedAsProvider(User user)
Checks if this API key can be revoked as a Provider for the given
User . |
java.util.Date |
getExpirationDate()
Get the expiration date for this API key.
|
void |
renewAsConsumer()
Renew this API key as a Consumer.
|
void |
renewAsProvider()
Renew this API key as a Provider.
|
void |
revokeAsConsumer()
Revoke this API key as a Consumer.
|
void |
revokeAsProvider()
Revoke this API key as a Provider.
|
getConsumers, getDescription, getDescription, getDisplayVersion, getLCMAssignment, getLocalName, getMandatoryAttributeProfiles, getName, getName, getNameSpace, getNextVersion, getNextVersions, getOrganization, getOwner, getPendingApprovals, getPreviousVersion, getPreviousVersions, getRegistryObject, getSubscribers, getSystemVersion, getTitle, getUserVersion, getVisiblePrimaryProfiles, getVisibleProfile, isDeployedOn, isLatestVersionObject, isPropagatePermissions, isPropagateProfilePermissions, setDescription, setDescription, setDisplayVersion, setLCMState, setLocalName, setName, setName, setNameSpace, setOrganization, setOwner, setPropagatePermissions, setPropagateProfilePermissions, setUserVersion
delete, getAttributeLink, getAttributeValue, getAttributeValue, getAttributeValue, getId, getType, isModified, isReadOnly, save, setAttributeValue, setAttributeValue, setAttributeValue
void revokeAsConsumer() throws CLLException
CLLException
- If the user access is unauthorized or forbidden or if the required
policy for key renew/revoke could not be found or due to an internal errorvoid renewAsConsumer() throws CLLException
CLLException
- If the user access is unauthorized or forbidden or if the required
policy for key renew/revoke could not be found or due to an internal errorvoid revokeAsProvider() throws CLLException
CLLException
- If the user access is unauthorized or forbidden or if the required
policy for key renew/revoke could not be found or due to an internal errorvoid renewAsProvider() throws CLLException
CLLException
- If the user access is unauthorized or forbidden or if the required
policy for key renew/revoke could not be found or due to an internal errorboolean canBeRenewedAsProvider(User user)
User
.user
- The User
who should have the required role to renew this API key as a providerboolean canBeRevokedAsProvider(User user)
User
.user
- The User
who should have the required role to revoke this API key as a providerjava.util.Date getExpirationDate()
Date
.