Apache CXF API

org.apache.cxf.rs.security.oauth2.common
Class OAuthError

java.lang.Object
  extended by org.apache.cxf.rs.security.oauth2.common.OAuthError

public class OAuthError
extends Object

Captures OAuth2 error properties


Constructor Summary
OAuthError()
           
OAuthError(String error)
           
OAuthError(String error, String descr)
           
 
Method Summary
 String getError()
          Gets the error
 String getErrorDescription()
          Gets the error description
 String getErrorUri()
          Gets the optional link to the page describing the error in detail
 String getState()
          Gets the client state token
 void setError(String error)
          Sets the error such as "invalid_grant", etc
 void setErrorDescription(String errorDescription)
          Sets the error description
 void setErrorUri(String errorUri)
          Sets the optional link to the page describing the error in detail
 void setState(String state)
          Sets the client state token which needs to be returned to the client alongside the error information if it was provided during the client request
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OAuthError

public OAuthError()

OAuthError

public OAuthError(String error)

OAuthError

public OAuthError(String error,
                  String descr)
Method Detail

setError

public void setError(String error)
Sets the error such as "invalid_grant", etc

Parameters:
error - the error

getError

public String getError()
Gets the error

Returns:
error

setErrorDescription

public void setErrorDescription(String errorDescription)
Sets the error description

Parameters:
errorDescription - error description

getErrorDescription

public String getErrorDescription()
Gets the error description

Returns:
error description

setErrorUri

public void setErrorUri(String errorUri)
Sets the optional link to the page describing the error in detail

Parameters:
errorUri - error page URI

getErrorUri

public String getErrorUri()
Gets the optional link to the page describing the error in detail

Parameters:
errorUri - error page URI

setState

public void setState(String state)
Sets the client state token which needs to be returned to the client alongside the error information if it was provided during the client request

Parameters:
state - the client state token

getState

public String getState()
Gets the client state token

Returns:
the state

Apache CXF API

Apache CXF