org.springframework.security.oauth2.client
Class UserRedirectRequiredException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.lang.RuntimeException
              extended by org.springframework.security.oauth2.client.UserRedirectRequiredException
All Implemented Interfaces:
Serializable

public class UserRedirectRequiredException
extends RuntimeException

Special exception thrown when a user redirect is required in order to obtain an OAuth2 access token.

Author:
Ryan Heaton
See Also:
Serialized Form

Constructor Summary
UserRedirectRequiredException(String redirectUri, Map<String,String> requestParams)
           
 
Method Summary
 String getRedirectUri()
          The uri to which the user is to be redirected.
 Map<String,String> getRequestParams()
          The request parameters that are to be appended to the uri.
 String getStateKey()
          The key to the state to preserve.
 Object getStateToPreserve()
          Some state that needs to be preserved and set up in the security context when the user returns.
 void setStateKey(String stateKey)
          The key to the state to preserve.
 void setStateToPreserve(Object stateToPreserve)
          The state that needs to be preserved and set up in the security context when the user returns.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UserRedirectRequiredException

public UserRedirectRequiredException(String redirectUri,
                                     Map<String,String> requestParams)
Method Detail

getRedirectUri

public String getRedirectUri()
The uri to which the user is to be redirected.

Returns:
The uri to which the user is to be redirected.

getRequestParams

public Map<String,String> getRequestParams()
The request parameters that are to be appended to the uri.

Returns:
The request parameters that are to be appended to the uri.

getStateKey

public String getStateKey()
The key to the state to preserve.

Returns:
The key to the state to preserve.

setStateKey

public void setStateKey(String stateKey)
The key to the state to preserve.

Parameters:
stateKey - The key to the state to preserve.

getStateToPreserve

public Object getStateToPreserve()
Some state that needs to be preserved and set up in the security context when the user returns.

Returns:
The state that needs to be preserved.

setStateToPreserve

public void setStateToPreserve(Object stateToPreserve)
The state that needs to be preserved and set up in the security context when the user returns.

Parameters:
stateToPreserve - The state.


Copyright © 2012. All Rights Reserved.