Package com.onelogin.saml2.logout

Class LogoutResponseParams

java.lang.Object

com.onelogin.saml2.logout.LogoutResponseParams

public class LogoutResponseParams
extends java.lang.Object

Input parameters for a SAML 2 logout response.

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	inResponseTo	Id of the logout request the response refers to.
private SamlResponseStatus	responseStatus	Response status.

Constructor Summary

Constructors

Modifier	Constructor	Description
	LogoutResponseParams()	Creates a logout response with no inResponseTo attribute and a response status with a top-level Constants.STATUS_SUCCESS status code.
protected	LogoutResponseParams(LogoutResponseParams source)	Create a set of logout request input parameters, by copying them from another set.
	LogoutResponseParams(java.lang.String inResponseTo)	Creates a logout response with a response status with a top-level Constants.STATUS_SUCCESS status code.
	LogoutResponseParams(java.lang.String inResponseTo, SamlResponseStatus responseStatus)	Creates a logout response.
	LogoutResponseParams(java.lang.String inResponseTo, java.lang.String statusCode)	Creates a logout response.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getInResponseTo()	Returns the id of the logout request this response refers to.
SamlResponseStatus	getResponseStatus()	Returns the response status.

Methods inherited from class java.lang.Object

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

Field Detail

inResponseTo

private final java.lang.String inResponseTo

Id of the logout request the response refers to.

responseStatus

private final SamlResponseStatus responseStatus

Response status.

Constructor Detail

LogoutResponseParams

public LogoutResponseParams()

Creates a logout response with no inResponseTo attribute and a response status with a top-level Constants.STATUS_SUCCESS status code.

LogoutResponseParams

public LogoutResponseParams(java.lang.String inResponseTo)

Creates a logout response with a response status with a top-level Constants.STATUS_SUCCESS status code.

Parameters:

inResponseTo - the id of the logout request the response refers to; may be null if such id cannot be determined (possibly because the request is malformed)

LogoutResponseParams

public LogoutResponseParams(java.lang.String inResponseTo,
                            java.lang.String statusCode)

Creates a logout response.

Parameters:

inResponseTo - the id of the logout request the response refers to; may be null if such id cannot be determined (possibly because the request is malformed)

statusCode - the top-level status code code to set on the response

LogoutResponseParams

public LogoutResponseParams(java.lang.String inResponseTo,
                            SamlResponseStatus responseStatus)
                     throws java.lang.NullPointerException

Creates a logout response.

Parameters:

inResponseTo - the id of the logout request the response refers to; may be null if such id cannot be determined (possibly because the request is malformed)

responseStatus - the response status; should not be null

Throws:

java.lang.NullPointerException - if the specified response status is null

LogoutResponseParams

protected LogoutResponseParams(LogoutResponseParams source)

Create a set of logout request input parameters, by copying them from another set.

Parameters:

source - the source set of logout request input parameters

Method Detail

getResponseStatus

public SamlResponseStatus getResponseStatus()

Returns the response status.

Returns:

the response status

getInResponseTo

public java.lang.String getInResponseTo()

Returns the id of the logout request this response refers to.

Returns:

the inResponseTo