AbstractOAuthDataProvider (Apache CXF Runtime OAuth 2.0 3.0.4.redhat-621216 API)

java.lang.Object
- org.apache.cxf.rs.security.oauth2.provider.AbstractOAuthDataProvider

All Implemented Interfaces:

OAuthDataProvider

Direct Known Subclasses:

AbstractAuthorizationCodeDataProvider, AbstractCodeDataProvider, DefaultEHCacheOAuthDataProvider, DefaultEncryptingOAuthDataProvider
```
public abstract class AbstractOAuthDataProvider
extends Object
implements OAuthDataProvider
```

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractOAuthDataProvider()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractOAuthDataProvider()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()`
`List<OAuthPermission>`	`convertScopeToPermissions(Client client, List<String> requestedScopes)` Converts the requested scope to the list of permissions
`ServerAccessToken`	`createAccessToken(AccessTokenRegistration reg)` Create access token
`protected ServerAccessToken`	`createNewAccessToken(Client client)`
`protected RefreshToken`	`createNewRefreshToken(ServerAccessToken at)`
`protected ServerAccessToken`	`doCreateAccessToken(AccessTokenRegistration accessToken)`
`protected RefreshToken`	`doCreateNewRefreshToken(ServerAccessToken at)`
`protected ServerAccessToken`	`doRefreshAccessToken(Client client, RefreshToken oldRefreshToken, List<String> restrictedScopes)`
`protected abstract List<ServerAccessToken>`	`getAccessTokens(Client c)`
`org.apache.cxf.jaxrs.ext.MessageContext`	`getMessageContext()`
`Map<String,OAuthPermission>`	`getPermissionMap()`
`ServerAccessToken`	`getPreauthorizedToken(Client client, List<String> requestedScopes, UserSubject subject, String grantType)` Get preauthorized access token
`protected abstract RefreshToken`	`getRefreshToken(String refreshTokenKey)`
`protected abstract List<RefreshToken>`	`getRefreshTokens(Client c)`
`protected void`	`handleLinkedRefreshToken(ServerAccessToken accessToken)`
`void`	`init()`
`protected boolean`	`isRefreshTokenSupported(List<String> theScopes)`
`ServerAccessToken`	`refreshAccessToken(Client client, String refreshTokenKey, List<String> restrictedScopes)` Refresh access token
`void`	`removeAccessToken(ServerAccessToken token)` Removes the access token The runtime will call this method if it finds that a token has expired
`protected void`	`removeClientTokens(Client c)`
`protected abstract ServerAccessToken`	`revokeAccessToken(String accessTokenKey)`
`protected void`	`revokeAccessTokens(RefreshToken currentRefreshToken)`
`protected abstract RefreshToken`	`revokeRefreshToken(String refreshTokenKey)`
`void`	`revokeToken(Client client, String tokenKey, String tokenTypeHint)` Revokes a refresh or access token
`protected abstract void`	`saveAccessToken(ServerAccessToken serverToken)`
`protected abstract void`	`saveRefreshToken(ServerAccessToken at, RefreshToken refreshToken)`
`void`	`setAccessTokenLifetime(long accessTokenLifetime)`
`void`	`setMessageContext(org.apache.cxf.jaxrs.ext.MessageContext messageContext)`
`void`	`setPermissionMap(Map<String,OAuthPermission> permissionMap)`
`void`	`setRecycleRefreshTokens(boolean recycleRefreshTokens)`
`void`	`setRefreshTokenLifetime(long refreshTokenLifetime)`
`void`	`setScopes(Map<String,String> scopes)`
`protected void`	`unlinkRefreshAccessToken(RefreshToken rt, String tokenKey)`
`protected RefreshToken`	`updateRefreshToken(RefreshToken rt, ServerAccessToken at)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.cxf.rs.security.oauth2.provider.OAuthDataProvider
getAccessToken, getClient

Constructor Detail
- AbstractOAuthDataProvider
```
protected AbstractOAuthDataProvider()
```

Method Detail

createAccessToken
```
public ServerAccessToken createAccessToken(AccessTokenRegistration reg)
                                    throws OAuthServiceException
```
Description copied from interface: OAuthDataProvider

Create access token

Specified by:

createAccessToken in interface OAuthDataProvider

Parameters:
reg - the token registration info

Returns:
AccessToken

Throws:

OAuthServiceException

doCreateAccessToken

protected ServerAccessToken doCreateAccessToken(AccessTokenRegistration accessToken)

removeAccessToken
```
public void removeAccessToken(ServerAccessToken token)
                       throws OAuthServiceException
```
Description copied from interface: OAuthDataProvider

Removes the access token The runtime will call this method if it finds that a token has expired

Specified by:

removeAccessToken in interface OAuthDataProvider

Parameters:
token - the token

Throws:

OAuthServiceException

refreshAccessToken

public ServerAccessToken refreshAccessToken(Client client,
                                   String refreshTokenKey,
                                   List<String> restrictedScopes)
                                     throws OAuthServiceException

Description copied from interface: OAuthDataProvider

