org.opensaml.saml2.binding.encoding

Class HTTPRedirectDeflateEncoder

java.lang.Object

org.opensaml.ws.message.encoder.BaseMessageEncoder

org.opensaml.saml2.binding.encoding.BaseSAML2MessageEncoder

org.opensaml.saml2.binding.encoding.HTTPRedirectDeflateEncoder

All Implemented Interfaces:

SAMLMessageEncoder, org.opensaml.ws.message.encoder.MessageEncoder

public class HTTPRedirectDeflateEncoder
extends BaseSAML2MessageEncoder

SAML 2.0 HTTP Redirect encoder using the DEFLATE encoding method. This encoder only supports DEFLATE compression and DSA-SHA1 and RSA-SHA1 signatures.

Constructor Summary

Constructors

Constructor and Description
HTTPRedirectDeflateEncoder() Constructor.

Method Summary

Modifier and Type	Method and Description
protected String	buildRedirectURL(SAMLMessageContext messagesContext, String endpointURL, String message) Builds the URL to redirect the client to.
protected String	deflateAndBase64Encode(SAMLObject message) DEFLATE (RFC1951) compresses the given SAML message.
protected void	doEncode(org.opensaml.ws.message.MessageContext messageContext)
protected String	generateSignature(org.opensaml.xml.security.credential.Credential signingCredential, String algorithmURI, String queryString) Generates the signature over the query string.
String	getBindingURI() Gets the SAML binding URI supported by this encoder.
protected String	getSignatureAlgorithmURI(org.opensaml.xml.security.credential.Credential credential, org.opensaml.xml.security.SecurityConfiguration config) Gets the signature algorithm URI to use with the given signing credential.
boolean	providesMessageConfidentiality(org.opensaml.ws.message.MessageContext messageContext)
boolean	providesMessageIntegrity(org.opensaml.ws.message.MessageContext messageContext)
protected void	removeSignature(SAMLMessageContext messageContext) Removes the signature from the protocol message.

Methods inherited from class org.opensaml.saml2.binding.encoding.BaseSAML2MessageEncoder

checkRelayState, getAllowedURLSchemes, getEndpointURL, setAllowedURLSchemes, setResponseDestination, signMessage

Methods inherited from class org.opensaml.ws.message.encoder.BaseMessageEncoder

encode, logEncodedMessage, marshallMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensaml.ws.message.encoder.MessageEncoder

encode

Constructor Detail

HTTPRedirectDeflateEncoder

public HTTPRedirectDeflateEncoder()

Constructor.

Method Detail

getBindingURI

public String getBindingURI()

Gets the SAML binding URI supported by this encoder.

Returns:

SAML binding URI supported by this encoder

providesMessageConfidentiality

public boolean providesMessageConfidentiality(org.opensaml.ws.message.MessageContext messageContext)
                                       throws org.opensaml.ws.message.encoder.MessageEncodingException

Throws:

org.opensaml.ws.message.encoder.MessageEncodingException

providesMessageIntegrity

public boolean providesMessageIntegrity(org.opensaml.ws.message.MessageContext messageContext)
                                 throws org.opensaml.ws.message.encoder.MessageEncodingException

Throws:

org.opensaml.ws.message.encoder.MessageEncodingException

doEncode

protected void doEncode(org.opensaml.ws.message.MessageContext messageContext)
                 throws org.opensaml.ws.message.encoder.MessageEncodingException

Specified by:

doEncode in class org.opensaml.ws.message.encoder.BaseMessageEncoder

Throws:

org.opensaml.ws.message.encoder.MessageEncodingException

removeSignature

protected void removeSignature(SAMLMessageContext messageContext)

Removes the signature from the protocol message.

Parameters:

messageContext - current message context

deflateAndBase64Encode

protected String deflateAndBase64Encode(SAMLObject message)
                                 throws org.opensaml.ws.message.encoder.MessageEncodingException

DEFLATE (RFC1951) compresses the given SAML message.

Parameters:

message - SAML message

Returns:

DEFLATE compressed message

Throws:

org.opensaml.ws.message.encoder.MessageEncodingException - thrown if there is a problem compressing the message

buildRedirectURL

protected String buildRedirectURL(SAMLMessageContext messagesContext,
                                  String endpointURL,
                                  String message)
                           throws org.opensaml.ws.message.encoder.MessageEncodingException

Builds the URL to redirect the client to.

Parameters:

messagesContext - current message context

endpointURL - endpoint URL to send encoded message to

message - Deflated and Base64 encoded message

Returns:

URL to redirect client to

Throws:

org.opensaml.ws.message.encoder.MessageEncodingException - thrown if the SAML message is neither a RequestAbstractType or Response

getSignatureAlgorithmURI

protected String getSignatureAlgorithmURI(org.opensaml.xml.security.credential.Credential credential,
                                          org.opensaml.xml.security.SecurityConfiguration config)
                                   throws org.opensaml.ws.message.encoder.MessageEncodingException

Gets the signature algorithm URI to use with the given signing credential.

Parameters:

credential - the credential that will be used to sign the message

config - the SecurityConfiguration to use (may be null)

Returns:

signature algorithm to use with the given signing credential

Throws:

org.opensaml.ws.message.encoder.MessageEncodingException - thrown if the algorithm URI could not be derived from the supplied credential

generateSignature

protected String generateSignature(org.opensaml.xml.security.credential.Credential signingCredential,
                                   String algorithmURI,
                                   String queryString)
                            throws org.opensaml.ws.message.encoder.MessageEncodingException

Generates the signature over the query string.

Parameters:

signingCredential - credential that will be used to sign query string

algorithmURI - algorithm URI of the signing credential

queryString - query string to be signed

Returns:

base64 encoded signature of query string

Throws:

org.opensaml.ws.message.encoder.MessageEncodingException - there is an error computing the signature