com.onelogin.saml2.logout

Class LogoutRequest

java.lang.Object

com.onelogin.saml2.logout.LogoutRequest

public class LogoutRequest
extends Object

LogoutRequest class of OneLogin's Java Toolkit. A class that implements SAML 2 Logout Request builder/parser/validator

Field Summary

Fields

Modifier and Type	Field and Description
String	id SAML LogoutRequest ID.

Constructor Summary

Constructors

Constructor and Description
LogoutRequest(Saml2Settings settings) Constructs a LogoutRequest object when a new request should be generated and sent.
LogoutRequest(Saml2Settings settings, HttpRequest request) Constructs the LogoutRequest object when a received request should be extracted from the HTTP request and parsed.
LogoutRequest(Saml2Settings settings, HttpRequest request, String nameId, String sessionIndex) Deprecated. use LogoutRequest(Saml2Settings, HttpRequest) to build a received request from the HTTP request, or LogoutRequest(Saml2Settings, LogoutRequestParams) with LogoutRequestParams.LogoutRequestParams(String, String) to build a new request to be sent
LogoutRequest(Saml2Settings settings, HttpRequest request, String nameId, String sessionIndex, String nameIdFormat) Deprecated. use LogoutRequest(Saml2Settings, HttpRequest) to build a received request from the HTTP request, or LogoutRequest(Saml2Settings, LogoutRequestParams) with LogoutRequestParams.LogoutRequestParams(String, String, String) to build a new request to be sent
LogoutRequest(Saml2Settings settings, HttpRequest request, String nameId, String sessionIndex, String nameIdFormat, String nameIdNameQualifier) Deprecated. use LogoutRequest(Saml2Settings, HttpRequest) to build a received request from the HTTP request, or LogoutRequest(Saml2Settings, LogoutRequestParams) with LogoutRequestParams.LogoutRequestParams(String, String, String, String) to build a new request to be sent
LogoutRequest(Saml2Settings settings, HttpRequest request, String nameId, String sessionIndex, String nameIdFormat, String nameIdNameQualifier, String nameIdSPNameQualifier) Deprecated. use LogoutRequest(Saml2Settings, HttpRequest) to build a received request from the HTTP request, or LogoutRequest(Saml2Settings, LogoutRequestParams) with LogoutRequestParams.LogoutRequestParams(String, String, String, String, String) to build a new request to be sent
LogoutRequest(Saml2Settings settings, LogoutRequestParams params) Constructs the LogoutRequest object when a new request should be generated and sent.

Method Summary

