This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

javax.xml.ws.handler
interface MessageContext

All Superinterfaces:
Map
All Known Subinterfaces:
LogicalMessageContext, SOAPMessageContext
Most common way to construct:

WebServiceContext wsContext = …;

MessageContext msgContext = wsContext.getMessageContext();

Based on 32 examples 

public interface MessageContext
extends Map

The interface MessageContext abstracts the message context that is processed by a handler in the handle method.

The MessageContext interface provides methods to manage a property set. MessageContext properties enable handlers in a handler chain to share processing related state.

Nested Class Summary
static enum
MessageContext.Scope

           Property scope.
Nested classes/interfaces inherited from class java.util.Map
Map.Entry
   
Field Summary
static String HTTP_REQUEST_HEADERS
          Standard property: HTTP request headers.
static String HTTP_REQUEST_METHOD
          Standard property: HTTP request method.
static String HTTP_RESPONSE_CODE
          Standard property: HTTP response status code.
static String HTTP_RESPONSE_HEADERS
          Standard property: HTTP response headers.
static String INBOUND_MESSAGE_ATTACHMENTS
          Standard property: Map of attachments to a message for the inbound message, key is the MIME Content-ID, value is a DataHandler.
static String MESSAGE_OUTBOUND_PROPERTY
          Standard property: message direction, true for outbound messages, false for inbound.
static String OUTBOUND_MESSAGE_ATTACHMENTS
          Standard property: Map of attachments to a message for the outbound message, key is the MIME Content-ID, value is a DataHandler.
static String PATH_INFO
          Standard property: Request Path Info
static String QUERY_STRING
          Standard property: Query string for request.
static String REFERENCE_PARAMETERS
          Standard property: WS Addressing Reference Parameters.
static String SERVLET_CONTEXT
          Standard property: servlet context object.
static String SERVLET_REQUEST
          Standard property: servlet request object.
static String SERVLET_RESPONSE
          Standard property: servlet response object.
static String WSDL_DESCRIPTION
          Standard property: input source for WSDL document.
static String WSDL_INTERFACE
          Standard property: name of wsdl interface (2.0) or port type (1.1).
static String WSDL_OPERATION
          Standard property: name of WSDL operation.
static String WSDL_PORT
          Standard property: name of WSDL port.
static String WSDL_SERVICE
          Standard property: name of WSDL service.
 
Method Summary
 MessageContext.Scope
getScope(String name)

          Gets the scope of a property.
 void
setScope(String name, MessageContext.Scope scope)

          Sets the scope of a property.
 
Methods inherited from class java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 

Field Detail

HTTP_REQUEST_HEADERS

public static final String HTTP_REQUEST_HEADERS
Standard property: HTTP request headers.

Type: java.util.Map<java.lang.String, java.util.List<java.lang.String>>

HTTP_REQUEST_METHOD

public static final String HTTP_REQUEST_METHOD
Standard property: HTTP request method.

Type: java.lang.String

HTTP_RESPONSE_CODE

public static final String HTTP_RESPONSE_CODE
Standard property: HTTP response status code.

Type: java.lang.Integer

HTTP_RESPONSE_HEADERS

public static final String HTTP_RESPONSE_HEADERS
Standard property: HTTP response headers.

Type: java.util.Map<java.lang.String, java.util.List<java.lang.String>>

INBOUND_MESSAGE_ATTACHMENTS

public static final String INBOUND_MESSAGE_ATTACHMENTS
Standard property: Map of attachments to a message for the inbound message, key is the MIME Content-ID, value is a DataHandler.

Type: java.util.Map

MESSAGE_OUTBOUND_PROPERTY

public static final String MESSAGE_OUTBOUND_PROPERTY
Standard property: message direction, true for outbound messages, false for inbound.

Type: boolean

OUTBOUND_MESSAGE_ATTACHMENTS

public static final String OUTBOUND_MESSAGE_ATTACHMENTS
Standard property: Map of attachments to a message for the outbound message, key is the MIME Content-ID, value is a DataHandler.

Type: java.util.Map

PATH_INFO

public static final String PATH_INFO
Standard property: Request Path Info

Type: String

QUERY_STRING

public static final String QUERY_STRING
Standard property: Query string for request.

Type: String

REFERENCE_PARAMETERS

public static final String REFERENCE_PARAMETERS
Standard property: WS Addressing Reference Parameters. The list MUST include all SOAP headers marked with the wsa:IsReferenceParameter="true" attribute.

Type: List

SERVLET_CONTEXT

public static final String SERVLET_CONTEXT
Standard property: servlet context object.

Type: javax.servlet.ServletContext

SERVLET_REQUEST

public static final String SERVLET_REQUEST
Standard property: servlet request object.

Type: javax.servlet.http.HttpServletRequest

SERVLET_RESPONSE

public static final String SERVLET_RESPONSE
Standard property: servlet response object.

Type: javax.servlet.http.HttpServletResponse

WSDL_DESCRIPTION

public static final String WSDL_DESCRIPTION
Standard property: input source for WSDL document.

Type: org.xml.sax.InputSource

WSDL_INTERFACE

public static final String WSDL_INTERFACE
Standard property: name of wsdl interface (2.0) or port type (1.1).

Type: javax.xml.namespace.QName

WSDL_OPERATION

public static final String WSDL_OPERATION
Standard property: name of WSDL operation.

Type: javax.xml.namespace.QName

WSDL_PORT

public static final String WSDL_PORT
Standard property: name of WSDL port.

Type: javax.xml.namespace.QName

WSDL_SERVICE

public static final String WSDL_SERVICE
Standard property: name of WSDL service.

Type: javax.xml.namespace.QName

Method Detail

getScope

public MessageContext.Scope getScope(String name)
Gets the scope of a property.

Parameters:
name - Name of the property
Returns:
Scope of the property

setScope

public void setScope(String name,
                     MessageContext.Scope scope)
Sets the scope of a property.

Parameters:
name - Name of the property associated with the MessageContext
scope - Desired scope of the property
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.