Package io.jans.as.client

Class EndSessionRequest

java.lang.Object

io.jans.as.client.BaseRequest

io.jans.as.client.EndSessionRequest

public class EndSessionRequest
extends BaseRequest

Represents an end session request to send to the authorization server.

Version:

August 9, 2017

Author:

Javier Rojas Blum

Constructor Summary

Constructors

Constructor	Description
EndSessionRequest(String idTokenHint, String postLogoutRedirectUri, String state)	Constructs an end session request.

Method Summary

Modifier and Type	Method	Description
String	getIdTokenHint()	Returns the issued ID Token.
String	getPostLogoutRedirectUri()	Returns the URL to which the RP is requesting that the End-User's User-Agent be redirected after a logout has been performed.
String	getQueryString()	Returns a query string with the parameters of the end session request.
String	getSid()	Gets sid.
String	getState()	Returns the state.
void	setAccessToken(String idTokenHint)	Sets the issued ID Token.
void	setPostLogoutRedirectUri(String postLogoutRedirectUri)	Sets the URL to which the RP is requesting that the End-User's User-Agent be redirected after a logout has been performed.
void	setSid(String sid)	Sets sid.
void	setState(String state)	Sets the state.

Methods inherited from class io.jans.as.client.BaseRequest

addCustomParameter, getAuthenticationMethod, getAuthorizationMethod, getAuthPassword, getAuthUsername, getContentType, getCredentials, getCustomParameters, getEncodedCredentials, getEncodedCredentials, getJSONParameters, getMediaType, getParameters, hasCredentials, setAuthenticationMethod, setAuthorizationMethod, setAuthPassword, setAuthUsername, setContentType, setMediaType

Methods inherited from class java.lang.Object

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

Constructor Detail

EndSessionRequest

public EndSessionRequest(String idTokenHint,
                         String postLogoutRedirectUri,
                         String state)

Constructs an end session request.

Method Detail

getIdTokenHint

public String getIdTokenHint()

Returns the issued ID Token.

Returns:

The issued ID Token.

setAccessToken

public void setAccessToken(String idTokenHint)

Sets the issued ID Token.

Parameters:

idTokenHint - The issued ID Token.

getPostLogoutRedirectUri

public String getPostLogoutRedirectUri()

Returns the URL to which the RP is requesting that the End-User's User-Agent be redirected after a logout has been performed.

Returns:

The post logout redirection URI.

setPostLogoutRedirectUri

public void setPostLogoutRedirectUri(String postLogoutRedirectUri)

Sets the URL to which the RP is requesting that the End-User's User-Agent be redirected after a logout has been performed.

Parameters:

postLogoutRedirectUri - The post logout redirection URI.

getSid

public String getSid()

Gets sid.

Returns:

sid.

setSid

public void setSid(String sid)

Sets sid.

Parameters:

sid - sid

getState

public String getState()

Returns the state. The state is an opaque value used by the RP to maintain state between the logout request and the callback to the endpoint specified by the post_logout_redirect_uri parameter. If included in the logout request, the OP passes this value back to the RP using the state query parameter when redirecting the User Agent back to the RP.

Returns:

The state.

setState

public void setState(String state)

Sets the state. The state is an opaque value used by the RP to maintain state between the logout request and the callback to the endpoint specified by the post_logout_redirect_uri parameter. If included in the logout request, the OP passes this value back to the RP using the state query parameter when redirecting the User Agent back to the RP.

Parameters:

state - he state.

getQueryString

public String getQueryString()

Returns a query string with the parameters of the end session request. Any null or empty parameter will be omitted.

Specified by:

getQueryString in class BaseRequest

Returns:

A query string of parameters.