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

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

All Implemented Interfaces:: AuthorizationCodeDataProvider, ClientRegistrationProvider, OAuthDataProvider

public class DefaultEncryptingCodeDataProvider
extends DefaultEncryptingOAuthDataProvider
implements AuthorizationCodeDataProvider

Field Summary
- Fields inherited from class org.apache.cxf.rs.security.oauth2.provider.DefaultEncryptingOAuthDataProvider
  key

Constructor Summary

Constructors
Constructor and Description
`DefaultEncryptingCodeDataProvider(org.apache.cxf.common.util.crypto.KeyProperties props)`
`DefaultEncryptingCodeDataProvider(SecretKey key)`
`DefaultEncryptingCodeDataProvider(String algo, int keySize)`

Method Summary

Methods
Modifier and Type	Method and Description
`ServerAuthorizationCodeGrant`	`createCodeGrant(AuthorizationCodeRegistration reg)` Creates a temporarily code grant which will capture the information about the `Client` requesting the access to the resource owner's resources
`protected ServerAuthorizationCodeGrant`	`doCreateCodeGrant(AuthorizationCodeRegistration reg)`
`protected List<String>`	`getApprovedScopes(AuthorizationCodeRegistration reg)`
`protected String`	`getCode(AuthorizationCodeRegistration reg)`
`ServerAuthorizationCodeGrant`	`getCodeGrant(String code)`
`List<ServerAuthorizationCodeGrant>`	`getCodeGrants(Client c)`
`long`	`getGrantLifetime()`
`protected long`	`getIssuedAt()`
`Client`	`removeClient(String clientId)`
`protected void`	`removeClientCodeGrants(Client c)`
`ServerAuthorizationCodeGrant`	`removeCodeGrant(String code)` Returns the previously registered `ServerAuthorizationCodeGrant`
`protected void`	`saveAuthorizationGrant(ServerAuthorizationCodeGrant grant)`
`void`	`setGrantLifetime(long lifetime)`

Methods inherited from class org.apache.cxf.rs.security.oauth2.provider.DefaultEncryptingOAuthDataProvider
getAccessToken, getAccessTokens, getClient, getClients, getRefreshToken, getRefreshTokens, revokeAccessToken, revokeRefreshToken, saveAccessToken, saveRefreshToken, setClient

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
convertScopeToPermissions, createAccessToken, getAccessToken, getClient, getPreauthorizedToken, refreshAccessToken, removeAccessToken, revokeToken

Constructor Detail

DefaultEncryptingCodeDataProvider

public DefaultEncryptingCodeDataProvider(String algo,
                                 int keySize)

DefaultEncryptingCodeDataProvider

public DefaultEncryptingCodeDataProvider(org.apache.cxf.common.util.crypto.KeyProperties props)

DefaultEncryptingCodeDataProvider

public DefaultEncryptingCodeDataProvider(SecretKey key)

Method Detail
- removeClient
```
public Client removeClient(String clientId)
```
  Specified by:
  
  removeClient in interface ClientRegistrationProvider
  
  Overrides:
  
  removeClient in class DefaultEncryptingOAuthDataProvider
- removeClientCodeGrants
```
protected void removeClientCodeGrants(Client c)
```
- createCodeGrant
```
public ServerAuthorizationCodeGrant createCodeGrant(AuthorizationCodeRegistration reg)
                                             throws OAuthServiceException
```
  Description copied from interface: AuthorizationCodeDataProvider
  
  Creates a temporarily code grant which will capture the information about the Client requesting the access to the resource owner's resources
  
  Specified by:
  
  createCodeGrant in interface AuthorizationCodeDataProvider
  
  Parameters:
  reg - information about the client code grant request
  
  Returns:
  new code grant
  
  Throws:
  
  OAuthServiceException
  See Also:
  AuthorizationCodeRegistration, ServerAuthorizationCodeGrant
- getCodeGrants
```
public List<ServerAuthorizationCodeGrant> getCodeGrants(Client c)
```
- removeCodeGrant
```
public ServerAuthorizationCodeGrant removeCodeGrant(String code)
                                             throws OAuthServiceException
```
  Description copied from interface: AuthorizationCodeDataProvider
  
  Returns the previously registered ServerAuthorizationCodeGrant
  
  Specified by:
  
  removeCodeGrant in interface AuthorizationCodeDataProvider
  
  Parameters:
  code - the code grant
  
  Returns:
  the grant
  
  Throws:
  
  OAuthServiceException - if no grant with this code is available
  See Also:
  ServerAuthorizationCodeGrant
- getCodeGrant
```
public ServerAuthorizationCodeGrant getCodeGrant(String code)
                                          throws OAuthServiceException
```
  Throws:
  
  OAuthServiceException
- doCreateCodeGrant
```
protected ServerAuthorizationCodeGrant doCreateCodeGrant(AuthorizationCodeRegistration reg)
                                                  throws OAuthServiceException
```
  Throws:
  
  OAuthServiceException
- getApprovedScopes
```
protected List<String> getApprovedScopes(AuthorizationCodeRegistration reg)
```
- getCode
```
protected String getCode(AuthorizationCodeRegistration reg)
```
- getGrantLifetime
```
public long getGrantLifetime()
```
- setGrantLifetime
```
public void setGrantLifetime(long lifetime)
```
- getIssuedAt
```
protected long getIssuedAt()
```
- saveAuthorizationGrant
```
protected void saveAuthorizationGrant(ServerAuthorizationCodeGrant grant)
```

Class DefaultEncryptingCodeDataProvider

Field Summary

Fields inherited from class org.apache.cxf.rs.security.oauth2.provider.DefaultEncryptingOAuthDataProvider

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultEncryptingCodeDataProvider

DefaultEncryptingCodeDataProvider

DefaultEncryptingCodeDataProvider

Method Detail

removeClient

removeClientCodeGrants

createCodeGrant

getCodeGrants

removeCodeGrant

getCodeGrant

doCreateCodeGrant

getApprovedScopes

getCode

getGrantLifetime

setGrantLifetime

getIssuedAt

saveAuthorizationGrant