Modifier and Type	Method and Description
String	getEncodedLogoutRequest()
String	getEncodedLogoutRequest(Boolean deflated)
String	getError() After execute a validation process, if fails this method returns the cause
String	getId()
static String	getId(Document samlLogoutRequestDocument) Returns the ID of the Logout Request Document.
static String	getId(String samlLogoutRequestString) Returns the ID of the Logout Request String.
Calendar	getIssueInstant() Returns the issue instant of this message.
static Calendar	getIssueInstant(Document samlLogoutRequestDocument) Returns the issue instant of the Logout Request Document.
static Calendar	getIssueInstant(String samlLogoutRequestString) Returns the issue instant of the Logout Request Document.
static String	getIssuer(Document samlLogoutRequestDocument) Gets the Issuer from Logout Request Document.
static String	getIssuer(Document samlLogoutRequestDocument, boolean trim) Gets the Issuer from Logout Request Document.
static String	getIssuer(String samlLogoutRequestString) Gets the Issuer from Logout Request String.
static String	getIssuer(String samlLogoutRequestString, boolean trim) Gets the Issuer from Logout Request String.
String	getLogoutRequestXml()
static String	getNameId(Document samlLogoutRequestDocument) Gets the NameID value provided from the SAML Logout Request Document.
static String	getNameId(Document samlLogoutRequestDocument, PrivateKey key) Gets the NameID value provided from the SAML Logout Request Document.
static String	getNameId(Document samlLogoutRequestDocument, PrivateKey key, boolean trimValue) Gets the NameID value provided from the SAML Logout Request Document.
static String	getNameId(String samlLogoutRequestString) Gets the NameID value provided from the SAML Logout Request String.
static String	getNameId(String samlLogoutRequestString, PrivateKey key) Gets the NameID value provided from the SAML Logout Request String.
static String	getNameId(String samlLogoutRequestString, PrivateKey key, boolean trimValue) Gets the NameID value provided from the SAML Logout Request String.
static Map<String,String>	getNameIdData(Document samlLogoutRequestDocument, PrivateKey key) Gets the NameID Data from the the Logout Request Document.
static Map<String,String>	getNameIdData(Document samlLogoutRequestDocument, PrivateKey key, boolean trimValue) Gets the NameID Data from the the Logout Request Document.
static Map<String,String>	getNameIdData(String samlLogoutRequestString, PrivateKey key) Gets the NameID Data from the the Logout Request String.
static Map<String,String>	getNameIdData(String samlLogoutRequestString, PrivateKey key, boolean trimValue) Gets the NameID Data from the the Logout Request String.
static List<String>	getSessionIndexes(Document samlLogoutRequestDocument) Gets the SessionIndexes from the LogoutRequest.
static List<String>	getSessionIndexes(Document samlLogoutRequestDocument, boolean trim) Gets the SessionIndexes from the LogoutRequest.
static List<String>	getSessionIndexes(String samlLogoutRequestString) Gets the SessionIndexes from the LogoutRequest.
static List<String>	getSessionIndexes(String samlLogoutRequestString, boolean trim) Gets the SessionIndexes from the LogoutRequest.
Exception	getValidationException() After execute a validation process, if fails this method returns the Exception object
Boolean	isValid() Determines if the SAML LogoutRequest is valid or not
protected String	postProcessXml(String logoutRequestXml, LogoutRequestParams params, Saml2Settings settings) Allows for an extension class to post-process the LogoutRequest XML generated for this request, in order to customize the result.
protected void	setValidationException(Exception validationException) Sets the validation exception that this LogoutRequest should return when a validation error occurs.

Methods inherited from class java.lang.Object

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

Field Detail

id

public String id

SAML LogoutRequest ID.

Constructor Detail

LogoutRequest

@Deprecated
public LogoutRequest(Saml2Settings settings,
                                 HttpRequest request,
                                 String nameId,
                                 String sessionIndex,
                                 String nameIdFormat,
                                 String nameIdNameQualifier,
                                 String nameIdSPNameQualifier)

Deprecated. use LogoutRequest(Saml2Settings, HttpRequest) to build a received request from the HTTP request, or LogoutRequest(Saml2Settings, LogoutRequestParams) with LogoutRequestParams.LogoutRequestParams(String, String, String, String, String) to build a new request to be sent

Constructs the LogoutRequest object.

Parameters:

settings - OneLogin_Saml2_Settings

request - the HttpRequest object to be processed (Contains GET and POST parameters, request URL, ...).

nameId - The NameID that will be set in the LogoutRequest.

sessionIndex - The SessionIndex (taken from the SAML Response in the SSO process).

nameIdFormat - The nameIdFormat that will be set in the LogoutRequest.

nameIdNameQualifier - The NameID NameQualifier that will be set in the LogoutRequest.

nameIdSPNameQualifier - The SP Name Qualifier that will be set in the LogoutRequest.

LogoutRequest

@Deprecated
public LogoutRequest(Saml2Settings settings,
                                 HttpRequest request,
                                 String nameId,
                                 String sessionIndex,
                                 String nameIdFormat,
                                 String nameIdNameQualifier)

Deprecated. use LogoutRequest(Saml2Settings, HttpRequest) to build a received request from the HTTP request, or LogoutRequest(Saml2Settings, LogoutRequestParams) with LogoutRequestParams.LogoutRequestParams(String, String, String, String) to build a new request to be sent

Constructs the LogoutRequest object.

Parameters:

settings - OneLogin_Saml2_Settings

request - the HttpRequest object to be processed (Contains GET and POST parameters, request URL, ...).

nameId - The NameID that will be set in the LogoutRequest.

sessionIndex - The SessionIndex (taken from the SAML Response in the SSO process).

nameIdFormat - The nameIdFormat that will be set in the LogoutRequest.

nameIdNameQualifier - The NameID NameQualifier will be set in the LogoutRequest.

LogoutRequest

