org.picketlink.identity.federation.core.saml.v2.impl

Class DefaultSAML2HandlerResponse

java.lang.Object

org.picketlink.identity.federation.core.saml.v2.impl.DefaultSAML2HandlerResponse

All Implemented Interfaces:

SAML2HandlerResponse

public class DefaultSAML2HandlerResponse
extends Object
implements SAML2HandlerResponse

Default implementation of the SAML2 Handler response

Since:

Oct 1, 2009

Author:

Anil.Saldhana@redhat.com

Constructor Summary

Constructors

Constructor and Description
DefaultSAML2HandlerResponse()

Method Summary

Modifier and Type	Method and Description
String	getDestination() Get the destination
String	getDestinationQueryStringWithSignature()
int	getErrorCode() Get the error code set in the handler chain
String	getErrorMessage() Get the error message set in the handler chain
String	getRelayState() Get the relay state
Document	getResultingDocument() Get the resulting document from the handler invocation
List<String>	getRoles() Get the roles generated by handlers
boolean	getSendRequest()
boolean	isInError() Specifies whether the handler chain processing resulted in an error
boolean	isPostBindingForResponse() Should the response be in post binding?
void	setDestination(String destination) Set the destination where the response from the current processing node is sent
void	setDestinationQueryStringWithSignature(String destinationQueryStringWithSignature) Whole destination query string including signature.
void	setError(int errorCode, String errorMessage) Handler can set an error
void	setPostBindingForResponse(boolean postB) Set whether the response should be using the Post Binding
void	setRelayState(String relayState) Set any relay state that needs to be used in the workflow
void	setResultingDocument(Document doc) Set the resulting document from the handler
void	setRoles(List<String> roles) Set an roles that are generated by handlers
void	setSendRequest(boolean request) Will the resulting document be a SAMLRequest?

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSAML2HandlerResponse

public DefaultSAML2HandlerResponse()

Method Detail

getRelayState

public String getRelayState()

Description copied from interface: SAML2HandlerResponse

Get the relay state

Specified by:

getRelayState in interface SAML2HandlerResponse

Returns:

See Also:

SAML2HandlerResponse.getRelayState()

getResultingDocument

public Document getResultingDocument()

Description copied from interface: SAML2HandlerResponse

Get the resulting document from the handler invocation

Specified by:

getResultingDocument in interface SAML2HandlerResponse

Returns:

See Also:

SAML2HandlerResponse.getResultingDocument()

setRelayState

public void setRelayState(String relayState)

Description copied from interface: SAML2HandlerResponse

Set any relay state that needs to be used in the workflow

Specified by:

setRelayState in interface SAML2HandlerResponse

See Also:

SAML2HandlerResponse.setRelayState(String)

setResultingDocument

public void setResultingDocument(Document doc)

Description copied from interface: SAML2HandlerResponse

Set the resulting document from the handler

Specified by:

setResultingDocument in interface SAML2HandlerResponse

See Also:

SAML2HandlerResponse.setResultingDocument(Document)

getRoles

public List<String> getRoles()

Description copied from interface: SAML2HandlerResponse

Get the roles generated by handlers

Specified by:

getRoles in interface SAML2HandlerResponse

Returns:

See Also:

SAML2HandlerResponse.getRoles()

setRoles

public void setRoles(List<String> roles)

Description copied from interface: SAML2HandlerResponse

Set an roles that are generated by handlers

Specified by:

setRoles in interface SAML2HandlerResponse

See Also:

SAML2HandlerResponse.setRoles(List)

getDestination

public String getDestination()

Description copied from interface: SAML2HandlerResponse

Get the destination

Specified by:

getDestination in interface SAML2HandlerResponse

Returns:

See Also:

SAML2HandlerResponse.getDestination()

setDestination

public void setDestination(String destination)

Description copied from interface: SAML2HandlerResponse

Set the destination where the response from the current processing node is sent

Specified by:

setDestination in interface SAML2HandlerResponse

See Also:

SAML2HandlerResponse.setDestination(String)

getErrorCode

public int getErrorCode()

Description copied from interface: SAML2HandlerResponse

Get the error code set in the handler chain

Specified by:

getErrorCode in interface SAML2HandlerResponse

Returns:

See Also:

SAML2HandlerResponse.getErrorCode()

getErrorMessage

public String getErrorMessage()

Description copied from interface: SAML2HandlerResponse

Get the error message set in the handler chain

Specified by:

getErrorMessage in interface SAML2HandlerResponse

Returns:

See Also:

SAML2HandlerResponse.getErrorMessage()

setError

public void setError(int errorCode,
                     String errorMessage)

Description copied from interface: SAML2HandlerResponse

Handler can set an error

Specified by:

setError in interface SAML2HandlerResponse

See Also:

SAML2HandlerResponse.setError(int, String)

isInError

public boolean isInError()

Description copied from interface: SAML2HandlerResponse

Specifies whether the handler chain processing resulted in an error

Specified by:

isInError in interface SAML2HandlerResponse

Returns:

See Also:

SAML2HandlerResponse.isInError()

getSendRequest

public boolean getSendRequest()

Specified by:

getSendRequest in interface SAML2HandlerResponse

Returns:

See Also:

SAML2HandlerResponse.getSendRequest()

setSendRequest

public void setSendRequest(boolean request)

Description copied from interface: SAML2HandlerResponse

Will the resulting document be a SAMLRequest?

Specified by:

setSendRequest in interface SAML2HandlerResponse

See Also:

SAML2HandlerResponse.setSendRequest(boolean)

setPostBindingForResponse

public void setPostBindingForResponse(boolean postB)

Description copied from interface: SAML2HandlerResponse

Set whether the response should be using the Post Binding

Specified by:

setPostBindingForResponse in interface SAML2HandlerResponse

See Also:

SAML2HandlerResponse.setPostBindingForResponse(boolean)

isPostBindingForResponse

public boolean isPostBindingForResponse()

Description copied from interface: SAML2HandlerResponse

Should the response be in post binding?

Specified by:

isPostBindingForResponse in interface SAML2HandlerResponse

Returns:

See Also:

SAML2HandlerResponse.isPostBindingForResponse()

setDestinationQueryStringWithSignature

public void setDestinationQueryStringWithSignature(String destinationQueryStringWithSignature)

Description copied from interface: SAML2HandlerResponse

Whole destination query string including signature. It's used only in Redirect Binding with signature enabled.

Specified by:

setDestinationQueryStringWithSignature in interface SAML2HandlerResponse

See Also:

SAML2HandlerResponse.setDestinationQueryStringWithSignature(String)

getDestinationQueryStringWithSignature

public String getDestinationQueryStringWithSignature()

Specified by:

getDestinationQueryStringWithSignature in interface SAML2HandlerResponse

Returns:

See Also:

SAML2HandlerResponse.getDestinationQueryStringWithSignature()