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 the LogoutRequest object.
LogoutRequest(Saml2Settings settings, HttpRequest request) Constructs the LogoutRequest object.
LogoutRequest(Saml2Settings settings, HttpRequest request, String nameId, String sessionIndex) Constructs the LogoutRequest object.
LogoutRequest(Saml2Settings settings, HttpRequest request, String nameId, String sessionIndex, String nameIdFormat) Constructs the LogoutRequest object.
LogoutRequest(Saml2Settings settings, HttpRequest request, String nameId, String sessionIndex, String nameIdFormat, String nameIdNameQualifier) Constructs the LogoutRequest object.
LogoutRequest(Saml2Settings settings, HttpRequest request, String nameId, String sessionIndex, String nameIdFormat, String nameIdNameQualifier, String nameIdSPNameQualifier) Constructs the LogoutRequest object.

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.
static String	getIssuer(Document samlLogoutRequestDocument) Gets the Issuer from Logout Request Document.
static String	getIssuer(String samlLogoutRequestString) 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(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 Map<String,String>	getNameIdData(Document samlLogoutRequestDocument, PrivateKey key) 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 List<String>	getSessionIndexes(Document samlLogoutRequestDocument) Gets the SessionIndexes from the LogoutRequest.
static List<String>	getSessionIndexes(String samlLogoutRequestString) Gets the SessionIndexes from the LogoutRequest.
Boolean	isValid() Determines if the SAML LogoutRequest is valid or not

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

public LogoutRequest(Saml2Settings settings,
                     HttpRequest request,
                     String nameId,
                     String sessionIndex,
                     String nameIdFormat,
                     String nameIdNameQualifier,
                     String nameIdSPNameQualifier)
              throws XMLEntityException

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.

Throws:

XMLEntityException

LogoutRequest

public LogoutRequest(Saml2Settings settings,
                     HttpRequest request,
                     String nameId,
                     String sessionIndex,
                     String nameIdFormat,
                     String nameIdNameQualifier)
              throws XMLEntityException

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.

Throws:

XMLEntityException

LogoutRequest

public LogoutRequest(Saml2Settings settings,
                     HttpRequest request,
                     String nameId,
                     String sessionIndex,
                     String nameIdFormat)
              throws XMLEntityException

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.

Throws:

XMLEntityException

LogoutRequest

public LogoutRequest(Saml2Settings settings,
                     HttpRequest request,
                     String nameId,
                     String sessionIndex)
              throws XMLEntityException

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).

Throws:

XMLEntityException

LogoutRequest

public LogoutRequest(Saml2Settings settings)
              throws XMLEntityException

Constructs the LogoutRequest object.

Parameters:

settings - OneLogin_Saml2_Settings

Throws:

XMLEntityException

LogoutRequest

public LogoutRequest(Saml2Settings settings,
                     HttpRequest request)
              throws XMLEntityException

Constructs the LogoutRequest object.

Parameters:

settings - OneLogin_Saml2_Settings

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

Throws:

XMLEntityException

Method Detail

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()
                throws Exception

Determines if the SAML LogoutRequest is valid or not

Returns:

true if the SAML LogoutRequest is valid

Throws:

Exception

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.

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.

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(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

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)
                        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)
                        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(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

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(String samlLogoutRequestString)
                                      throws XPathExpressionException

Gets the SessionIndexes from the LogoutRequest.

Parameters:

samlLogoutRequestString - A Logout Request string.

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

getId

public String getId()

Returns:

the ID of the Logout Request