Package net.shibboleth.idp.plugin.oidc.op.messaging.impl

Class FrontChannelLogoutPropagationResponse

java.lang.Object

net.shibboleth.idp.plugin.oidc.op.messaging.impl.FrontChannelLogoutPropagationResponse

All Implemented Interfaces:

Message, Response

public class FrontChannelLogoutPropagationResponse
extends Object
implements Response

A Nimbus Response implementation representing a front-channel logout propagation message that is sent to the RP's front-channel logout URI endpoint.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	frontChannelLogoutUri	The front-channel logout endpoint.
private final String	issuer	The optional issuer (iss-parameter) value.
private final org.slf4j.Logger	log	Class logger.
private final String	sessionId	The optional sessionId (sid-parameter) value.

Constructor Summary

Constructors

Constructor	Description
FrontChannelLogoutPropagationResponse(String uri)	Constructor.
FrontChannelLogoutPropagationResponse(String uri, String iss, String sid)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	indicatesSuccess()
protected String	serializeParameters(String prefix)	URL-encode the iss and sid -parameters to the given prefix if parameter values have been set.
HTTPResponse	toHTTPResponse()	Returns an HTTP response for this logout propagation response by using HTTP 302 redirection.

Methods inherited from class java.lang.Object

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

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

frontChannelLogoutUri

@Nonnull
private final String frontChannelLogoutUri

The front-channel logout endpoint.

issuer

@Nullable
private final String issuer

The optional issuer (iss-parameter) value.

sessionId

@Nullable
private final String sessionId

The optional sessionId (sid-parameter) value.

Constructor Details

FrontChannelLogoutPropagationResponse

public FrontChannelLogoutPropagationResponse(@Nonnull
 String uri)

Constructor.

Parameters:

uri - The front-channel logout URI.

FrontChannelLogoutPropagationResponse

public FrontChannelLogoutPropagationResponse(@Nonnull
 String uri,
 @Nullable
 String iss,
 @Nullable
 String sid)

Constructor.

Parameters:

uri - The front-channel logout URI.

iss - The optional issuer -parameter value.

sid - The optional sessionId -parameter value.

Method Details

indicatesSuccess

public boolean indicatesSuccess()

Specified by:

indicatesSuccess in interface Response

toHTTPResponse

public HTTPResponse toHTTPResponse()

Returns an HTTP response for this logout propagation response by using HTTP 302 redirection.

Example HTTP response:

 HTTP/1.1 302 Found
 Location: http://example.org/logout?iss=https://op.example.org&sid=1234567890ABCDEFG
 

Specified by:

toHTTPResponse in interface Response

Returns:

An HTTP response for this message.

serializeParameters

@Nonnull
protected String serializeParameters(@Nonnull
 String prefix)
                              throws UnsupportedEncodingException

URL-encode the iss and sid -parameters to the given prefix if parameter values have been set.

Parameters:

prefix - The prefix/URL for which to add the parameters.

Returns:

The given prefix possibly appended with parameter names and values

Throws:

UnsupportedEncodingException - If the parameter values could not be encoded with UTF-8