@Deprecated
public LogoutRequest(Saml2Settings settings,
                                 HttpRequest request,
                                 String nameId,
                                 String sessionIndex,
                                 String nameIdFormat)

Deprecated. use LogoutRequest(Saml2Settings, HttpRequest) to build a received request from the HTTP request, or LogoutRequest(Saml2Settings, LogoutRequestParams) with LogoutRequestParams.LogoutRequestParams(String, String, String) to build a new request to be sent

Constructs the LogoutRequest object.

Parameters:

settings - OneLogin_Saml2_Settings

request - the HttpRequest object to be processed (Contains GET and POST parameters, request URL, ...).

nameId - The NameID that will be set in the LogoutRequest.

sessionIndex - The SessionIndex (taken from the SAML Response in the SSO process).

nameIdFormat - The nameIdFormat that will be set in the LogoutRequest.

LogoutRequest

@Deprecated
public LogoutRequest(Saml2Settings settings,
                                 HttpRequest request,
                                 String nameId,
                                 String sessionIndex)

Deprecated. use LogoutRequest(Saml2Settings, HttpRequest) to build a received request from the HTTP request, or LogoutRequest(Saml2Settings, LogoutRequestParams) with LogoutRequestParams.LogoutRequestParams(String, String) to build a new request to be sent

Constructs the LogoutRequest object.

Parameters:

settings - OneLogin_Saml2_Settings

request - the HttpRequest object to be processed (Contains GET and POST parameters, request URL, ...).

nameId - The NameID that will be set in the LogoutRequest.

sessionIndex - The SessionIndex (taken from the SAML Response in the SSO process).

LogoutRequest

public LogoutRequest(Saml2Settings settings)

Constructs a LogoutRequest object when a new request should be generated and sent.

Parameters:

settings - OneLogin_Saml2_Settings

See Also:

LogoutRequest(Saml2Settings, LogoutRequestParams)

LogoutRequest

public LogoutRequest(Saml2Settings settings,
                     HttpRequest request)

Constructs the LogoutRequest object when a received request should be extracted from the HTTP request and parsed.

Parameters:

settings - OneLogin_Saml2_Settings

request - the HttpRequest object to be processed (Contains GET and POST parameters, request URL, ...).

LogoutRequest

public LogoutRequest(Saml2Settings settings,
                     LogoutRequestParams params)

Constructs the LogoutRequest object when a new request should be generated and sent.

Parameters:

settings - OneLogin_Saml2_Settings

params - a set of authentication request input parameters that shape the request to create

Method Detail

postProcessXml

protected String postProcessXml(String logoutRequestXml,
                                LogoutRequestParams params,
                                Saml2Settings settings)

Allows for an extension class to post-process the LogoutRequest XML generated for this request, in order to customize the result.

This method is invoked at construction time when no existing LogoutRequest message is found in the HTTP request (and hence in the logout request sending scenario only), after all the other fields of this class have already been initialised. Its default implementation simply returns the input XML as-is, with no change.

Parameters:

logoutRequestXml - the XML produced for this LogoutRequest by the standard implementation provided by LogoutRequest

params - the logout request input parameters

settings - the settings

Returns:

the post-processed XML for this LogoutRequest, which will then be returned by any call to getLogoutRequestXml()

getEncodedLogoutRequest

public String getEncodedLogoutRequest(Boolean deflated)
                               throws IOException

Parameters:

deflated - If deflated or not the encoded Logout Request

Returns:

the base64 encoded unsigned Logout Request (deflated or not)

Throws:

IOException

getEncodedLogoutRequest

public String getEncodedLogoutRequest()
                               throws IOException

Returns:

the base64 encoded unsigned Logout Request (deflated or not)

Throws:

IOException

getLogoutRequestXml

public String getLogoutRequestXml()

Returns:

the plain XML Logout Request

isValid

public Boolean isValid()

Determines if the SAML LogoutRequest is valid or not

Returns:

true if the SAML LogoutRequest is valid

getId

public static String getId(Document samlLogoutRequestDocument)

Returns the ID of the Logout Request Document.

Parameters:

samlLogoutRequestDocument - A DOMDocument object loaded from the SAML Logout Request.

Returns:

the ID of the Logout Request.

getIssueInstant

public static Calendar getIssueInstant(Document samlLogoutRequestDocument)

