org.opensaml.common.binding.decoding
Interface MessageDecoder<RequestType extends javax.servlet.ServletRequest>

Type Parameters:
RequestType - type of incoming protocol request
All Known Subinterfaces:
HTTPMessageDecoder, SOAPDecoder<RequestType>, SOAPHTTPDecoder
All Known Implementing Classes:
AbstractHTTPMessageDecoder, AbstractMessageDecoder, AbstractSOAPHTTPDecoder, HTTPArtifactDecoder, HTTPPostDecoder, HTTPPostDecoder, HTTPRedirectDeflateDecoder, HTTPSOAP11Decoder, HTTPSOAP11Decoder

public interface MessageDecoder<RequestType extends javax.servlet.ServletRequest>

Decodes a SAML message in a binding specific mannger. The decode() method should be run before any accessor methods are called.


Method Summary
 void decode()
          Decodes a SAML message in a binding specific manner.
 java.lang.String getBindingURI()
          Gets the binding URI supported by this encoder.
 MetadataProvider getMetadataProvider()
          Gets the metadata provider used to lookup information about the issuer.
 RequestType getRequest()
          Gets the request to decode.
 SAMLObject getSAMLMessage()
          Gets the SAML message that was received and decoded.
 SAMLSecurityPolicy getSecurityPolicy()
          Gets the security policy to apply to the request and its payload.
 TrustEngine getTrustEngine()
          Gets the trust engine used to verify the credentials of a request.
 void setMetadataProvider(MetadataProvider metadataProvider)
          Sets the metadata provider used to lookup information about the issuer.
 void setRequest(RequestType request)
          Sets the request to decode.
 void setSecurityPolicy(SAMLSecurityPolicy policy)
          Sets the security policy to apply to the request and its payload.
 void setTrustEngine(TrustEngine trustEngine)
          Sets the the trust engine used to verify the credentials of a request.
 

Method Detail

getBindingURI

java.lang.String getBindingURI()
Gets the binding URI supported by this encoder.

Returns:
binding URI supported by this encoder

getRequest

RequestType getRequest()
Gets the request to decode.

Returns:
request to decode

setRequest

void setRequest(RequestType request)
Sets the request to decode.

Parameters:
request - request to decode

getMetadataProvider

MetadataProvider getMetadataProvider()
Gets the metadata provider used to lookup information about the issuer.

Returns:
metadata provider used to lookup information about the issuer

setMetadataProvider

void setMetadataProvider(MetadataProvider metadataProvider)
Sets the metadata provider used to lookup information about the issuer.

Parameters:
metadataProvider - metadata provider used to lookup information about the issuer

getTrustEngine

TrustEngine getTrustEngine()
Gets the trust engine used to verify the credentials of a request.

Returns:
the trust engine used to verify the credentials of a request

getSecurityPolicy

SAMLSecurityPolicy getSecurityPolicy()
Gets the security policy to apply to the request and its payload.

Returns:
security policy to apply to the request and its payload

setSecurityPolicy

void setSecurityPolicy(SAMLSecurityPolicy policy)
Sets the security policy to apply to the request and its payload.

Parameters:
policy - security policy to apply to the request and its payload

setTrustEngine

void setTrustEngine(TrustEngine trustEngine)
Sets the the trust engine used to verify the credentials of a request.

Parameters:
trustEngine - the trust engine used to verify the credentials of a request

decode

void decode()
            throws BindingException,
                   SecurityPolicyException
Decodes a SAML message in a binding specific manner.

Throws:
BindingException - thrown if the message can not be decoded
SecurityPolicyException - thrown if the decoded message does not meet the required security policy

getSAMLMessage

SAMLObject getSAMLMessage()
Gets the SAML message that was received and decoded.

Returns:
SAML message