org.springframework.security.oauth2.common.exceptions

Class InsufficientScopeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.springframework.security.oauth2.common.exceptions.OAuth2Exception

org.springframework.security.oauth2.common.exceptions.InsufficientScopeException

All Implemented Interfaces:

Serializable

public class InsufficientScopeException
extends OAuth2Exception

Exception representing insufficient scope in a token when a request is handled by a Resource Server. It is akin to an AccessDeniedException and should result in a 403 (FORBIDDEN) HTTP status.

Author:

Dave Syer

See Also:

Serialized Form

Field Summary

Fields inherited from class org.springframework.security.oauth2.common.exceptions.OAuth2Exception

ACCESS_DENIED, DESCRIPTION, ERROR, INSUFFICIENT_SCOPE, INVALID_CLIENT, INVALID_GRANT, INVALID_REQUEST, INVALID_SCOPE, INVALID_TOKEN, REDIRECT_URI_MISMATCH, UNAUTHORIZED_CLIENT, UNSUPPORTED_GRANT_TYPE, UNSUPPORTED_RESPONSE_TYPE, URI

Constructor Summary

Constructors

Constructor and Description
InsufficientScopeException(String msg)
InsufficientScopeException(String msg, Set<String> validScope)

Method Summary

Modifier and Type	Method and Description
int	getHttpErrorCode() The HTTP error code associated with this error.
String	getOAuth2ErrorCode() The OAuth2 error code.

Methods inherited from class org.springframework.security.oauth2.common.exceptions.OAuth2Exception

addAdditionalInformation, create, getAdditionalInformation, getSummary, toString, valueOf

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Detail

InsufficientScopeException

public InsufficientScopeException(String msg,
                                  Set<String> validScope)

InsufficientScopeException

public InsufficientScopeException(String msg)

Method Detail

getHttpErrorCode

public int getHttpErrorCode()

Description copied from class: OAuth2Exception

The HTTP error code associated with this error.

Overrides:

getHttpErrorCode in class OAuth2Exception

Returns:

The HTTP error code associated with this error.

getOAuth2ErrorCode

public String getOAuth2ErrorCode()

Description copied from class: OAuth2Exception

The OAuth2 error code.

Overrides:

getOAuth2ErrorCode in class OAuth2Exception

Returns:

The OAuth2 error code.