org.opensaml.ws.message

Class BaseMessageContext

java.lang.Object

org.opensaml.ws.message.BaseMessageContext

All Implemented Interfaces:

MessageContext

Direct Known Subclasses:

BasicSOAPMessageContext

public class BaseMessageContext
extends Object
implements MessageContext

Base class for message context implementations.

Field Summary

Fields

Modifier and Type	Field and Description
private String	communicationProfile Unique id of the communication profile in use.
private XMLObject	inboundMessage The inbound message.
private String	inboundMessageIssuer Issuer of the inbound message.
private InTransport	inboundTransport Inbound message transport.
private HandlerChainResolver	outboundHandlerChainResolver Inbound handler chain.
private XMLObject	outboundMessage Outbound message.
private String	outboundMessageIssuer Issuer of the outbound message.
private OutTransport	outboundTransport Outbound message transport.
private HandlerChainResolver	postSecurityInboundHandlerChainResolver Post-SecurityPolicy inbound handler chain.
private HandlerChainResolver	preSecurityInboundHandlerChainResolver Pre-SecurityPolicy inbound handler chain.
private SecurityPolicyResolver	securityPolicyResolver Resolver used to determine active security policy.

Constructor Summary

Constructors

Constructor and Description
BaseMessageContext()

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.

Methods inherited from class java.lang.Object

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

Field Detail

communicationProfile

private String communicationProfile

Unique id of the communication profile in use.

inboundMessage

private XMLObject inboundMessage

The inbound message.

inboundMessageIssuer

private String inboundMessageIssuer

Issuer of the inbound message.

inboundTransport

private InTransport inboundTransport

Inbound message transport.

outboundMessage

private XMLObject outboundMessage

Outbound message.

outboundMessageIssuer

private String outboundMessageIssuer

Issuer of the outbound message.

outboundTransport

private OutTransport outboundTransport

Outbound message transport.

securityPolicyResolver

private SecurityPolicyResolver securityPolicyResolver

Resolver used to determine active security policy.

preSecurityInboundHandlerChainResolver

private HandlerChainResolver preSecurityInboundHandlerChainResolver

Pre-SecurityPolicy inbound handler chain.

postSecurityInboundHandlerChainResolver

private HandlerChainResolver postSecurityInboundHandlerChainResolver

Post-SecurityPolicy inbound handler chain.

outboundHandlerChainResolver

private HandlerChainResolver outboundHandlerChainResolver

Inbound handler chain.

Constructor Detail

BaseMessageContext

public BaseMessageContext()

Method Detail

getCommunicationProfileId

public String getCommunicationProfileId()

Gets the unique id of the communication profile in use.

Specified by:

getCommunicationProfileId in interface MessageContext

Returns:

unique id of the communication profile in use

getInboundMessage

public XMLObject getInboundMessage()

Gets the inbound message.

Specified by:

getInboundMessage in interface MessageContext

Returns:

the inbound message

getInboundMessageIssuer

public String getInboundMessageIssuer()

Gets the issuer of the inbound message.

Specified by:

getInboundMessageIssuer in interface MessageContext

Returns:

issuer of the inbound message

getInboundMessageTransport

public InTransport getInboundMessageTransport()

Gets the transport used to receive the message.

Specified by:

getInboundMessageTransport in interface MessageContext

Returns:

transport used to receive the message

getOutboundMessage

public XMLObject getOutboundMessage()

Gets the outbound message.

Specified by:

getOutboundMessage in interface MessageContext

Returns:

the outbound message

getOutboundMessageIssuer

public String getOutboundMessageIssuer()

Gets the issuer of the outbound message.

Specified by:

getOutboundMessageIssuer in interface MessageContext

Returns:

issuer of the outbound message

getOutboundMessageTransport

public OutTransport getOutboundMessageTransport()

Gets the transport used to respond to the message.

Specified by:

getOutboundMessageTransport in interface MessageContext

Returns:

transport used to respond to the message

getSecurityPolicyResolver

public SecurityPolicyResolver getSecurityPolicyResolver()

Gets the resolver used to determine active SecurityPolicy.

