org.springframework.security.oauth2.provider.error

Class AbstractOAuth2SecurityExceptionHandler

java.lang.Object

org.springframework.security.oauth2.provider.error.AbstractOAuth2SecurityExceptionHandler

Direct Known Subclasses:

OAuth2AccessDeniedHandler, OAuth2AuthenticationEntryPoint

public abstract class AbstractOAuth2SecurityExceptionHandler
extends Object

Convenient base class containing utility methods and dependency setters for security error handling concerns specific to OAuth2 resources.

Author:

Dave Syer

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	logger Logger available to subclasses

Constructor Summary

Constructors

Constructor and Description
AbstractOAuth2SecurityExceptionHandler()

Method Summary

Modifier and Type	Method and Description
protected void	doHandle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Exception authException)
protected org.springframework.http.ResponseEntity<?>	enhanceResponse(org.springframework.http.ResponseEntity<?> result, Exception authException) Allow subclasses to manipulate the response before it is rendered.
void	setExceptionRenderer(OAuth2ExceptionRenderer exceptionRenderer)
void	setExceptionTranslator(WebResponseExceptionTranslator<?> exceptionTranslator)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.apache.commons.logging.Log logger

Logger available to subclasses

Constructor Detail

AbstractOAuth2SecurityExceptionHandler

public AbstractOAuth2SecurityExceptionHandler()

Method Detail

setExceptionTranslator

public void setExceptionTranslator(WebResponseExceptionTranslator<?> exceptionTranslator)

setExceptionRenderer

public void setExceptionRenderer(OAuth2ExceptionRenderer exceptionRenderer)

doHandle

protected final void doHandle(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response,
                              Exception authException)
                       throws IOException,
                              javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

enhanceResponse

protected org.springframework.http.ResponseEntity<?> enhanceResponse(org.springframework.http.ResponseEntity<?> result,
                                                                     Exception authException)

Allow subclasses to manipulate the response before it is rendered. Note : Only the ResponseEntity should be enhanced. If the response body is to be customized, it should be done at the WebResponseExceptionTranslator level.

Parameters:

result - the response that was generated by the exception translator.

authException - the authentication exception that is being handled