Returns the issue instant of the Logout Request Document.

Parameters:

samlLogoutRequestDocument - A DOMDocument object loaded from the SAML Logout Request.

Returns:

the issue instant of the Logout Request.

getId

public static String getId(String samlLogoutRequestString)

Returns the ID of the Logout Request String.

Parameters:

samlLogoutRequestString - A Logout Request string.

Returns:

the ID of the Logout Request.

getIssueInstant

public static Calendar getIssueInstant(String samlLogoutRequestString)

Returns the issue instant of the Logout Request Document.

Parameters:

samlLogoutRequestDocument - A DOMDocument object loaded from the SAML Logout Request.

Returns:

the issue instant of the Logout Request.

getNameIdData

public static Map<String,String> getNameIdData(Document samlLogoutRequestDocument,
                                               PrivateKey key)
                                        throws Exception

Gets the NameID Data from the the Logout Request Document.

Parameters:

samlLogoutRequestDocument - A DOMDocument object loaded from the SAML Logout Request.

key - The SP key to decrypt the NameID if encrypted

Returns:

the Name ID Data (Value, Format, NameQualifier, SPNameQualifier)

Throws:

Exception

getNameIdData

public static Map<String,String> getNameIdData(Document samlLogoutRequestDocument,
                                               PrivateKey key,
                                               boolean trimValue)
                                        throws Exception

Gets the NameID Data from the the Logout Request Document.

Parameters:

samlLogoutRequestDocument - A DOMDocument object loaded from the SAML Logout Request.

key - The SP key to decrypt the NameID if encrypted

trimValue - whether the extracted Name ID value should be trimmed

Returns:

the Name ID Data (Value, Format, NameQualifier, SPNameQualifier)

Throws:

Exception

getNameIdData

public static Map<String,String> getNameIdData(String samlLogoutRequestString,
                                               PrivateKey key)
                                        throws Exception

Gets the NameID Data from the the Logout Request String.

Parameters:

samlLogoutRequestString - A DOMDocument object loaded from the SAML Logout Request.

key - The SP key to decrypt the NameID if encrypted

Returns:

the Name ID Data (Value, Format, NameQualifier, SPNameQualifier)

Throws:

Exception

getNameIdData

public static Map<String,String> getNameIdData(String samlLogoutRequestString,
                                               PrivateKey key,
                                               boolean trimValue)
                                        throws Exception

Gets the NameID Data from the the Logout Request String.

Parameters:

samlLogoutRequestString - A DOMDocument object loaded from the SAML Logout Request.

key - The SP key to decrypt the NameID if encrypted

trimValue - whether the extracted Name ID value should be trimmed

Returns:

the Name ID Data (Value, Format, NameQualifier, SPNameQualifier)

Throws:

Exception

getNameId

public static String getNameId(Document samlLogoutRequestDocument,
                               PrivateKey key)
                        throws Exception

Gets the NameID value provided from the SAML Logout Request Document.

Parameters:

samlLogoutRequestDocument - A DOMDocument object loaded from the SAML Logout Request.

key - The SP key to decrypt the NameID if encrypted

Returns:

the Name ID value

Throws:

Exception

getNameId

public static String getNameId(Document samlLogoutRequestDocument,
                               PrivateKey key,
                               boolean trimValue)
                        throws Exception

Gets the NameID value provided from the SAML Logout Request Document.

Parameters:

samlLogoutRequestDocument - A DOMDocument object loaded from the SAML Logout Request.

key - The SP key to decrypt the NameID if encrypted

trimValue - whether the extracted Name ID value should be trimmed

Returns:

the Name ID value

Throws:

Exception

getNameId

public static String getNameId(Document samlLogoutRequestDocument)
                        throws Exception

Gets the NameID value provided from the SAML Logout Request Document.

Parameters:

samlLogoutRequestDocument - A DOMDocument object loaded from the SAML Logout Request.

Returns:

the Name ID value

Throws:

Exception

getNameId

public static String getNameId(String samlLogoutRequestString,
                               PrivateKey key)
                        throws Exception

Gets the NameID value provided from the SAML Logout Request String.

Parameters:

samlLogoutRequestString - A Logout Request string.

key - The SP key to decrypt the NameID if encrypted

Returns:

the Name ID value

