PicketLink Federation Core 2.1.6.Final-redhat-2

org.picketlink.identity.federation.core.saml.v2.interfaces
Interface SAML2HandlerResponse

All Known Implementing Classes:
DefaultSAML2HandlerResponse

public interface SAML2HandlerResponse

A response object sent to the SAML2Handler as part of a chain

Since:
Sep 25, 2009
Author:
Anil.Saldhana@redhat.com

Method Summary
 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?
 

Method Detail

setDestination

void setDestination(String destination)
Set the destination where the response from the current processing node is sent

Parameters:
destination -

getDestination

String getDestination()
Get the destination

Returns:

setResultingDocument

void setResultingDocument(Document doc)
Set the resulting document from the handler

Parameters:
doc -

setRelayState

void setRelayState(String relayState)
Set any relay state that needs to be used in the workflow

Parameters:
relayState -

getResultingDocument

Document getResultingDocument()
Get the resulting document from the handler invocation

Returns:

getRelayState

String getRelayState()
Get the relay state

Returns:

setRoles

void setRoles(List<String> roles)
Set an roles that are generated by handlers

Parameters:
roles -

getRoles

List<String> getRoles()
Get the roles generated by handlers

Returns:

isInError

boolean isInError()
Specifies whether the handler chain processing resulted in an error

Returns:

setError

void setError(int errorCode,
              String errorMessage)
Handler can set an error

Parameters:
errorCode -
errorMessage -

getErrorCode

int getErrorCode()
Get the error code set in the handler chain

Returns:

getErrorMessage

String getErrorMessage()
Get the error message set in the handler chain

Returns:

setSendRequest

void setSendRequest(boolean request)
Will the resulting document be a SAMLRequest?

Parameters:
request -

getSendRequest

boolean getSendRequest()
Returns:
See Also:
setSendRequest(boolean)

setPostBindingForResponse

void setPostBindingForResponse(boolean postB)
Set whether the response should be using the Post Binding

Parameters:
postB -

isPostBindingForResponse

boolean isPostBindingForResponse()
Should the response be in post binding?

Returns:

setDestinationQueryStringWithSignature

void setDestinationQueryStringWithSignature(String destinationQueryStringWithSignature)
Whole destination query string including signature. It's used only in Redirect Binding with signature enabled.

Parameters:
destinationQueryStringWithSignature -

getDestinationQueryStringWithSignature

String getDestinationQueryStringWithSignature()
Returns:
See Also:
setDestinationQueryStringWithSignature(String)

PicketLink Federation Core 2.1.6.Final-redhat-2

Copyright © 2013 JBoss by Red Hat. All Rights Reserved.