com.onelogin.saml2.logout

Class LogoutResponse

java.lang.Object

com.onelogin.saml2.logout.LogoutResponse

public class LogoutResponse
extends Object

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

Constructor Summary

Constructors

Constructor and Description
LogoutResponse(Saml2Settings settings, HttpRequest request) Constructs the LogoutResponse object.

Method Summary

Modifier and Type	Method and Description
void	build() Generates a Logout Response XML string.
void	build(String inResponseTo) Generates a Logout Response XML string.
void	build(String inResponseTo, SamlResponseStatus responseStatus) Generates a Logout Response XML string.
void	build(String inResponseTo, String statusCode) Generates a Logout Response XML string.
String	getEncodedLogoutResponse()
String	getEncodedLogoutResponse(Boolean deflated)
String	getError() After execute a validation process, if fails this method returns the cause
String	getId()
Calendar	getIssueInstant() Returns the issue instant of this message.
String	getIssuer() Gets the Issuer from Logout Response.
String	getLogoutResponseXml()
SamlResponseStatus	getSamlResponseStatus() Gets the Status of the Logout Response.
String	getStatus() Gets the Status of the Logout Response.
Exception	getValidationException() After execute a validation process, if fails this method returns the Exception object
Boolean	isValid()
Boolean	isValid(String requestId) Determines if the SAML LogoutResponse is valid
protected String	postProcessXml(String logoutResponseXml, Saml2Settings settings) Allows for an extension class to post-process the LogoutResponse XML generated for this response, in order to customize the result.
protected NodeList	query(String query) Extracts nodes that match the query from the DOMDocument (Logout Response Menssage)
protected void	setValidationException(Exception validationException) Sets the validation exception that this LogoutResponse 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

Constructor Detail

LogoutResponse

public LogoutResponse(Saml2Settings settings,
                      HttpRequest request)

Constructs the LogoutResponse object.

Parameters:

settings - OneLogin_Saml2_Settings

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

Method Detail

getEncodedLogoutResponse

public String getEncodedLogoutResponse(Boolean deflated)
                                throws IOException

Parameters:

deflated - If deflated or not the encoded Logout Response

Returns:

the base64 encoded unsigned Logout Response (deflated or not)

Throws:

IOException

getEncodedLogoutResponse

public String getEncodedLogoutResponse()
                                throws IOException

Returns:

the base64 encoded, unsigned Logout Response (deflated or not)

Throws:

IOException

getLogoutResponseXml

public String getLogoutResponseXml()

Returns:

the plain XML Logout Response

getId

public String getId()

Returns:

the ID of the Response

isValid

public Boolean isValid(String requestId)

Determines if the SAML LogoutResponse is valid

Parameters:

requestId - The ID of the LogoutRequest sent by this SP to the IdP

Returns:

if the SAML LogoutResponse is or not valid

isValid

public Boolean isValid()

getIssuer

public String getIssuer()
                 throws XPathExpressionException

Gets the Issuer from Logout Response.

Returns:

the issuer of the logout response

Throws:

XPathExpressionException

getStatus

public String getStatus()
                 throws XPathExpressionException

Gets the Status of the Logout Response.

Returns:

the Status

Throws:

XPathExpressionException

getSamlResponseStatus

public SamlResponseStatus getSamlResponseStatus()
                                         throws ValidationError

Gets the Status of the Logout Response.

Returns:

SamlResponseStatus

Throws:

ValidationError

query

protected NodeList query(String query)
                  throws XPathExpressionException

Extracts nodes that match the query from the DOMDocument (Logout Response Menssage)

Parameters:

query - Xpath Expression

Returns:

DOMNodeList The queried nodes

Throws:

XPathExpressionException

build

public void build(String inResponseTo,
                  SamlResponseStatus responseStatus)

Generates a Logout Response XML string.

Parameters:

inResponseTo - InResponseTo attribute value to bet set at the Logout Response.

responseStatus - SamlResponseStatus response status to be set on the LogoutResponse

build

public void build(String inResponseTo,
                  String statusCode)

Generates a Logout Response XML string.

Parameters:

inResponseTo - InResponseTo attribute value to bet set at the Logout Response.

statusCode - String StatusCode to be set on the LogoutResponse

build

public void build(String inResponseTo)

Generates a Logout Response XML string.

Parameters:

inResponseTo - InResponseTo attribute value to bet set at the Logout Response.

build

public void build()

Generates a Logout Response XML string.

postProcessXml

protected String postProcessXml(String logoutResponseXml,
                                Saml2Settings settings)

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

This method is invoked by build(String, String) (and all of its overloadings) and hence only in the logout response sending scenario. Its default implementation simply returns the input XML as-is, with no change.

Parameters:

logoutResponseXml - the XML produced for this LogoutResponse by the standard implementation provided by LogoutResponse

settings - the settings

Returns:

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

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 LogoutResponse should return when a validation error occurs.

Parameters:

validationException - the validation exception to set

getIssueInstant

public Calendar getIssueInstant()
                         throws ValidationError

Returns the issue instant of this message.

Returns:

a new Calendar instance carrying the issue instant of this message

Throws:

ValidationError - if this logout response was received and parsed and the found IssueInstant attribute is not in the expected UTC form of ISO-8601 format