org.opensaml
Interface SAMLBrowserProfile

All Known Implementing Classes:
BrowserProfileProvider

public interface SAMLBrowserProfile

Interface to the SAML 1.x browser profiles. The SAML 1.x profiles are destination/SP-side only, thus only "acceptance" of the profile message is modeled.

Author:
Scott Cantor

Nested Class Summary
static interface SAMLBrowserProfile.ArtifactMapper
          Interface provided by SAML application to enable SAML 1.x artifacts to be resolved.
static class SAMLBrowserProfile.BrowserProfileRequest
          Wrapper for the pieces of the profile request provided to the profile provider
static class SAMLBrowserProfile.BrowserProfileResponse
          Wrapper for the pieces of the profile response available to the caller
 
Field Summary
static String PROFILE_ARTIFACT_URI
           
static String PROFILE_POST_URI
           
 
Method Summary
 SAMLBrowserProfile.BrowserProfileRequest receive(javax.servlet.http.HttpServletRequest requestContext)
          Processes an HTTP request into a browser profile request.
 SAMLBrowserProfile.BrowserProfileResponse receive(StringBuffer issuer, SAMLBrowserProfile.BrowserProfileRequest requestContext, String recipient, ReplayCache replayCache, SAMLBrowserProfile.ArtifactMapper artifactMapper, int minor)
          Processes an incoming POST or Artifact profile response.
 

Field Detail

PROFILE_ARTIFACT_URI

static final String PROFILE_ARTIFACT_URI
See Also:
Constant Field Values

PROFILE_POST_URI

static final String PROFILE_POST_URI
See Also:
Constant Field Values
Method Detail

receive

SAMLBrowserProfile.BrowserProfileRequest receive(javax.servlet.http.HttpServletRequest requestContext)
                                                 throws UnsupportedProfileException
Processes an HTTP request into a browser profile request.

Parameters:
requestContext - The HTTP request from the client
Returns:
The profile request information extracted from the HTTP request
Throws:
UnsupportedProfileException - Raised if the HTTP request data cannot be successfully parsed

receive

SAMLBrowserProfile.BrowserProfileResponse receive(StringBuffer issuer,
                                                  SAMLBrowserProfile.BrowserProfileRequest requestContext,
                                                  String recipient,
                                                  ReplayCache replayCache,
                                                  SAMLBrowserProfile.ArtifactMapper artifactMapper,
                                                  int minor)
                                                  throws SAMLException
Processes an incoming POST or Artifact profile response. Use the supportedProfiles parameter to specify support for one or both profiles. Upon completion, the response parameter will contain the SAML objects delivered by the profile. Signature verification is not performed by the default implementation but may be handled by alternate or subclassed versions.

Parameters:
issuer - A buffer in which to store the issuer of the security token being processed, to assist in responding to errors
requestContext - The HTTP request containing the profile response
recipient - The HTTP endpoint to which the response was delivered
replayCache - An org.opensaml.ReplayCache interface to enable replay detection
artifactMapper - An ArtifactMapper interface to support artifact lookup/mapping (may be null if only POST is supported)
minor - The minor version to support
Returns:
A wrapper object containing the data returned by the profile
Throws:
SAMLException - Raised if an error occurs during profile processing


Copyright ? 2005 UCAID. All Rights Reserved.