public abstract class AuthorizationResponse extends Object implements Response
Related specifications:
Modifier | Constructor and Description |
---|---|
protected |
AuthorizationResponse(URI redirectURI,
State state,
ResponseMode rm)
Creates a new authorisation response.
|
Modifier and Type | Method and Description |
---|---|
URI |
getRedirectionURI()
Returns the base redirection URI.
|
ResponseMode |
getResponseMode()
Returns the optional explicit response mode.
|
State |
getState()
Returns the optional state.
|
abstract ResponseMode |
impliedResponseMode()
Determines the implied response mode.
|
static AuthorizationResponse |
parse(HTTPRequest httpRequest)
Parses an authorisation response from the specified HTTP request at
the client redirection (callback) URI.
|
static AuthorizationResponse |
parse(HTTPResponse httpResponse)
Parses an authorisation response from the specified initial HTTP 302
redirect response output at the authorisation endpoint.
|
static AuthorizationResponse |
parse(URI uri)
Parses an authorisation response.
|
static AuthorizationResponse |
parse(URI redirectURI,
Map<String,String> params)
Parses an authorisation response.
|
AuthorizationErrorResponse |
toErrorResponse()
Casts this response to an authorisation error response.
|
HTTPRequest |
toHTTPRequest()
Returns an HTTP request for this authorisation response.
|
HTTPResponse |
toHTTPResponse()
Returns an HTTP response for this authorisation response.
|
abstract Map<String,String> |
toParameters()
Returns the parameters of this authorisation response.
|
AuthorizationSuccessResponse |
toSuccessResponse()
Casts this response to an authorisation success response.
|
URI |
toURI()
Returns a URI representation (redirection URI + fragment / query
string) of this authorisation response.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
indicatesSuccess
protected AuthorizationResponse(URI redirectURI, State state, ResponseMode rm)
redirectURI
- The base redirection URI. Must not be
null
.state
- The state, null
if not requested.rm
- The response mode, null
if not specified.public URI getRedirectionURI()
public State getState()
null
if not requested.public ResponseMode getResponseMode()
null
if not specified.public abstract ResponseMode impliedResponseMode()
public abstract Map<String,String> toParameters()
Example parameters (authorisation success):
access_token = 2YotnFZFEjr1zCsicMWpAA state = xyz token_type = example expires_in = 3600
public URI toURI()
Example URI:
http://example.com/cb#access_token=2YotnFZFEjr1zCsicMWpAA &state=xyz &token_type=example &expires_in=3600
public HTTPResponse toHTTPResponse()
query
or fragment
response mode using HTTP 302
redirection.
Example HTTP response (authorisation success):
HTTP/1.1 302 Found Location: http://example.com/cb#access_token=2YotnFZFEjr1zCsicMWpAA &state=xyz &token_type=example &expires_in=3600
toHTTPResponse
in interface Response
toHTTPRequest()
public HTTPRequest toHTTPRequest()
form_post
response mode.
Example HTTP request (authorisation success):
GET /cb?code=SplxlOBeZQQYbYS6WxSbIA&state=xyz HTTP/1.1 Host: client.example.com
toHTTPResponse()
public AuthorizationSuccessResponse toSuccessResponse()
public AuthorizationErrorResponse toErrorResponse()
public static AuthorizationResponse parse(URI redirectURI, Map<String,String> params) throws ParseException
redirectURI
- The base redirection 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
authorisation success or error response.public static AuthorizationResponse parse(URI uri) throws ParseException
Use a relative URI if the host, port and path details are not known:
URI relUrl = new URI("https:///?code=Qcb0Orv1...&state=af0ifjsldkj");
uri
- The URI to parse. Can be absolute or relative, with a
fragment or query string containing the authorisation
response parameters. Must not be null
.ParseException
- If no authorisation response parameters were
found in the URL.public static AuthorizationResponse parse(HTTPResponse httpResponse) throws ParseException
Example HTTP response (authorisation success):
HTTP/1.1 302 Found Location: https://client.example.com/cb?code=SplxlOBeZQQYbYS6WxSbIA&state=xyz
httpResponse
- The HTTP response to parse. Must not be
null
.ParseException
- If the HTTP response couldn't be parsed to an
authorisation response.parse(HTTPRequest)
public static AuthorizationResponse parse(HTTPRequest httpRequest) throws ParseException
query
,
fragment
and form_post
response modes.
Example HTTP request (authorisation success):
GET /cb?code=SplxlOBeZQQYbYS6WxSbIA&state=xyz HTTP/1.1 Host: client.example.com
httpRequest
- The HTTP request to parse. Must not be
null
.ParseException
- If the HTTP request couldn't be parsed to an
authorisation response.parse(HTTPResponse)
Copyright © 2018 Connect2id Ltd.. All rights reserved.