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

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

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.

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