org.opensaml.ws.message

インタフェース MessageContext

既知のサブインタフェースのリスト:

ProfileRequestContext<ProfileConfigurationType>, SAML1ArtifactMessageContext<InboundMessageType,OutboundMessageType,NameIdentifierType>, SAML2ArtifactMessageContext<InboundMessageType,OutboundMessageType,NameIdentifierType>, SAMLMessageContext<InboundMessageType,OutboundMessageType,NameIdentifierType>, SAMLProfileRequestContext<InboundMessageType,OutboundMessageType,NameIdentifierType,ProfileConfigurationType>, SOAPMessageContext

既知の実装クラスのリスト:

ArtifactResolution.ArtifactResolutionRequestContext, ArtifactResolution.ArtifactResolutionRequestContext, AttributeQueryProfileHandler.AttributeQueryContext, AttributeQueryProfileHandler.AttributeQueryContext, BaseMessageContext, BaseSAML1ProfileRequestContext, BaseSAML2ProfileRequestContext, BaseSAMLProfileRequestContext, BasicSAMLMessageContext, BasicSOAPMessageContext, SAML2ECPProfileHandler.ECPRequestContext, ShibbolethSSOProfileHandler.ShibbolethSSORequestContext, SLOProfileHandler.SLORequestContext, SSOProfileHandler.SSORequestContext

public interface MessageContext

A message context represents the entire context for a given message through the receive, process, and/or response phases. It is a basic unit of work within the library. Message contexts are NOT thread safe.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
String	getCommunicationProfileId() Gets the unique id of the communication profile in use.
XMLObject	getInboundMessage() Gets the inbound message.
String	getInboundMessageIssuer() Gets the issuer of the inbound message.
InTransport	getInboundMessageTransport() Gets the transport used to receive the message.
HandlerChainResolver	getOutboundHandlerChainResolver() Get the outbound handler chain resolver.
XMLObject	getOutboundMessage() Gets the outbound message.
String	getOutboundMessageIssuer() Gets the issuer of the outbound message.
OutTransport	getOutboundMessageTransport() Gets the transport used to respond to the message.
HandlerChainResolver	getPostSecurityInboundHandlerChainResolver() Get the post-SecurityPolicy inbound handler chain resolver.
HandlerChainResolver	getPreSecurityInboundHandlerChainResolver() Get the pre-SecurityPolicy inbound handler chain resolver.
SecurityPolicyResolver	getSecurityPolicyResolver() Gets the resolver used to determine active SecurityPolicy.
boolean	isIssuerAuthenticated() Gets whether the issuer of the inbound message represented by this context has been authenticated.
void	setCommunicationProfileId(String id) Sets the unique id of the communication profile in use.
void	setInboundMessage(XMLObject message) Sets the inbound message.
void	setInboundMessageIssuer(String issuer) Sets the issuer of the inbound message.
void	setInboundMessageTransport(InTransport transport) Sets the transport used to used to receive the message.
void	setOutboundHandlerChainResolver(HandlerChainResolver newHandlerChainResolver) Set the outbound handler chain resolver.
void	setOutboundMessage(XMLObject message) Sets the outbound message.
void	setOutboundMessageIssuer(String issuer) Sets the issuer of the outbound message.
void	setOutboundMessageTransport(OutTransport transport) Sets the transport used to respond to the message.
void	setPostSecurityInboundHandlerChainResolver(HandlerChainResolver newHandlerChainResolver) Set the post-SecurityPolicy inbound handler chain resolver.
void	setPreSecurityInboundHandlerChainResolver(HandlerChainResolver newHandlerChainResolver) Set the pre-SecurityPolicy inbound handler chain resolver.
void	setSecurityPolicyResolver(SecurityPolicyResolver resolver) Sets the resolver used to determine active SecurityPolicy.

メソッドの詳細

getCommunicationProfileId

String getCommunicationProfileId()

Gets the unique id of the communication profile in use.

戻り値:

unique id of the communication profile in use

getInboundMessage

XMLObject getInboundMessage()

Gets the inbound message.

戻り値:

the inbound message

getInboundMessageIssuer

