Package com.sun.xml.ws.api.handler

Interface MessageHandlerContext

All Superinterfaces:

Map<String,Object>, jakarta.xml.ws.handler.MessageContext

All Known Implementing Classes:

MessageHandlerContextImpl

public interface MessageHandlerContext
extends jakarta.xml.ws.handler.MessageContext

The MessageHandlerContext interface extends MessageContext to provide easy access to the contained message. This context provides access to RI's Message model for efficient access to various things like accessing headers etc. It also provides access to binding information as WSBinding.

Since:

JAX-WS 2.1.3

Author:

Rama Pulavarthi

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface jakarta.xml.ws.handler.MessageContext

jakarta.xml.ws.handler.MessageContext.Scope

Field Summary

Fields inherited from interface jakarta.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

Modifier and Type	Method	Description
Message	getMessage()	Gets the message from this message context
WSDLPort	getPort()	Gets the WSDLPort that represents the port.
Set<String>	getRoles()
SEIModel	getSEIModel()	Provides access to SEIModel.
WSBinding	getWSBinding()	Provides access to WSBinding which can be used in various ways.
void	setMessage(Message message)	Sets the message in this message context

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

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

getScope, setScope

Method Detail

getMessage

Message getMessage()

Gets the message from this message context

Returns:

The contained message; returns null if no message is present in this message context

setMessage

void setMessage(Message message)

Sets the message in this message context

getRoles

Set<String> getRoles()

See Also:

SOAPMessageContext.getRoles()

getWSBinding

WSBinding getWSBinding()

Provides access to WSBinding which can be used in various ways. for example: WSBinding#getSOAPVersion to get SOAP version of the binding. WSBinding#isFeatureEnabled(AddressingFeature) to check if addressing is enabled

getSEIModel

@Nullable
SEIModel getSEIModel()

Provides access to SEIModel.

getPort

@Nullable
WSDLPort getPort()

Gets the WSDLPort that represents the port.

Returns:

returns the WSDLModel of the port that the client/endpoint binds to. null when the Service is not configured with WSDL information.