PicketLink Federation Core 2.1.6.Final-redhat-2

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

java.lang.Object
  extended by org.picketlink.identity.federation.core.saml.v2.impl.DefaultSAML2HandlerRequest
All Implemented Interfaces:
SAML2HandlerRequest

public class DefaultSAML2HandlerRequest
extends Object
implements SAML2HandlerRequest

Default SAML2HandlerRequest

Since:
Oct 1, 2009
Author:
Anil.Saldhana@redhat.com

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.picketlink.identity.federation.core.saml.v2.interfaces.SAML2HandlerRequest
SAML2HandlerRequest.GENERATE_REQUEST_TYPE
 
Constructor Summary
DefaultSAML2HandlerRequest(ProtocolContext protocolContext, NameIDType issuer, SAMLDocumentHolder samlDocumentHolder, SAML2Handler.HANDLER_TYPE handlerType)
           
 
Method Summary
 void addOption(String key, Object option)
          Add an option
 ProtocolContext getContext()
          Holder of transport context such as HTTP
 NameIDType getIssuer()
          Get the Issuer (SP or IDP) where the handler chain is currently processing
 Map<String,Object> getOptions()
          Get the configured options
 String getRelayState()
          Get the RelayState that was part of the interaction
 Document getRequestDocument()
          Get the request as a DOM
 SAML2Object getSAML2Object()
          The SAML2 Request
 SAML2Handler.HANDLER_TYPE getType()
           
 SAML2HandlerRequest.GENERATE_REQUEST_TYPE getTypeOfRequestToBeGenerated()
          Return the type of SAML request that needs to be generated at the handler
 void setOptions(Map<String,Object> options)
          Configure options
 void setRelayState(String relay)
          Set the relay state that was part of the interaction
 void setTypeOfRequestToBeGenerated(SAML2HandlerRequest.GENERATE_REQUEST_TYPE grt)
          Set the type of saml2 request that need to be generated by the handler
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultSAML2HandlerRequest

public DefaultSAML2HandlerRequest(ProtocolContext protocolContext,
                                  NameIDType issuer,
                                  SAMLDocumentHolder samlDocumentHolder,
                                  SAML2Handler.HANDLER_TYPE handlerType)
Method Detail

setOptions

public void setOptions(Map<String,Object> options)
Description copied from interface: SAML2HandlerRequest
Configure options

Specified by:
setOptions in interface SAML2HandlerRequest

getContext

public ProtocolContext getContext()
Description copied from interface: SAML2HandlerRequest
Holder of transport context such as HTTP

Specified by:
getContext in interface SAML2HandlerRequest
Returns:
See Also:
SAML2HandlerRequest.getContext()

getIssuer

public NameIDType getIssuer()
Description copied from interface: SAML2HandlerRequest
Get the Issuer (SP or IDP) where the handler chain is currently processing

Specified by:
getIssuer in interface SAML2HandlerRequest
Returns:
See Also:
SAML2HandlerRequest.getIssuer()

getSAML2Object

public SAML2Object getSAML2Object()
Description copied from interface: SAML2HandlerRequest
The SAML2 Request

Specified by:
getSAML2Object in interface SAML2HandlerRequest
Returns:
See Also:
SAML2HandlerRequest.getSAML2Object()

getType

public SAML2Handler.HANDLER_TYPE getType()
See Also:
SAML2HandlerRequest#getType()

addOption

public void addOption(String key,
                      Object option)
Description copied from interface: SAML2HandlerRequest
Add an option

Specified by:
addOption in interface SAML2HandlerRequest
See Also:
SAML2HandlerRequest#addOption(String, Object)}

getOptions

public Map<String,Object> getOptions()
Description copied from interface: SAML2HandlerRequest
Get the configured options

Specified by:
getOptions in interface SAML2HandlerRequest
Returns:
See Also:
SAML2HandlerRequest.getOptions()

setTypeOfRequestToBeGenerated

public void setTypeOfRequestToBeGenerated(SAML2HandlerRequest.GENERATE_REQUEST_TYPE grt)
Set the type of saml2 request that need to be generated by the handler

Specified by:
setTypeOfRequestToBeGenerated in interface SAML2HandlerRequest
Parameters:
grt -

getTypeOfRequestToBeGenerated

public SAML2HandlerRequest.GENERATE_REQUEST_TYPE getTypeOfRequestToBeGenerated()
Description copied from interface: SAML2HandlerRequest
Return the type of SAML request that needs to be generated at the handler

Specified by:
getTypeOfRequestToBeGenerated in interface SAML2HandlerRequest
Returns:
See Also:
SAML2HandlerRequest.getTypeOfRequestToBeGenerated()

getRelayState

public String getRelayState()
Description copied from interface: SAML2HandlerRequest
Get the RelayState that was part of the interaction

Specified by:
getRelayState in interface SAML2HandlerRequest
Returns:
See Also:
SAML2HandlerRequest.getRelayState()

setRelayState

public void setRelayState(String relay)
Description copied from interface: SAML2HandlerRequest
Set the relay state that was part of the interaction

Specified by:
setRelayState in interface SAML2HandlerRequest

getRequestDocument

public Document getRequestDocument()
Description copied from interface: SAML2HandlerRequest
Get the request as a DOM

Specified by:
getRequestDocument in interface SAML2HandlerRequest
Returns:

PicketLink Federation Core 2.1.6.Final-redhat-2

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