01: package com.sun.xml.ws.api.handler;
02:
03: import com.sun.istack.Nullable;
04: import com.sun.xml.ws.api.WSBinding;
05: import com.sun.xml.ws.api.message.Message;
06: import com.sun.xml.ws.api.model.SEIModel;
07: import javax.xml.ws.handler.MessageContext;
08: import java.util.Set;
09:
10: /**
11: * The <code>MessageHandlerContext</code> interface extends
12: * <code>MessageContext</code> to provide easy access to the contained message.
13: *
14: * This context provides access to RI's <code>Message</code> model for efficient access
15: * to various things like accessing headers etc. It also provides access to
16: * binding information as <code>WSBinding</code>.
17: *
18: * @author Rama Pulavarthi
19: * @since JAX-WS 2.1.3
20: */
21: public interface MessageHandlerContext extends MessageContext {
22: /**
23: * Gets the message from this message context
24: *
25: * @return The contained message; returns <code>null</code> if no
26: * message is present in this message context
27: */
28: public Message getMessage();
29:
30: /**
31: * Sets the message in this message context
32: */
33: public void setMessage(Message message);
34:
35: /**
36: * @see javax.xml.ws.handler.soap.SOAPMessageContext#getRoles()
37: */
38: public Set<String> getRoles();
39:
40: /**
41: * Provides access to <code>WSBinding</code> which can be used in various ways.
42: * for example: <code>WSBinding#getSOAPVersion</code> to get SOAP version of the binding.
43: * <code>WSBinding#isFeatureEnabled(AddressingFeature)</code> to check if addressing is enabled
44: */
45: public WSBinding getWSBinding();
46:
47: /**
48: * Provides access to <code>SEIModel</code>.
49: */
50: public @Nullable
51: SEIModel getSEIModel();
52:
53: }
|