org.opensaml.ws.message

Interface MessageContext

All Known Subinterfaces:

SOAPMessageContext

All Known Implementing Classes:

BaseMessageContext, BasicSOAPMessageContext

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.

Method Summary

Methods

Modifier and Type	Method and Description
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.

Method Detail

getCommunicationProfileId

String getCommunicationProfileId()

Gets the unique id of the communication profile in use.

Returns:

unique id of the communication profile in use

getInboundMessage

XMLObject getInboundMessage()

Gets the inbound message.

Returns:

the inbound message

getInboundMessageIssuer

String getInboundMessageIssuer()

Gets the issuer of the inbound message.

Returns:

issuer of the inbound message

getInboundMessageTransport

InTransport getInboundMessageTransport()

Gets the transport used to receive the message.

Returns:

transport used to receive the message

getOutboundMessage

XMLObject getOutboundMessage()

Gets the outbound message.

Returns:

the outbound message

getOutboundMessageIssuer

String getOutboundMessageIssuer()

Gets the issuer of the outbound message.

Returns:

issuer of the outbound message

getOutboundMessageTransport

OutTransport getOutboundMessageTransport()

Gets the transport used to respond to the message.

Returns:

transport used to respond to the message

getSecurityPolicyResolver

SecurityPolicyResolver getSecurityPolicyResolver()

Gets the resolver used to determine active SecurityPolicy.

Returns:

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.

Returns:

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.

Parameters:

id - unique id of the communication profile in use

setInboundMessage

void setInboundMessage(XMLObject message)

Sets the inbound message.

Parameters:

message - the inbound message

setInboundMessageIssuer

void setInboundMessageIssuer(String issuer)

Sets the issuer of the inbound message.

Parameters:

issuer - issuer of the inbound message

setInboundMessageTransport

void setInboundMessageTransport(InTransport transport)

Sets the transport used to used to receive the message.

Parameters:

transport - the transport used to receive the message

setOutboundMessage

void setOutboundMessage(XMLObject message)

Sets the outbound message.

Parameters:

message - the outbound message

setOutboundMessageIssuer

void setOutboundMessageIssuer(String issuer)

Sets the issuer of the outbound message.

Parameters:

issuer - issuer of the outbound message

setOutboundMessageTransport

void setOutboundMessageTransport(OutTransport transport)

Sets the transport used to respond to the message.

Parameters:

transport - the transport used to respond to the message

setSecurityPolicyResolver

void setSecurityPolicyResolver(SecurityPolicyResolver resolver)

Sets the resolver used to determine active SecurityPolicy.

Parameters:

resolver - resolver used to determine active SecurityPolicy

getPreSecurityInboundHandlerChainResolver

HandlerChainResolver getPreSecurityInboundHandlerChainResolver()

Get the pre-SecurityPolicy inbound handler chain resolver.

Returns:

the pre-security inbound handler chain resolver.

setPreSecurityInboundHandlerChainResolver

void setPreSecurityInboundHandlerChainResolver(HandlerChainResolver newHandlerChainResolver)

Set the pre-SecurityPolicy inbound handler chain resolver.

Parameters:

newHandlerChainResolver - the new pre-SecurityPolicy inbound handler chain.

getPostSecurityInboundHandlerChainResolver

HandlerChainResolver getPostSecurityInboundHandlerChainResolver()

Get the post-SecurityPolicy inbound handler chain resolver.

Returns:

the pre-SecurityPolicy inbound handler chain resolver.

setPostSecurityInboundHandlerChainResolver

void setPostSecurityInboundHandlerChainResolver(HandlerChainResolver newHandlerChainResolver)

Set the post-SecurityPolicy inbound handler chain resolver.

Parameters:

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

getOutboundHandlerChainResolver

HandlerChainResolver getOutboundHandlerChainResolver()

Get the outbound handler chain resolver.

Returns:

the outbound handler chain resolver.

setOutboundHandlerChainResolver

void setOutboundHandlerChainResolver(HandlerChainResolver newHandlerChainResolver)

Set the outbound handler chain resolver.

Parameters:

newHandlerChainResolver - the new outbound handler chain resolver.