PicketLink Federation Core 2.1.6.Final-redhat-2

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

All Known Implementing Classes:
DefaultSAML2HandlerRequest

public interface SAML2HandlerRequest

Request for SAML2Handler

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

Nested Class Summary
static class SAML2HandlerRequest.GENERATE_REQUEST_TYPE
           
 
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
 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 relayState)
          Set the relay state that was part of the interaction
 void setTypeOfRequestToBeGenerated(SAML2HandlerRequest.GENERATE_REQUEST_TYPE grt)
          set the type of SAML request that needs to be generated at the handler
 

Method Detail

getContext

ProtocolContext getContext()
Holder of transport context such as HTTP

Returns:

getSAML2Object

SAML2Object getSAML2Object()
The SAML2 Request

Returns:

getRequestDocument

Document getRequestDocument()
Get the request as a DOM

Returns:

getTypeOfRequestToBeGenerated

SAML2HandlerRequest.GENERATE_REQUEST_TYPE getTypeOfRequestToBeGenerated()
Return the type of SAML request that needs to be generated at the handler

Returns:

setTypeOfRequestToBeGenerated

void setTypeOfRequestToBeGenerated(SAML2HandlerRequest.GENERATE_REQUEST_TYPE grt)
set the type of SAML request that needs to be generated at the handler


getIssuer

NameIDType getIssuer()
Get the Issuer (SP or IDP) where the handler chain is currently processing

Returns:

setRelayState

void setRelayState(String relayState)
Set the relay state that was part of the interaction

Parameters:
relayState -

getRelayState

String getRelayState()
Get the RelayState that was part of the interaction

Returns:

addOption

void addOption(String key,
               Object option)
Add an option

Parameters:
key -
option -

setOptions

void setOptions(Map<String,Object> options)
Configure options

Parameters:
options -

getOptions

Map<String,Object> getOptions()
Get the configured options

Returns:

PicketLink Federation Core 2.1.6.Final-redhat-2

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