Throws:

Exception

getNameId

public static String getNameId(String samlLogoutRequestString,
                               PrivateKey key,
                               boolean trimValue)
                        throws Exception

Gets the NameID value provided from the SAML Logout Request String.

Parameters:

samlLogoutRequestString - A Logout Request string.

key - The SP key to decrypt the NameID if encrypted

trimValue - whether the extracted Name ID value should be trimmed

Returns:

the Name ID value

Throws:

Exception

getNameId

public static String getNameId(String samlLogoutRequestString)
                        throws Exception

Gets the NameID value provided from the SAML Logout Request String.

Parameters:

samlLogoutRequestString - A Logout Request string.

Returns:

the Name ID value

Throws:

Exception

getIssuer

public static String getIssuer(Document samlLogoutRequestDocument)
                        throws XPathExpressionException

Gets the Issuer from Logout Request Document.

Parameters:

samlLogoutRequestDocument - A DOMDocument object loaded from the SAML Logout Request.

Returns:

the issuer of the logout request

Throws:

XPathExpressionException

getIssuer

public static String getIssuer(Document samlLogoutRequestDocument,
                               boolean trim)
                        throws XPathExpressionException

Gets the Issuer from Logout Request Document.

Parameters:

samlLogoutRequestDocument - A DOMDocument object loaded from the SAML Logout Request.

trim - whether the extracted issuer value should be trimmed

Returns:

the issuer of the logout request

Throws:

XPathExpressionException

getIssuer

public static String getIssuer(String samlLogoutRequestString)
                        throws XPathExpressionException

Gets the Issuer from Logout Request String.

Parameters:

samlLogoutRequestString - A Logout Request string.

Returns:

the issuer of the logout request

Throws:

XPathExpressionException

getIssuer

public static String getIssuer(String samlLogoutRequestString,
                               boolean trim)
                        throws XPathExpressionException

Gets the Issuer from Logout Request String.

Parameters:

samlLogoutRequestString - A Logout Request string.

trim - whether the extracted issuer value should be trimmed

Returns:

the issuer of the logout request

Throws:

XPathExpressionException

getSessionIndexes

public static List<String> getSessionIndexes(Document samlLogoutRequestDocument)
                                      throws XPathExpressionException

Gets the SessionIndexes from the LogoutRequest.

Parameters:

samlLogoutRequestDocument - A DOMDocument object loaded from the SAML Logout Request.

Returns:

the SessionIndexes

Throws:

XPathExpressionException

getSessionIndexes

public static List<String> getSessionIndexes(Document samlLogoutRequestDocument,
                                             boolean trim)
                                      throws XPathExpressionException

Gets the SessionIndexes from the LogoutRequest.

Parameters:

samlLogoutRequestDocument - A DOMDocument object loaded from the SAML Logout Request.

trim - whether the extracted session indexes should be trimmed

Returns:

the SessionIndexes

Throws:

XPathExpressionException

getSessionIndexes

public static List<String> getSessionIndexes(String samlLogoutRequestString)
                                      throws XPathExpressionException

Gets the SessionIndexes from the LogoutRequest.

Parameters:

samlLogoutRequestString - A Logout Request string.

Returns:

the SessionIndexes

Throws:

XPathExpressionException

getSessionIndexes

public static List<String> getSessionIndexes(String samlLogoutRequestString,
                                             boolean trim)
                                      throws XPathExpressionException

Gets the SessionIndexes from the LogoutRequest.

Parameters:

samlLogoutRequestString - A Logout Request string.

trim - whether the extracted session indexes should be trimmed

Returns:

the SessionIndexes

Throws:

XPathExpressionException

getError

public String getError()

After execute a validation process, if fails this method returns the cause

Returns:

the cause of the validation error

getValidationException

public Exception getValidationException()

After execute a validation process, if fails this method returns the Exception object

Returns:

the cause of the validation error

setValidationException

protected void setValidationException(Exception validationException)

Sets the validation exception that this LogoutRequest should return when a validation error occurs.

Parameters:

validationException - the validation exception to set

getId

public String getId()

Returns:

the ID of the Logout Request

getIssueInstant

public Calendar getIssueInstant()

Returns the issue instant of this message.

Returns:

a new Calendar instance carrying the issue instant of this message