org.opensaml.saml2.binding.encoding

クラス BaseSAML2MessageEncoder

java.lang.Object

org.opensaml.ws.message.encoder.BaseMessageEncoder

org.opensaml.saml2.binding.encoding.BaseSAML2MessageEncoder

すべての実装されたインタフェース:

SAMLMessageEncoder, MessageEncoder

直系の既知のサブクラス:

HandlerChainAwareHTTPSOAP11Encoder, HTTPArtifactEncoder, HTTPPostEncoder, HTTPRedirectDeflateEncoder, HTTPSOAP11Encoder

public abstract class BaseSAML2MessageEncoder
extends BaseMessageEncoder
implements SAMLMessageEncoder

Base class for SAML 2 message encoders.

コンストラクタの概要

コンストラクタ

コンストラクタと説明
BaseSAML2MessageEncoder()

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
protected boolean	checkRelayState(String relayState) Checks that the relay state is 80 bytes or less if it is not null.
List<String>	getAllowedURLSchemes() Gets the unmodifiable list of schemes allowed to appear in URLs related to the encoded message.
protected URLBuilder	getEndpointURL(SAMLMessageContext messageContext) Gets the response URL from the relying party endpoint.
void	setAllowedURLSchemes(String[] schemes) Sets the list of list of schemes allowed to appear in URLs related to the encoded message.
protected void	setResponseDestination(SAMLObject outboundMessage, String endpointURL) Sets the destination attribute on the outbound message if it is a StatusResponseType message.
protected void	signMessage(SAMLMessageContext messageContext) Signs the given SAML message if it a SignableSAMLObject and this encoder has signing credentials.

クラスから継承されたメソッド org.opensaml.ws.message.encoder.BaseMessageEncoder

doEncode, encode, logEncodedMessage, marshallMessage

クラスから継承されたメソッド java.lang.Object

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

インタフェースから継承されたメソッド org.opensaml.common.binding.encoding.SAMLMessageEncoder

getBindingURI

インタフェースから継承されたメソッド org.opensaml.ws.message.encoder.MessageEncoder

encode, providesMessageConfidentiality, providesMessageIntegrity

コンストラクタの詳細

BaseSAML2MessageEncoder

public BaseSAML2MessageEncoder()

メソッドの詳細

getAllowedURLSchemes

public List<String> getAllowedURLSchemes()

Gets the unmodifiable list of schemes allowed to appear in URLs related to the encoded message.

戻り値:

list of URL schemes allowed to appear in a message

setAllowedURLSchemes

public void setAllowedURLSchemes(String[] schemes)

Sets the list of list of schemes allowed to appear in URLs related to the encoded message. Note, the appearance of schemes such as 'javascript' may open the system up to attacks (e.g. cross-site scripting attacks).

パラメータ:

schemes - URL schemes allowed to appear in a message

getEndpointURL

protected URLBuilder getEndpointURL(SAMLMessageContext messageContext)
                             throws MessageEncodingException

Gets the response URL from the relying party endpoint. If the SAML message is a StatusResponseType and the relying party endpoint contains a response location then that location is returned otherwise the normal endpoint location is returned.

パラメータ:

messageContext - current message context

戻り値:

response URL from the relying party endpoint

例外:

MessageEncodingException - throw if no relying party endpoint is available

checkRelayState

protected boolean checkRelayState(String relayState)

Checks that the relay state is 80 bytes or less if it is not null.

パラメータ:

relayState - relay state to check

戻り値:

true if the relay state is not empty and is less than 80 bytes

setResponseDestination

protected void setResponseDestination(SAMLObject outboundMessage,
                          String endpointURL)

Sets the destination attribute on the outbound message if it is a StatusResponseType message.

パラメータ:

outboundMessage - outbound SAML message

endpointURL - destination endpoint

signMessage

protected void signMessage(SAMLMessageContext messageContext)
                    throws MessageEncodingException

Signs the given SAML message if it a SignableSAMLObject and this encoder has signing credentials.

パラメータ:

messageContext - current message context

例外:

MessageEncodingException - thrown if there is a problem marshalling or signing the outbound message