Specified by:

getSecurityPolicyResolver in interface MessageContext

Returns:

resolver used to determine active SecurityPolicy

setCommunicationProfileId

public void setCommunicationProfileId(String id)

Sets the unique id of the communication profile in use.

Specified by:

setCommunicationProfileId in interface MessageContext

Parameters:

id - unique id of the communication profile in use

setInboundMessage

public void setInboundMessage(XMLObject message)

Sets the inbound message.

Specified by:

setInboundMessage in interface MessageContext

Parameters:

message - the inbound message

setInboundMessageIssuer

public void setInboundMessageIssuer(String issuer)

Sets the issuer of the inbound message.

Specified by:

setInboundMessageIssuer in interface MessageContext

Parameters:

issuer - issuer of the inbound message

setInboundMessageTransport

public void setInboundMessageTransport(InTransport transport)

Sets the transport used to used to receive the message.

Specified by:

setInboundMessageTransport in interface MessageContext

Parameters:

transport - the transport used to receive the message

setOutboundMessage

public void setOutboundMessage(XMLObject message)

Sets the outbound message.

Specified by:

setOutboundMessage in interface MessageContext

Parameters:

message - the outbound message

setOutboundMessageIssuer

public void setOutboundMessageIssuer(String issuer)

Sets the issuer of the outbound message.

Specified by:

setOutboundMessageIssuer in interface MessageContext

Parameters:

issuer - issuer of the outbound message

setOutboundMessageTransport

public void setOutboundMessageTransport(OutTransport transport)

Sets the transport used to respond to the message.

Specified by:

setOutboundMessageTransport in interface MessageContext

Parameters:

transport - the transport used to respond to the message

setSecurityPolicyResolver

public void setSecurityPolicyResolver(SecurityPolicyResolver resolver)

Sets the resolver used to determine active SecurityPolicy.

Specified by:

setSecurityPolicyResolver in interface MessageContext

Parameters:

resolver - resolver used to determine active SecurityPolicy

isIssuerAuthenticated

public 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.

Specified by:

isIssuerAuthenticated in interface MessageContext

Returns:

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

getPreSecurityInboundHandlerChainResolver

public HandlerChainResolver getPreSecurityInboundHandlerChainResolver()

Get the pre-SecurityPolicy inbound handler chain resolver.

Specified by:

getPreSecurityInboundHandlerChainResolver in interface MessageContext

Returns:

the pre-security inbound handler chain resolver.

getPostSecurityInboundHandlerChainResolver

public HandlerChainResolver getPostSecurityInboundHandlerChainResolver()

Get the post-SecurityPolicy inbound handler chain resolver.

Specified by:

getPostSecurityInboundHandlerChainResolver in interface MessageContext

Returns:

the pre-SecurityPolicy inbound handler chain resolver.

getOutboundHandlerChainResolver

public HandlerChainResolver getOutboundHandlerChainResolver()

Get the outbound handler chain resolver.

Specified by:

getOutboundHandlerChainResolver in interface MessageContext

Returns:

the outbound handler chain resolver.

setPreSecurityInboundHandlerChainResolver

public void setPreSecurityInboundHandlerChainResolver(HandlerChainResolver newHandlerChainResolver)

Set the pre-SecurityPolicy inbound handler chain resolver.

Specified by:

setPreSecurityInboundHandlerChainResolver in interface MessageContext

Parameters:

newHandlerChainResolver - the new pre-SecurityPolicy inbound handler chain.

setPostSecurityInboundHandlerChainResolver

public void setPostSecurityInboundHandlerChainResolver(HandlerChainResolver newHandlerChainResolver)

Set the post-SecurityPolicy inbound handler chain resolver.

Specified by:

setPostSecurityInboundHandlerChainResolver in interface MessageContext

Parameters:

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

setOutboundHandlerChainResolver

public void setOutboundHandlerChainResolver(HandlerChainResolver newHandlerChainResolver)

Set the outbound handler chain resolver.

Specified by:

setOutboundHandlerChainResolver in interface MessageContext

Parameters:

newHandlerChainResolver - the new outbound handler chain resolver.