AuthorizationCodeDataProvider (Apache CXF JavaDoc 3.0.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Apache CXF API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.cxf.rs.security.oauth2.grants.code
Interface AuthorizationCodeDataProvider

All Superinterfaces:: OAuthDataProvider

All Known Implementing Classes:: AbstractAuthorizationCodeDataProvider

public interface AuthorizationCodeDataProvider
extends OAuthDataProvider
extends OAuthDataProvider

AuthorizationCodeDataProvider is the OAuthDataProvider which can additionally persist the authorization code grant information

Method Summary
`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
`ServerAuthorizationCodeGrant`	`removeCodeGrant(String code)` Returns the previously registered `ServerAuthorizationCodeGrant`

Methods inherited from interface org.apache.cxf.rs.security.oauth2.provider.OAuthDataProvider
`convertScopeToPermissions, createAccessToken, getAccessToken, getClient, getPreauthorizedToken, refreshAccessToken, removeAccessToken, revokeToken`

Method Detail

createCodeGrant

ServerAuthorizationCodeGrant createCodeGrant(AuthorizationCodeRegistration reg)
                                             throws OAuthServiceException

Creates a temporarily code grant which will capture the information about the Client requesting the access to the resource owner's resources

Parameters:: reg - information about the client code grant request
Returns:: new code grant
Throws:: OAuthServiceException
See Also:: AuthorizationCodeRegistration, ServerAuthorizationCodeGrant

removeCodeGrant

ServerAuthorizationCodeGrant removeCodeGrant(String code)
                                             throws OAuthServiceException

Returns the previously registered ServerAuthorizationCodeGrant

Parameters:: code - the code grant
Returns:: the grant
Throws:: OAuthServiceException - if no grant with this code is available
See Also:: ServerAuthorizationCodeGrant