org.springframework.security.oauth2.provider.endpoint

Class TokenEndpoint

java.lang.Object

org.springframework.security.oauth2.provider.endpoint.AbstractEndpoint

org.springframework.security.oauth2.provider.endpoint.TokenEndpoint

All Implemented Interfaces:

InitializingBean

public class TokenEndpoint
extends AbstractEndpoint

Endpoint for token requests as described in the OAuth2 spec. Clients post requests with a grant_type parameter (e.g. "authorization_code") and other parameters as determined by the grant type. Supported grant types are handled by the provided token granter.

Clients must be authenticated using a Spring Security Authentication to access this endpoint, and the client id is extracted from the authentication token. The best way to arrange this (as per the OAuth2 spec) is to use HTTP basic authentication for this endpoint with standard Spring Security support.

Author:

Dave Syer

Field Summary

Fields inherited from class org.springframework.security.oauth2.provider.endpoint.AbstractEndpoint

logger

Constructor Summary

Constructors

Constructor and Description
TokenEndpoint()

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<OAuth2AccessToken>	getAccessToken(Principal principal, Map<String,String> parameters)
protected String	getClientId(Principal principal)
org.springframework.http.ResponseEntity<OAuth2Exception>	handleClientRegistrationException(Exception e)
org.springframework.http.ResponseEntity<OAuth2Exception>	handleException(Exception e)
org.springframework.http.ResponseEntity<OAuth2Exception>	handleException(OAuth2Exception e)
org.springframework.http.ResponseEntity<OAuth2Exception>	handleHttpRequestMethodNotSupportedException(HttpRequestMethodNotSupportedException e)
org.springframework.http.ResponseEntity<OAuth2AccessToken>	postAccessToken(Principal principal, Map<String,String> parameters)
void	setAllowedRequestMethods(Set<org.springframework.http.HttpMethod> allowedRequestMethods)
void	setOAuth2RequestValidator(OAuth2RequestValidator oAuth2RequestValidator)

Methods inherited from class org.springframework.security.oauth2.provider.endpoint.AbstractEndpoint

afterPropertiesSet, getClientDetailsService, getDefaultOAuth2RequestFactory, getExceptionTranslator, getOAuth2RequestFactory, getTokenGranter, setClientDetailsService, setOAuth2RequestFactory, setProviderExceptionHandler, setTokenGranter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TokenEndpoint

public TokenEndpoint()

Method Detail

getAccessToken

@RequestMapping(value="/oauth/token",
                method=GET)
public org.springframework.http.ResponseEntity<OAuth2AccessToken> getAccessToken(Principal principal,
                                                                                                     @RequestParam
                                                                                                     Map<String,String> parameters)
                                                                          throws HttpRequestMethodNotSupportedException

Throws:

HttpRequestMethodNotSupportedException

postAccessToken

@RequestMapping(value="/oauth/token",
                method=POST)
public org.springframework.http.ResponseEntity<OAuth2AccessToken> postAccessToken(Principal principal,
                                                                                                       @RequestParam
                                                                                                       Map<String,String> parameters)
                                                                           throws HttpRequestMethodNotSupportedException

Throws:

HttpRequestMethodNotSupportedException

getClientId

protected String getClientId(Principal principal)

Parameters:

principal - the currently authentication principal

Returns:

a client id if there is one in the principal

handleHttpRequestMethodNotSupportedException

@ExceptionHandler(value=org.springframework.web.HttpRequestMethodNotSupportedException.class)
public org.springframework.http.ResponseEntity<OAuth2Exception> handleHttpRequestMethodNotSupportedException(HttpRequestMethodNotSupportedException e)
                                                                                                      throws Exception

Throws:

Exception

handleException

@ExceptionHandler(value=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<OAuth2Exception> handleException(Exception e)
                                                                         throws Exception

Throws:

Exception

handleClientRegistrationException

@ExceptionHandler(value=ClientRegistrationException.class)
public org.springframework.http.ResponseEntity<OAuth2Exception> handleClientRegistrationException(Exception e)
                                                                                           throws Exception

Throws:

Exception

handleException

@ExceptionHandler(value=OAuth2Exception.class)
public org.springframework.http.ResponseEntity<OAuth2Exception> handleException(OAuth2Exception e)
                                                                         throws Exception

Throws:

Exception

setOAuth2RequestValidator

public void setOAuth2RequestValidator(OAuth2RequestValidator oAuth2RequestValidator)

setAllowedRequestMethods

public void setAllowedRequestMethods(Set<org.springframework.http.HttpMethod> allowedRequestMethods)