|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.nimbusds.oauth2.sdk.AuthorizationResponse com.nimbusds.oauth2.sdk.AuthorizationErrorResponse com.nimbusds.openid.connect.sdk.OIDCAuthorizationErrorResponse
@Immutable public class OIDCAuthorizationErrorResponse
OpenID Connect authorisation error response. This class is immutable.
Standard errors:
Example HTTP response:
HTTP/1.1 302 Found Location: https://client.example.org/cb? error=invalid_request &error_description=the%20request%20is%20not%20valid%20or%20malformed &state=af0ifjsldkj
Related specifications:
Constructor Summary | |
---|---|
OIDCAuthorizationErrorResponse(URL redirectURI,
ErrorObject error,
ResponseType rt,
State state)
Creates a new OpenID Connect authorisation error response. |
Method Summary | |
---|---|
static Set<ErrorObject> |
getStandardErrors()
Gets the standard errors for an OpenID Connect Authorisation error response. |
static OIDCAuthorizationErrorResponse |
parse(HTTPResponse httpResponse)
Parses an OpenID Connect authorisation error response from the specified HTTP response. |
static OIDCAuthorizationErrorResponse |
parse(URL uri)
Parses an OpenID Connect authorisation error response from the specified URI. |
static OIDCAuthorizationErrorResponse |
parse(URL redirectURI,
Map<String,String> params)
Parses an OpenID Connect authorisation error response from the specified redirect URI and parameters. |
Methods inherited from class com.nimbusds.oauth2.sdk.AuthorizationErrorResponse |
---|
getErrorObject, getResponseType, toParameters, toURI |
Methods inherited from class com.nimbusds.oauth2.sdk.AuthorizationResponse |
---|
getRedirectURI, getState, toHTTPResponse |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.nimbusds.oauth2.sdk.Response |
---|
toHTTPResponse |
Constructor Detail |
---|
public OIDCAuthorizationErrorResponse(URL redirectURI, ErrorObject error, ResponseType rt, State state)
redirectURI
- The base redirect URI. Must not be null
.error
- The error. Should match one of the
standard errors
for an
OpenID Connect authorisation error response. Must
not be null
.rt
- The response type, used to determine the redirect
URI composition. If unknown null
.state
- The state, null
if not requested.Method Detail |
---|
public static Set<ErrorObject> getStandardErrors()
public static OIDCAuthorizationErrorResponse parse(URL redirectURI, Map<String,String> params) throws ParseException
redirectURI
- The base redirect URI. Must not be null
.params
- The response parameters to parse. Must not be
null
.
ParseException
- If the parameters couldn't be parsed to an
OpenID Connect authorisation error response.public static OIDCAuthorizationErrorResponse parse(URL uri) throws ParseException
Example URI:
https://client.example.com/cb? error=invalid_request &error_description=the%20request%20is%20not%20valid%20or%20malformed &state=af0ifjsldkj
uri
- The URI to parse. Can be absolute or relative. Must not
be null
.
ParseException
- If the URI couldn't be parsed to an OpenID
Connect authorisation error response.public static OIDCAuthorizationErrorResponse parse(HTTPResponse httpResponse) throws ParseException
Example HTTP response:
HTTP/1.1 302 Found Location: https://client.example.com/cb? error=invalid_request &error_description=the%20request%20is%20not%20valid%20or%20malformed &state=af0ifjsldkj
httpResponse
- The HTTP response to parse. Must not be
null
.
ParseException
- If the HTTP response couldn't be parsed to an
OpenID Connect authorisation error response.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |