org.opensaml.ws.message
Interface MessageContext

All Known Implementing Classes:
BaseMessageContext

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
 java.lang.String getCommunicationProfileId()
          Gets the unique id of the communication profile in use.
 org.opensaml.xml.XMLObject getInboundMessage()
          Gets the inbound message.
 java.lang.String getInboundMessageIssuer()
          Gets the issuer of the inbound message.
 InTransport getInboundMessageTransport()
          Gets the transport used to receive the message.
 org.opensaml.xml.XMLObject getOutboundMessage()
          Gets the outbound message.
 java.lang.String getOutboundMessageIssuer()
          Gets the issuer of the outbound message.
 OutTransport getOutboundMessageTransport()
          Gets the transport used to respond to the message.
 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(java.lang.String id)
          Sets the unique id of the communication profile in use.
 void setInboundMessage(org.opensaml.xml.XMLObject message)
          Sets the inbound message.
 void setInboundMessageIssuer(java.lang.String issuer)
          Sets the issuer of the inbound message.
 void setInboundMessageTransport(InTransport transport)
          Sets the transport used to used to receive the message.
 void setOutboundMessage(org.opensaml.xml.XMLObject message)
          Sets the outbound message.
 void setOutboundMessageIssuer(java.lang.String issuer)
          Sets the issuer of the outbound message.
 void setOutboundMessageTransport(OutTransport transport)
          Sets the transport used to respond to the message.
 void setSecurityPolicyResolver(SecurityPolicyResolver resolver)
          Sets the resolver used to determine active SecurityPolicy.
 

Method Detail

getCommunicationProfileId

java.lang.String getCommunicationProfileId()
Gets the unique id of the communication profile in use.

Returns:
unique id of the communication profile in use

getInboundMessage

org.opensaml.xml.XMLObject getInboundMessage()
Gets the inbound message.

Returns:
the inbound message

getInboundMessageIssuer

java.lang.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

org.opensaml.xml.XMLObject getOutboundMessage()
Gets the outbound message.

Returns:
the outbound message

getOutboundMessageIssuer

java.lang.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(java.lang.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(org.opensaml.xml.XMLObject message)
Sets the inbound message.

Parameters:
message - the inbound message

setInboundMessageIssuer

void setInboundMessageIssuer(java.lang.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(org.opensaml.xml.XMLObject message)
Sets the outbound message.

Parameters:
message - the outbound message

setOutboundMessageIssuer

void setOutboundMessageIssuer(java.lang.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


Copyright © 2006-2011 Internet2. All Rights Reserved.