Spec-Zone .ru спецификации, руководства, описания, API

javax.xml.ws.handler.soap
Интерфейс SOAPMessageContext

Все Суперинтерфейсы:

java.util.Map<java.lang.String,java.lang.Object>, MessageContext

public interface SOAPMessageContext
расширяет MessageContext

Интерфейс SOAPMessageContext обеспечивает доступ к сообщению SOAP или для запроса RPC или для ответа. javax.xml.soap.SOAPMessage определяет стандартный API Java для представления SOAP 1.1 сообщения с присоединениями.

С тех пор:

JAX-WS 2.0

См. Также:

SOAPMessage

Вложенная Сводка Класса

Вложенные классы/интерфейсы, наследованные от интерфейса javax.xml.ws.handler. MessageContext

MessageContext. Контекст

Вложенные классы/интерфейсы, наследованные от интерфейса java.util. Карта

java.util.Map.Entry<K,V>

Полевая Сводка

Поля, наследованные от интерфейса 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

Сводка метода

java.lang.Object[]	getHeaders(javax.xml.namespace.QName header, JAXBContext context, boolean allRoles) Получает заголовки, у которых есть определенное полностью определенное имя из сообщения в контексте сообщения.
javax.xml.soap.SOAPMessage	getMessage() Добирается SOAPMessage from this message context.
java.util.Set<java.lang.String>	getRoles() Gets the SOAP actor roles associated with an execution of the handler chain.
void	setMessage(javax.xml.soap.SOAPMessage message) Sets the SOAPMessage in this message context

Methods inherited from interface javax.xml.ws.handler.MessageContext

getScope, setScope

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

getMessage

javax.xml.soap.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

setMessage

void setMessage(javax.xml.soap.SOAPMessage message)

Sets the SOAPMessage in this message context

Parameters:

message - SOAP message

Throws:

WebServiceException - If any error during the setting of the SOAPMessage in this message context

java.lang.UnsupportedOperationException - If this operation is not supported

getHeaders

java.lang.Object[] getHeaders(javax.xml.namespace.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.

Throws:

WebServiceException - If an error occurs when using the supplied JAXBContext to unmarshall. The cause of the WebServiceException is the original JAXBException.

getRoles

java.util.Set<java.lang.String> 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 SOAPBinding.setRoles(java.util.Set) and 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