public interface AccessGrantManager
Modifier and Type | Method and Description |
---|---|
void |
deleteExpiredGrants()
PingFederate periodically calls this method (once per day by default) to clear out expired access grants.
|
Collection<AccessGrant> |
getByClientId(String clientId)
Retrieves a collection of access grants based on the client id.
|
AccessGrant |
getByGuid(String accessGrantGuid)
Retrieves an AccessGrant by its guid.
|
AccessGrant |
getByRefreshToken(String refreshTokenValue)
Retrieves an AccessGrant by its refresh token value.
|
Collection<AccessGrant> |
getByUserKey(String userKey)
Retrieves an access grant based on the user key, which is the unique user identifier.
|
AccessGrant |
getByUserKeyScopeClientIdGrantTypeContext(String userKey,
Scope scope,
String clientId,
String grantType,
String contextQualifier)
Retrieves an access grant based based on several specific criteria specified in the params.
|
AccessGrantAttributesHolder |
getGrantAttributes(String accessGrantGuid)
Retrieve the access grant attributes for the specified access grant guid.
|
boolean |
isDataSourceInUse(String datasourceId)
Determines if the specified data source is in use.
|
void |
revokeGrant(String accessGrantGuid)
Revokes an access grant that has been previously issued.
|
void |
revokeGrant(String userKey,
String accessGrantGuid)
Revokes an access grant that has been previously issued.
|
void |
saveGrant(AccessGrant accessGrant,
AccessGrantAttributesHolder attrHolder)
Saves the access grant to the underlying storage mechanism.
|
void |
updateGrantAttributes(String accessGrantGuid,
AccessGrantAttributesHolder attrHolder)
Updates the access grant attributes with the specified attributes.
|
void |
updateRefreshToken(AccessGrant accessGrant)
Update the refresh token of the specified access grant.
|
AccessGrant getByRefreshToken(String refreshTokenValue) throws AccessGrantManagementException
refreshTokenValue
- the refresh token to search for.AccessGrantManagementException
- Runtime exception to indicate the retrieval of the AccessGrant
has failed.AccessGrant getByGuid(String accessGrantGuid) throws AccessGrantManagementException
accessGrantGuid
- the guid to search for.AccessGrantManagementException
- Runtime exception to indicate the retrieval of the AccessGrant
has failed.Collection<AccessGrant> getByUserKey(String userKey) throws AccessGrantManagementException
userKey
- the unique user identifier to retrieve access grants for.AccessGrantManagementException
- Runtime exception to indicate the retrieval of the AccessGrant
has failed.AccessGrant getByUserKeyScopeClientIdGrantTypeContext(String userKey, Scope scope, String clientId, String grantType, String contextQualifier) throws AccessGrantManagementException
userKey
- the unique user identifier to retrieve access grants for.scope
- the scope to retrieve access grants for.clientId
- the client id to retrieve access grants for.grantType
- the grant type to retrieve access grants for.contextQualifier
- the contextual qualifier to retrieve access grants for.AccessGrantManagementException
- Runtime exception to indicate the retrieval of the AccessGrant
has failed.Collection<AccessGrant> getByClientId(String clientId) throws AccessGrantManagementException
clientId
- the client id to retrieve access grants for.AccessGrantManagementException
- Runtime exception to indicate the retrieval of the AccessGrant
has failed.void revokeGrant(String accessGrantGuid) throws AccessGrantManagementException
accessGrantGuid
- the guid of the access grant that is to be revoked.AccessGrantManagementException
- Runtime exception to indicate the retrieval of the AccessGrant
has failed.void revokeGrant(String userKey, String accessGrantGuid) throws AccessGrantManagementException
userKey
- the user identifier of the access grant to be revoked.accessGrantGuid
- the guid of the access grant that is to be revoked.AccessGrantManagementException
- Runtime exception to indicate the retrieval of the AccessGrant
has failed.void saveGrant(AccessGrant accessGrant, AccessGrantAttributesHolder attrHolder) throws AccessGrantManagementException
accessGrant
- the access grant that is to be persisted.attrHolder
- a list of optional access grant attributes to be stored with the access grant.AccessGrantManagementException
- Runtime exception to indicate the retrieval of the AccessGrant
has failed.void updateGrantAttributes(String accessGrantGuid, AccessGrantAttributesHolder attrHolder) throws AccessGrantManagementException
accessGrantGuid
- the guid of the access grant that is to be updated.attrHolder
- a list of optional access grant attributes that are to be updated within the access grant.AccessGrantManagementException
- Runtime exception to indicate the retrieval of the AccessGrant
has failed.void updateRefreshToken(AccessGrant accessGrant) throws AccessGrantManagementException
accessGrant
- the access grant to update which contains the new refresh token value.AccessGrantManagementException
- Runtime exception to indicate the retrieval of the AccessGrant
has failed.boolean isDataSourceInUse(String datasourceId)
datasourceId
- the datasource id in use.AccessGrantManagementException
- Runtime exception to indicate the retrieval of the AccessGrant
has failed.void deleteExpiredGrants()
AccessGrantManagementException
- Runtime exception to indicate the retrieval of the AccessGrant
has failed.AccessGrantAttributesHolder getGrantAttributes(String accessGrantGuid) throws AccessGrantManagementException
accessGrantGuid
- the access grant guid to retrieve attributes for.AccessGrantManagementException
- Runtime exception to indicate the retrieval of the AccessGrant
has failed.Copyright 2019 Ping Identity Corp. All rights reserved.