de.hybris.platform.webservicescommons.oauth2.token

Interface OAuthTokenService

All Known Implementing Classes:

DefaultOAuthTokenService

public interface OAuthTokenService

Service for managing OAuth access and refresh tokens

Spring Bean ID:

oauthTokenService

Method Summary

Modifier and Type	Method and Description
OAuthAccessTokenModel	getAccessToken(java.lang.String id) Returns access token for given identifier (key)
OAuthAccessTokenModel	getAccessTokenForAuthentication(java.lang.String authenticationId) Returns access token for given authentication
java.util.List<OAuthAccessTokenModel>	getAccessTokensForClient(java.lang.String clientId) Returns access tokens for client
java.util.List<OAuthAccessTokenModel>	getAccessTokensForClientAndUser(java.lang.String clientId, java.lang.String userName) Returns access tokens based on user and client
java.util.List<OAuthAccessTokenModel>	getAccessTokensForUser(java.lang.String userName) Returns access tokens for user with given user name
OAuthRefreshTokenModel	getRefreshToken(java.lang.String id) Returns refresh token for given identifier (key)
void	removeAccessToken(java.lang.String id) Remove access token
void	removeAccessTokenForAuthentication(java.lang.String authenticationId) Removes access tokens related to authentication
void	removeAccessTokenUsingRefreshToken(java.lang.String refreshTokenId) Removes access tokens related to refresh token
void	removeRefreshToken(java.lang.String id) Remove refresh token with given identifier
void	saveAccessToken(OAuthAccessTokenModel accessTokenModel) Save access token
OAuthAccessTokenModel	saveAccessToken(java.lang.String accessTokenId, java.lang.Object accessToken, java.lang.String authenticationId, java.lang.Object authentication, java.lang.String userName, java.lang.String clientId, OAuthRefreshTokenModel refreshTokenModel) Saves access token attributes in access token model. If access token model with given id doesn't exist, new access token model is created.
void	saveRefreshToken(OAuthRefreshTokenModel refreshTokenModel) Save refresh token model
OAuthRefreshTokenModel	saveRefreshToken(java.lang.String refreshTokenId, java.lang.Object refreshToken, java.lang.Object authentication) Saves refresh token attributes in refresh token model. If refresh token model for given id doesn't exist, new refresh token model is created.

Method Detail

getAccessToken

OAuthAccessTokenModel getAccessToken(java.lang.String id)

Returns access token for given identifier (key)

Parameters:

id - token identifier

Returns:

access token with given id

Throws:

java.lang.IllegalArgumentException - when 'id' parameter is null

UnknownIdentifierException - when access token with given id doesn't exist

saveAccessToken

void saveAccessToken(OAuthAccessTokenModel accessTokenModel)

Save access token

Parameters:

accessTokenModel - Access token model to save

saveAccessToken

OAuthAccessTokenModel saveAccessToken(java.lang.String accessTokenId,
                                      java.lang.Object accessToken,
                                      java.lang.String authenticationId,
                                      java.lang.Object authentication,
                                      java.lang.String userName,
                                      java.lang.String clientId,
                                      OAuthRefreshTokenModel refreshTokenModel)

Saves access token attributes in access token model.
If access token model with given id doesn't exist, new access token model is created.

Parameters:

accessTokenId - Access token identifier

accessToken - Access token object

authenticationId - Authentication identifier

authentication - Authentication object

userName - User name

clientId - Client identifier

refreshTokenModel - Refresh token model belong

Returns:

Saved access token model

removeAccessToken

void removeAccessToken(java.lang.String id)

Remove access token

Parameters:

id - Access token identifier

getRefreshToken

OAuthRefreshTokenModel getRefreshToken(java.lang.String id)

Returns refresh token for given identifier (key)

Parameters:

id - refresh token identifier

Returns:

refresh token with given id

Throws:

java.lang.IllegalArgumentException - when 'id' parameter is null

UnknownIdentifierException - when refresh token with given id doesn't exist

saveRefreshToken

void saveRefreshToken(OAuthRefreshTokenModel refreshTokenModel)

Save refresh token model

Parameters:

refreshTokenModel - Model to save

saveRefreshToken

OAuthRefreshTokenModel saveRefreshToken(java.lang.String refreshTokenId,
                                        java.lang.Object refreshToken,
                                        java.lang.Object authentication)

Saves refresh token attributes in refresh token model.
If refresh token model for given id doesn't exist, new refresh token model is created.

Parameters:

refreshTokenId - Refresh token identifier

refreshToken - Refresh token object

authentication - Authentication object

Returns:

Saved refresh token model

removeRefreshToken

void removeRefreshToken(java.lang.String id)

Remove refresh token with given identifier

Parameters:

id - - refresh token identifier (key)

removeAccessTokenUsingRefreshToken

void removeAccessTokenUsingRefreshToken(java.lang.String refreshTokenId)

Removes access tokens related to refresh token

Parameters:

refreshTokenId - Refresh token identifier

getAccessTokensForClient

java.util.List<OAuthAccessTokenModel> getAccessTokensForClient(java.lang.String clientId)

Returns access tokens for client

Parameters:

clientId - Client identifier

Returns:

List of access tokens for client or empty list

getAccessTokensForUser

java.util.List<OAuthAccessTokenModel> getAccessTokensForUser(java.lang.String userName)

Returns access tokens for user with given user name

Parameters:

userName - User name

Returns:

List of access tokens for user or empty list

getAccessTokenForAuthentication

OAuthAccessTokenModel getAccessTokenForAuthentication(java.lang.String authenticationId)

Returns access token for given authentication

Parameters:

authenticationId - authentication identifier

Returns:

access token

Throws:

java.lang.IllegalArgumentException - when authenticationId is null

UnknownIdentifierException - when there is no access token related to given authentication

AmbiguousIdentifierException - when there is multiple access token related to given authentication

removeAccessTokenForAuthentication

void removeAccessTokenForAuthentication(java.lang.String authenticationId)

Removes access tokens related to authentication

Parameters:

authenticationId - authentication identifier

Throws:

java.lang.IllegalArgumentException - when authenticationId is null

getAccessTokensForClientAndUser

java.util.List<OAuthAccessTokenModel> getAccessTokensForClientAndUser(java.lang.String clientId,
                                                                      java.lang.String userName)

Returns access tokens based on user and client

Parameters:

clientId - Client identifier

userName - User name

Returns:

List of access tokens or empty list