SOAPMessageContext (Java Platform SE 6)

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.soap
interface SOAPMessageContext

All Superinterfaces:: Map, MessageContext

public interface SOAPMessageContext
extends MessageContext

The interface SOAPMessageContext provides access to the SOAP message for either RPC request or response. The javax.xml.soap.SOAPMessage specifies the standard Java API for the representation of a SOAP 1.1 message with attachments.

Nested Class Summary

Nested classes/interfaces inherited from class javax.xml.ws.handler.MessageContext
`MessageContext.Scope`

Nested classes/interfaces inherited from class java.util.Map
`Map.Entry`

Field Summary

Fields inherited from class javax.xml.ws.handler.MessageContext
`HTTP_REQUEST_HEADERS, HTTP_REQUEST_METHOD, HTTP_RESPONSE_CODE, HTTP_RESPONSE_HEADERS, INBOUND_MESSAGE_ATTACHMENTS, MESSAGE_OUTBOUND_PROPERTY, OUTBOUND_MESSAGE_ATTACHMENTS, PATH_INFO, QUERY_STRING, REFERENCE_PARAMETERS, SERVLET_CONTEXT, SERVLET_REQUEST, SERVLET_RESPONSE, WSDL_DESCRIPTION, WSDL_INTERFACE, WSDL_OPERATION, WSDL_PORT, WSDL_SERVICE`

Method Summary
`Object[]`	`getHeaders(QName header, JAXBContext context, boolean allRoles)` Gets headers that have a particular qualified name from the message in the message context.
`SOAPMessage`	`getMessage()` Gets the `SOAPMessage from this message context.`
`Set`	`getRoles()` Gets the SOAP actor roles associated with an execution of the handler chain.
`void`	`setMessage(SOAPMessage message)` Sets the SOAPMessage in this message context

Methods inherited from class javax.xml.ws.handler.MessageContext
`getScope, setScope`

Methods inherited from class java.util.Map
`clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values`

Method Detail

getHeaders

public Object[] getHeaders(QName header,
                           JAXBContext context,
                           boolean allRoles)

Gets headers that have a particular qualified name from the message in the message context. Note that a SOAP message can contain multiple headers with the same qualified name.

Parameters:: header - The XML qualified name of the SOAP header(s).; context - The JAXBContext that should be used to unmarshall the header; allRoles - If true then returns headers for all SOAP roles, if false then only returns headers targetted at the roles currently being played by this SOAP node, see getRoles.
Returns:: An array of unmarshalled headers; returns an empty array if no message is present in this message context or no headers match the supplied qualified name.

getMessage

public SOAPMessage getMessage()

Gets the

SOAPMessage from this message context. Modifications
  to the returned SOAPMessage change the message in-place, there
  is no need to susequently call setMessage.

Returns:
Returns the SOAPMessage; returns null if no 
          SOAPMessage is present in this message context



getRoles
public Set getRoles()


Gets the SOAP actor roles associated with an execution
  of the handler chain.
  Note that SOAP actor roles apply to the SOAP node and
  are managed using {@link javax.xml.ws.soap.SOAPBinding#setRoles} and
  {@link javax.xml.ws.soap.SOAPBinding#getRoles}. Handler instances in
  the handler chain use this information about the SOAP actor
  roles to process the SOAP header blocks. Note that the
  SOAP actor roles are invariant during the processing of
  SOAP message through the handler chain.

Returns:
Array of String for SOAP actor roles



setMessage
public void setMessage(SOAPMessage message)


Sets the SOAPMessage in this message context

Parameters:
message - SOAP message







	
	


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

javax.xml.ws.handler.soapinterface SOAPMessageContext

getHeaders

getMessage

getRoles

setMessage

javax.xml.ws.handler.soap
interface SOAPMessageContext