Refresh access token

Specified by:: refreshAccessToken in interface OAuthDataProvider
Parameters:: client - the client; refreshTokenKey - refresh token key; restrictedScopes - the scopes requested by the client
Returns:: AccessToken
Throws:: OAuthServiceException

revokeToken
```
public void revokeToken(Client client,
               String tokenKey,
               String tokenTypeHint)
                 throws OAuthServiceException
```
Description copied from interface: OAuthDataProvider

Revokes a refresh or access token

Specified by:

revokeToken in interface OAuthDataProvider

tokenKey - token identifier

Throws:

OAuthServiceException

handleLinkedRefreshToken

protected void handleLinkedRefreshToken(ServerAccessToken accessToken)

revokeAccessTokens

protected void revokeAccessTokens(RefreshToken currentRefreshToken)

unlinkRefreshAccessToken

protected void unlinkRefreshAccessToken(RefreshToken rt,
                            String tokenKey)

convertScopeToPermissions
```
public List<OAuthPermission> convertScopeToPermissions(Client client,
                                              List<String> requestedScopes)
```
Description copied from interface: OAuthDataProvider

Converts the requested scope to the list of permissions

Specified by:

convertScopeToPermissions in interface OAuthDataProvider

Returns:
list of permissions

getPreauthorizedToken

public ServerAccessToken getPreauthorizedToken(Client client,
                                      List<String> requestedScopes,
                                      UserSubject subject,
                                      String grantType)
                                        throws OAuthServiceException

Description copied from interface: OAuthDataProvider

Get preauthorized access token

Specified by:: getPreauthorizedToken in interface OAuthDataProvider
Parameters:: client - Client; requestedScopes - the scopes requested by the client; subject - End User subject
Returns:: AccessToken access token
Throws:: OAuthServiceException

isRefreshTokenSupported

protected boolean isRefreshTokenSupported(List<String> theScopes)

createNewAccessToken

protected ServerAccessToken createNewAccessToken(Client client)

updateRefreshToken

protected RefreshToken updateRefreshToken(RefreshToken rt,
                              ServerAccessToken at)

createNewRefreshToken

protected RefreshToken createNewRefreshToken(ServerAccessToken at)

doCreateNewRefreshToken

protected RefreshToken doCreateNewRefreshToken(ServerAccessToken at)

doRefreshAccessToken

protected ServerAccessToken doRefreshAccessToken(Client client,
                                     RefreshToken oldRefreshToken,
                                     List<String> restrictedScopes)

setAccessTokenLifetime

public void setAccessTokenLifetime(long accessTokenLifetime)

setRefreshTokenLifetime

public void setRefreshTokenLifetime(long refreshTokenLifetime)

setRecycleRefreshTokens

public void setRecycleRefreshTokens(boolean recycleRefreshTokens)

init
```
public void init()
```

close
```
public void close()
```

getPermissionMap

public Map<String,OAuthPermission> getPermissionMap()

setPermissionMap

public void setPermissionMap(Map<String,OAuthPermission> permissionMap)

setScopes

public void setScopes(Map<String,String> scopes)

getMessageContext

public org.apache.cxf.jaxrs.ext.MessageContext getMessageContext()

setMessageContext

public void setMessageContext(org.apache.cxf.jaxrs.ext.MessageContext messageContext)

removeClientTokens

protected void removeClientTokens(Client c)

saveAccessToken

protected abstract void saveAccessToken(ServerAccessToken serverToken)

saveRefreshToken

protected abstract void saveRefreshToken(ServerAccessToken at,
                    RefreshToken refreshToken)

revokeAccessToken

protected abstract ServerAccessToken revokeAccessToken(String accessTokenKey)

getAccessTokens

protected abstract List<ServerAccessToken> getAccessTokens(Client c)

getRefreshTokens

protected abstract List<RefreshToken> getRefreshTokens(Client c)

revokeRefreshToken

protected abstract RefreshToken revokeRefreshToken(String refreshTokenKey)

getRefreshToken

protected abstract RefreshToken getRefreshToken(String refreshTokenKey)

Class AbstractOAuthDataProvider

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.cxf.rs.security.oauth2.provider.OAuthDataProvider

Constructor Detail

AbstractOAuthDataProvider

Method Detail

createAccessToken

doCreateAccessToken

removeAccessToken

refreshAccessToken

revokeToken

handleLinkedRefreshToken

revokeAccessTokens

unlinkRefreshAccessToken

convertScopeToPermissions

getPreauthorizedToken

isRefreshTokenSupported

createNewAccessToken

updateRefreshToken

createNewRefreshToken

doCreateNewRefreshToken

doRefreshAccessToken

setAccessTokenLifetime

setRefreshTokenLifetime

setRecycleRefreshTokens

init

close

getPermissionMap

setPermissionMap

setScopes

getMessageContext

setMessageContext

removeClientTokens

saveAccessToken

saveRefreshToken

revokeAccessToken

getAccessTokens

getRefreshTokens

revokeRefreshToken

getRefreshToken