| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>SOAPMessageContext</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SOAPMessageContext"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../jakarta/xml/ws/handler/soap/SOAPHandler.html" title="interface in jakarta.xml.ws.handler.soap"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?jakarta/xml/ws/handler/soap/SOAPMessageContext.html" target="_top">Frames</a></li> |
| <li><a href="SOAPMessageContext.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.xml.ws.handler.soap</div> |
| <h2 title="Interface SOAPMessageContext" class="title">Interface SOAPMessageContext</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd>java.util.Map<java.lang.String,java.lang.Object>, <a href="../../../../../jakarta/xml/ws/handler/MessageContext.html" title="interface in jakarta.xml.ws.handler">MessageContext</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">SOAPMessageContext</span> |
| extends <a href="../../../../../jakarta/xml/ws/handler/MessageContext.html" title="interface in jakarta.xml.ws.handler">MessageContext</a></pre> |
| <div class="block">The interface <code>SOAPMessageContext</code> |
| provides access to the SOAP message for either RPC request or |
| response. The <code>jakarta.xml.soap.SOAPMessage</code> specifies |
| the standard Java API for the representation of a SOAP 1.1 message |
| with attachments.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, JAX-WS 2.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../jakarta/xml/soap/SOAPMessage.html" title="class in jakarta.xml.soap"><code>SOAPMessage</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.jakarta.xml.ws.handler.MessageContext"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface jakarta.xml.ws.handler.<a href="../../../../../jakarta/xml/ws/handler/MessageContext.html" title="interface in jakarta.xml.ws.handler">MessageContext</a></h3> |
| <code><a href="../../../../../jakarta/xml/ws/handler/MessageContext.Scope.html" title="enum in jakarta.xml.ws.handler">MessageContext.Scope</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.java.util.Map"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface java.util.Map</h3> |
| <code>java.util.Map.Entry<K,V></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.jakarta.xml.ws.handler.MessageContext"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface jakarta.xml.ws.handler.<a href="../../../../../jakarta/xml/ws/handler/MessageContext.html" title="interface in jakarta.xml.ws.handler">MessageContext</a></h3> |
| <code><a href="../../../../../jakarta/xml/ws/handler/MessageContext.html#HTTP_REQUEST_HEADERS">HTTP_REQUEST_HEADERS</a>, <a href="../../../../../jakarta/xml/ws/handler/MessageContext.html#HTTP_REQUEST_METHOD">HTTP_REQUEST_METHOD</a>, <a href="../../../../../jakarta/xml/ws/handler/MessageContext.html#HTTP_RESPONSE_CODE">HTTP_RESPONSE_CODE</a>, <a href="../../../../../jakarta/xml/ws/handler/MessageContext.html#HTTP_RESPONSE_HEADERS">HTTP_RESPONSE_HEADERS</a>, <a href="../../../../../jakarta/xml/ws/handler/MessageContext.html#INBOUND_MESSAGE_ATTACHMENTS">INBOUND_MESSAGE_ATTACHMENTS</a>, <a href="../../../../../jakarta/xml/ws/handler/MessageContext.html#MESSAGE_OUTBOUND_PROPERTY">MESSAGE_OUTBOUND_PROPERTY</a>, <a href="../../../../../jakarta/xml/ws/handler/MessageContext.html#OUTBOUND_MESSAGE_ATTACHMENTS">OUTBOUND_MESSAGE_ATTACHMENTS</a>, <a href="../../../../../jakarta/xml/ws/handler/MessageContext.html#PATH_INFO">PATH_INFO</a>, <a href="../../../../../jakarta/xml/ws/handler/MessageContext.html#QUERY_STRING">QUERY_STRING</a>, <a href="../../../../../jakarta/xml/ws/handler/MessageContext.html#REFERENCE_PARAMETERS">REFERENCE_PARAMETERS</a>, <a href="../../../../../jakarta/xml/ws/handler/MessageContext.html#SERVLET_CONTEXT">SERVLET_CONTEXT</a>, <a href="../../../../../jakarta/xml/ws/handler/MessageContext.html#SERVLET_REQUEST">SERVLET_REQUEST</a>, <a href="../../../../../jakarta/xml/ws/handler/MessageContext.html#SERVLET_RESPONSE">SERVLET_RESPONSE</a>, <a href="../../../../../jakarta/xml/ws/handler/MessageContext.html#WSDL_DESCRIPTION">WSDL_DESCRIPTION</a>, <a href="../../../../../jakarta/xml/ws/handler/MessageContext.html#WSDL_INTERFACE">WSDL_INTERFACE</a>, <a href="../../../../../jakarta/xml/ws/handler/MessageContext.html#WSDL_OPERATION">WSDL_OPERATION</a>, <a href="../../../../../jakarta/xml/ws/handler/MessageContext.html#WSDL_PORT">WSDL_PORT</a>, <a href="../../../../../jakarta/xml/ws/handler/MessageContext.html#WSDL_SERVICE">WSDL_SERVICE</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>java.lang.Object[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../jakarta/xml/ws/handler/soap/SOAPMessageContext.html#getHeaders-javax.xml.namespace.QName-jakarta.xml.bind.JAXBContext-boolean-">getHeaders</a></span>(javax.xml.namespace.QName header, |
| <a href="../../../../../jakarta/xml/bind/JAXBContext.html" title="class in jakarta.xml.bind">JAXBContext</a> context, |
| boolean allRoles)</code> |
| <div class="block">Gets headers that have a particular qualified name from the message in the |
| message context.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../jakarta/xml/soap/SOAPMessage.html" title="class in jakarta.xml.soap">SOAPMessage</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../jakarta/xml/ws/handler/soap/SOAPMessageContext.html#getMessage--">getMessage</a></span>()</code> |
| <div class="block">Gets the <code>SOAPMessage</code> from this message context.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.util.Set<java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../jakarta/xml/ws/handler/soap/SOAPMessageContext.html#getRoles--">getRoles</a></span>()</code> |
| <div class="block">Gets the SOAP actor roles associated with an execution |
| of the handler chain.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../jakarta/xml/ws/handler/soap/SOAPMessageContext.html#setMessage-jakarta.xml.soap.SOAPMessage-">setMessage</a></span>(<a href="../../../../../jakarta/xml/soap/SOAPMessage.html" title="class in jakarta.xml.soap">SOAPMessage</a> message)</code> |
| <div class="block">Sets the SOAPMessage in this message context</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.jakarta.xml.ws.handler.MessageContext"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface jakarta.xml.ws.handler.<a href="../../../../../jakarta/xml/ws/handler/MessageContext.html" title="interface in jakarta.xml.ws.handler">MessageContext</a></h3> |
| <code><a href="../../../../../jakarta/xml/ws/handler/MessageContext.html#getScope-java.lang.String-">getScope</a>, <a href="../../../../../jakarta/xml/ws/handler/MessageContext.html#setScope-java.lang.String-jakarta.xml.ws.handler.MessageContext.Scope-">setScope</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.util.Map"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface java.util.Map</h3> |
| <code>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</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getMessage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMessage</h4> |
| <pre><a href="../../../../../jakarta/xml/soap/SOAPMessage.html" title="class in jakarta.xml.soap">SOAPMessage</a> getMessage()</pre> |
| <div class="block">Gets the <code>SOAPMessage</code> from this message context. Modifications |
| to the returned <code>SOAPMessage</code> change the message in-place, there |
| is no need to subsequently call <code>setMessage</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns the <code>SOAPMessage</code>; returns <code>null</code> if no |
| <code>SOAPMessage</code> is present in this message context</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMessage-jakarta.xml.soap.SOAPMessage-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMessage</h4> |
| <pre>void setMessage(<a href="../../../../../jakarta/xml/soap/SOAPMessage.html" title="class in jakarta.xml.soap">SOAPMessage</a> message)</pre> |
| <div class="block">Sets the SOAPMessage in this message context</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>message</code> - SOAP message</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../jakarta/xml/ws/WebServiceException.html" title="class in jakarta.xml.ws">WebServiceException</a></code> - If any error during the setting |
| of the <code>SOAPMessage</code> in this message context</dd> |
| <dd><code>java.lang.UnsupportedOperationException</code> - If this |
| operation is not supported</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHeaders-javax.xml.namespace.QName-jakarta.xml.bind.JAXBContext-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeaders</h4> |
| <pre>java.lang.Object[] getHeaders(javax.xml.namespace.QName header, |
| <a href="../../../../../jakarta/xml/bind/JAXBContext.html" title="class in jakarta.xml.bind">JAXBContext</a> context, |
| boolean allRoles)</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>header</code> - The XML qualified name of the SOAP header(s).</dd> |
| <dd><code>context</code> - The JAXBContext that should be used to unmarshall the |
| header</dd> |
| <dd><code>allRoles</code> - If <code>true</code> then returns headers for all SOAP |
| roles, if <code>false</code> then only returns headers targetted |
| at the roles currently being played by this SOAP node, see |
| <code>getRoles</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>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.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../jakarta/xml/ws/WebServiceException.html" title="class in jakarta.xml.ws">WebServiceException</a></code> - If an error occurs when using the supplied |
| <code>JAXBContext</code> to unmarshall. The cause of |
| the <code>WebServiceException</code> is the original <code>JAXBException</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRoles--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getRoles</h4> |
| <pre>java.util.Set<java.lang.String> getRoles()</pre> |
| <div class="block">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 <a href="../../../../../jakarta/xml/ws/soap/SOAPBinding.html#setRoles-java.util.Set-"><code>SOAPBinding.setRoles(java.util.Set<java.lang.String>)</code></a> and |
| <a href="../../../../../jakarta/xml/ws/soap/SOAPBinding.html#getRoles--"><code>SOAPBinding.getRoles()</code></a>. <code>Handler</code> 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.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Array of <code>String</code> for SOAP actor roles</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../jakarta/xml/ws/handler/soap/SOAPHandler.html" title="interface in jakarta.xml.ws.handler.soap"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?jakarta/xml/ws/handler/soap/SOAPMessageContext.html" target="_top">Frames</a></li> |
| <li><a href="SOAPMessageContext.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
