AccessTokenService (Apache CXF Runtime OAuth 2.0 2.7.4 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.cxf.rs.security.oauth2.services
Class AccessTokenService

java.lang.Object
  org.apache.cxf.rs.security.oauth2.services.AbstractOAuthService
      org.apache.cxf.rs.security.oauth2.services.AccessTokenService

@Path(value="/token") public class AccessTokenService
extends AbstractOAuthService
extends AbstractOAuthService

OAuth2 Access Token Service implementation

Constructor Summary
`AccessTokenService()`

Method Summary
`protected javax.ws.rs.core.Response`	`createErrorResponse(javax.ws.rs.core.MultivaluedMap<String,String> params, String error)`
`protected javax.ws.rs.core.Response`	`createErrorResponseFromBean(OAuthError errorBean)`
`protected AccessTokenGrantHandler`	`findGrantHandler(javax.ws.rs.core.MultivaluedMap<String,String> params)` Find the mathcing grant handler
`protected Client`	`getClient(String clientId)` Get the `Client` reference
`javax.ws.rs.core.Response`	`handleTokenRequest(javax.ws.rs.core.MultivaluedMap<String,String> params)` Processes an access token request
`void`	`setGrantHandlers(List<AccessTokenGrantHandler> handlers)` Sets the list of optional grant handlers
`void`	`setWriteCustomErrors(boolean write)`

Methods inherited from class org.apache.cxf.rs.security.oauth2.services.AbstractOAuthService
`checkTransportSecurity, getDataProvider, getMessageContext, getQueryParameters, getValidClient, getValidClient, isWriteOptionalParameters, reportInvalidRequestError, reportInvalidRequestError, reportInvalidRequestError, setBlockUnsecureRequests, setDataProvider, setMessageContext, setWriteOptionalParameters`

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

Constructor Detail

AccessTokenService

public AccessTokenService()

Method Detail

setWriteCustomErrors

public void setWriteCustomErrors(boolean write)

setGrantHandlers

public void setGrantHandlers(List<AccessTokenGrantHandler> handlers)

Sets the list of optional grant handlers

Parameters:: handlers - the grant handlers

handleTokenRequest

public javax.ws.rs.core.Response handleTokenRequest(javax.ws.rs.core.MultivaluedMap<String,String> params)

Processes an access token request

Parameters:: params - the form parameters representing the access token grant
Returns:: Access Token or the error

findGrantHandler

protected AccessTokenGrantHandler findGrantHandler(javax.ws.rs.core.MultivaluedMap<String,String> params)

Find the mathcing grant handler

createErrorResponse

protected javax.ws.rs.core.Response createErrorResponse(javax.ws.rs.core.MultivaluedMap<String,String> params,
                                                        String error)

createErrorResponseFromBean

protected javax.ws.rs.core.Response createErrorResponseFromBean(OAuthError errorBean)

getClient

protected Client getClient(String clientId)

Get the Client reference

Parameters:: clientId - the provided client id
Returns:: Client the client reference
Throws:: {@link - javax.ws.rs.WebApplicationException} if no matching Client is found