Package com.onelogin.saml2.logout

Class LogoutRequestParams

java.lang.Object

com.onelogin.saml2.logout.LogoutRequestParams

public class LogoutRequestParams
extends Object

Input parameters for a SAML 2 logout request.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	nameId	NameID.
private final String	nameIdFormat	NameID Format.
private final String	nameIdNameQualifier	nameId NameQualifier
private final String	nameIdSPNameQualifier	nameId SP NameQualifier
private final String	sessionIndex	SessionIndex.

Constructor Summary

Constructors

Modifier	Constructor	Description
	LogoutRequestParams()	Create an empty set of logout request input parameters.
protected	LogoutRequestParams(LogoutRequestParams source)	Create a set of logout request input parameters, by copying them from another set.
	LogoutRequestParams(String sessionIndex, String nameId)	Create a set of logout request input parameters.
	LogoutRequestParams(String sessionIndex, String nameId, String nameIdFormat)	Create a set of logout request input parameters.
	LogoutRequestParams(String sessionIndex, String nameId, String nameIdFormat, String nameIdNameQualifier)	Create a set of logout request input parameters.
	LogoutRequestParams(String sessionIndex, String nameId, String nameIdFormat, String nameIdNameQualifier, String nameIdSPNameQualifier)	Create a set of logout request input parameters.

Method Summary

Modifier and Type	Method	Description
String	getNameId()
String	getNameIdFormat()
String	getNameIdNameQualifier()
String	getNameIdSPNameQualifier()
String	getSessionIndex()

Methods inherited from class java.lang.Object

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

Field Details

sessionIndex

private final String sessionIndex

SessionIndex. When the user is logged, this stored it from the AuthnStatement of the SAML Response

nameId

private final String nameId

NameID.

nameIdFormat

private final String nameIdFormat

NameID Format.

nameIdNameQualifier

private final String nameIdNameQualifier

nameId NameQualifier

nameIdSPNameQualifier

private final String nameIdSPNameQualifier

nameId SP NameQualifier

Constructor Details

LogoutRequestParams

public LogoutRequestParams()

Create an empty set of logout request input parameters.

LogoutRequestParams

public LogoutRequestParams(String sessionIndex,
 String nameId)

Create a set of logout request input parameters.

Parameters:

sessionIndex - the session index

nameId - the name id of the user to log out

LogoutRequestParams

public LogoutRequestParams(String sessionIndex,
 String nameId,
 String nameIdFormat)

Create a set of logout request input parameters.

Parameters:

sessionIndex - the session index

nameId - the name id of the user to log out

nameIdFormat - the name id format

LogoutRequestParams

public LogoutRequestParams(String sessionIndex,
 String nameId,
 String nameIdFormat,
 String nameIdNameQualifier)

Create a set of logout request input parameters.

Parameters:

sessionIndex - the session index

nameId - the name id of the user to log out

nameIdFormat - the name id format

nameIdNameQualifier - the name id qualifier

LogoutRequestParams

public LogoutRequestParams(String sessionIndex,
 String nameId,
 String nameIdFormat,
 String nameIdNameQualifier,
 String nameIdSPNameQualifier)

Create a set of logout request input parameters.

Parameters:

sessionIndex - the session index

nameId - the name id of the user to log out

nameIdFormat - the name id format

nameIdNameQualifier - the name id qualifier

nameIdSPNameQualifier - the name id SP qualifier

LogoutRequestParams

protected LogoutRequestParams(LogoutRequestParams 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 Details

getNameId

public String getNameId()

Returns:

the name ID

getNameIdFormat

public String getNameIdFormat()

Returns:

the name ID format

getNameIdNameQualifier

public String getNameIdNameQualifier()

Returns:

the name ID name qualifier

getNameIdSPNameQualifier

public String getNameIdSPNameQualifier()

Returns:

the name ID SP name qualifier

getSessionIndex

public String getSessionIndex()

Returns:

the session index