String getInboundMessageIssuer()

Gets the issuer of the inbound message.

戻り値:

issuer of the inbound message

getInboundMessageTransport

InTransport getInboundMessageTransport()

Gets the transport used to receive the message.

戻り値:

transport used to receive the message

getOutboundMessage

XMLObject getOutboundMessage()

Gets the outbound message.

戻り値:

the outbound message

getOutboundMessageIssuer

String getOutboundMessageIssuer()

Gets the issuer of the outbound message.

戻り値:

issuer of the outbound message

getOutboundMessageTransport

OutTransport getOutboundMessageTransport()

Gets the transport used to respond to the message.

戻り値:

transport used to respond to the message

getSecurityPolicyResolver

SecurityPolicyResolver getSecurityPolicyResolver()

Gets the resolver used to determine active SecurityPolicy.

戻り値:

resolver used to determine active SecurityPolicy

isIssuerAuthenticated

boolean isIssuerAuthenticated()

Gets whether the issuer of the inbound message represented by this context has been authenticated. What it means for the message issuer to be authenticate will vary by use and employed authentication mechanisms.

戻り値:

whether the issuer of the inbound message represented by this context has been authenticated

setCommunicationProfileId

void setCommunicationProfileId(String id)

Sets the unique id of the communication profile in use.

パラメータ:

id - unique id of the communication profile in use

setInboundMessage

void setInboundMessage(XMLObject message)

Sets the inbound message.

パラメータ:

message - the inbound message

setInboundMessageIssuer

void setInboundMessageIssuer(String issuer)

Sets the issuer of the inbound message.

パラメータ:

issuer - issuer of the inbound message

setInboundMessageTransport

void setInboundMessageTransport(InTransport transport)

Sets the transport used to used to receive the message.

パラメータ:

transport - the transport used to receive the message

setOutboundMessage

void setOutboundMessage(XMLObject message)

Sets the outbound message.

パラメータ:

message - the outbound message

setOutboundMessageIssuer

void setOutboundMessageIssuer(String issuer)

Sets the issuer of the outbound message.

パラメータ:

issuer - issuer of the outbound message

setOutboundMessageTransport

void setOutboundMessageTransport(OutTransport transport)

Sets the transport used to respond to the message.

パラメータ:

transport - the transport used to respond to the message

setSecurityPolicyResolver

void setSecurityPolicyResolver(SecurityPolicyResolver resolver)

Sets the resolver used to determine active SecurityPolicy.

パラメータ:

resolver - resolver used to determine active SecurityPolicy

getPreSecurityInboundHandlerChainResolver

HandlerChainResolver getPreSecurityInboundHandlerChainResolver()

Get the pre-SecurityPolicy inbound handler chain resolver.

戻り値:

the pre-security inbound handler chain resolver.

setPreSecurityInboundHandlerChainResolver

void setPreSecurityInboundHandlerChainResolver(HandlerChainResolver newHandlerChainResolver)

Set the pre-SecurityPolicy inbound handler chain resolver.

パラメータ:

newHandlerChainResolver - the new pre-SecurityPolicy inbound handler chain.

getPostSecurityInboundHandlerChainResolver

HandlerChainResolver getPostSecurityInboundHandlerChainResolver()

Get the post-SecurityPolicy inbound handler chain resolver.

戻り値:

the pre-SecurityPolicy inbound handler chain resolver.

setPostSecurityInboundHandlerChainResolver

void setPostSecurityInboundHandlerChainResolver(HandlerChainResolver newHandlerChainResolver)

Set the post-SecurityPolicy inbound handler chain resolver.

パラメータ:

newHandlerChainResolver - the new post-SecurityPolicy inbound handler chain resolver.

getOutboundHandlerChainResolver

HandlerChainResolver getOutboundHandlerChainResolver()

Get the outbound handler chain resolver.

戻り値:

the outbound handler chain resolver.

setOutboundHandlerChainResolver

void setOutboundHandlerChainResolver(HandlerChainResolver newHandlerChainResolver)

Set the outbound handler chain resolver.

パラメータ:

newHandlerChainResolver - the new outbound handler chain resolver.