DefaultEncryptingOAuthDataProvider (Apache CXF JavaDoc 3.1.0 API)

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

All Implemented Interfaces:

ClientRegistrationProvider, OAuthDataProvider

Direct Known Subclasses:

DefaultEncryptingCodeDataProvider
```
public class DefaultEncryptingOAuthDataProvider
extends AbstractOAuthDataProvider
implements ClientRegistrationProvider
```

Field Summary

Fields
Modifier and Type Field and Description

protected SecretKey key

Fields
Modifier and Type	Field and Description
`protected SecretKey`	`key`

Constructor Summary

Constructors
Constructor and Description
`DefaultEncryptingOAuthDataProvider(KeyProperties props)`
`DefaultEncryptingOAuthDataProvider(SecretKey key)`
`DefaultEncryptingOAuthDataProvider(String algo, int keySize)`

Method Summary

Methods
Modifier and Type	Method and Description
`ServerAccessToken`	`getAccessToken(String accessToken)` Get access token
`Client`	`getClient(String clientId)` Returns the previously registered third-party `Client`
`List<Client>`	`getClients()`
`void`	`removeAccessToken(ServerAccessToken accessToken)` Removes the access token The runtime will call this method if it finds that a token has expired
`Client`	`removeClient(String clientId)`
`protected boolean`	`revokeAccessToken(String accessTokenKey)`
`protected RefreshToken`	`revokeRefreshToken(Client client, String refreshTokenKey)`
`protected void`	`saveAccessToken(ServerAccessToken serverToken)`
`protected void`	`saveRefreshToken(ServerAccessToken at, RefreshToken refreshToken)`
`void`	`setClient(Client client)`

Methods inherited from class org.apache.cxf.rs.security.oauth2.provider.AbstractOAuthDataProvider
convertScopeToPermissions, createAccessToken, createNewAccessToken, createNewRefreshToken, doCreateAccessToken, doRefreshAccessToken, getPreauthorizedToken, refreshAccessToken, revokeToken, setAccessTokenLifetime, setRefreshTokenLifetime

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

- Field Detail
  - key
```
protected SecretKey key
```
- Constructor Detail
  - DefaultEncryptingOAuthDataProvider
```
public DefaultEncryptingOAuthDataProvider(String algo,
                                  int keySize)
```
  - DefaultEncryptingOAuthDataProvider
```
public DefaultEncryptingOAuthDataProvider(KeyProperties props)
```
  - DefaultEncryptingOAuthDataProvider
```
public DefaultEncryptingOAuthDataProvider(SecretKey key)
```
- Method Detail
  - getClient
```
public Client getClient(String clientId)
                 throws OAuthServiceException
```
    Description copied from interface: OAuthDataProvider
    
    Returns the previously registered third-party Client
    
    Specified by:
    
    getClient in interface ClientRegistrationProvider
    
    Specified by:
    
    getClient in interface OAuthDataProvider
    
    Parameters:
    clientId - the client id
    
    Returns:
    Client
    
    Throws:
    
    OAuthServiceException
  - setClient
```
public void setClient(Client client)
```
    Specified by:
    
    setClient in interface ClientRegistrationProvider
  - removeClient
```
public Client removeClient(String clientId)
```
    Specified by:
    
    removeClient in interface ClientRegistrationProvider
  - getClients
```
public List<Client> getClients()
```
    Specified by:
    
    getClients in interface ClientRegistrationProvider
  - getAccessToken
```
public ServerAccessToken getAccessToken(String accessToken)
                                 throws OAuthServiceException
```
    Description copied from interface: OAuthDataProvider
    
    Get access token
    
    Specified by:
    
    getAccessToken in interface OAuthDataProvider
    
    Parameters:
    accessToken - the token key
    
    Returns:
    AccessToken
    
    Throws:
    
    OAuthServiceException
  - removeAccessToken
```
public void removeAccessToken(ServerAccessToken accessToken)
                       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:
    accessToken - the token
    
    Throws:
    
    OAuthServiceException
  - saveAccessToken
```
protected void saveAccessToken(ServerAccessToken serverToken)
```
    Specified by:
    
    saveAccessToken in class AbstractOAuthDataProvider
  - revokeAccessToken
```
protected boolean revokeAccessToken(String accessTokenKey)
```
    Specified by:
    
    revokeAccessToken in class AbstractOAuthDataProvider
  - saveRefreshToken
```
protected void saveRefreshToken(ServerAccessToken at,
                    RefreshToken refreshToken)
```
    Specified by:
    
    saveRefreshToken in class AbstractOAuthDataProvider
  - revokeRefreshToken
```
protected RefreshToken revokeRefreshToken(Client client,
                              String refreshTokenKey)
```
    Specified by:
    
    revokeRefreshToken in class AbstractOAuthDataProvider

Class DefaultEncryptingOAuthDataProvider

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.cxf.rs.security.oauth2.provider.AbstractOAuthDataProvider

Methods inherited from class java.lang.Object

Field Detail

key

Constructor Detail

DefaultEncryptingOAuthDataProvider

DefaultEncryptingOAuthDataProvider

DefaultEncryptingOAuthDataProvider

Method Detail

getClient

setClient

removeClient

getClients

getAccessToken

removeAccessToken

saveAccessToken

revokeAccessToken

saveRefreshToken

revokeRefreshToken