blob: 5d2b22ad5f2d9548e1f0ad8ade9f8d20eb229689 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>MessageContext</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="MessageContext";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":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/LogicalMessageContext.html" title="interface in jakarta.xml.ws.handler"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../jakarta/xml/ws/handler/MessageContext.Scope.html" title="enum in jakarta.xml.ws.handler"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?jakarta/xml/ws/handler/MessageContext.html" target="_top">Frames</a></li>
<li><a href="MessageContext.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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</div>
<h2 title="Interface MessageContext" class="title">Interface MessageContext</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>java.util.Map&lt;java.lang.String,java.lang.Object&gt;</dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../jakarta/xml/ws/handler/LogicalMessageContext.html" title="interface in jakarta.xml.ws.handler">LogicalMessageContext</a>, <a href="../../../../jakarta/xml/ws/handler/soap/SOAPMessageContext.html" title="interface in jakarta.xml.ws.handler.soap">SOAPMessageContext</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">MessageContext</span>
extends java.util.Map&lt;java.lang.String,java.lang.Object&gt;</pre>
<div class="block">The interface <code>MessageContext</code> abstracts the message
context that is processed by a handler in the <code>handle</code>
method.
<p>The <code>MessageContext</code> interface provides methods to
manage a property set. <code>MessageContext</code> properties
enable handlers in a handler chain to share processing related
state.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6, JAX-WS 2.0</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>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/handler/MessageContext.Scope.html" title="enum in jakarta.xml.ws.handler">MessageContext.Scope</a></span></code>
<div class="block">Property scope.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.java.util.Map">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;java.util.Map</h3>
<code>java.util.Map.Entry&lt;K,V&gt;</code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/handler/MessageContext.html#HTTP_REQUEST_HEADERS">HTTP_REQUEST_HEADERS</a></span></code>
<div class="block">Standard property: HTTP request headers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/handler/MessageContext.html#HTTP_REQUEST_METHOD">HTTP_REQUEST_METHOD</a></span></code>
<div class="block">Standard property: HTTP request method.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/handler/MessageContext.html#HTTP_RESPONSE_CODE">HTTP_RESPONSE_CODE</a></span></code>
<div class="block">Standard property: HTTP response status code.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/handler/MessageContext.html#HTTP_RESPONSE_HEADERS">HTTP_RESPONSE_HEADERS</a></span></code>
<div class="block">Standard property: HTTP response headers.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/handler/MessageContext.html#INBOUND_MESSAGE_ATTACHMENTS">INBOUND_MESSAGE_ATTACHMENTS</a></span></code>
<div class="block">Standard property: Map of attachments to a message for the inbound
message, key is the MIME Content-ID, value is a DataHandler.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/handler/MessageContext.html#MESSAGE_OUTBOUND_PROPERTY">MESSAGE_OUTBOUND_PROPERTY</a></span></code>
<div class="block">Standard property: message direction, <code>true</code> for
outbound messages, <code>false</code> for inbound.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/handler/MessageContext.html#OUTBOUND_MESSAGE_ATTACHMENTS">OUTBOUND_MESSAGE_ATTACHMENTS</a></span></code>
<div class="block">Standard property: Map of attachments to a message for the outbound
message, key is the MIME Content-ID, value is a DataHandler.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/handler/MessageContext.html#PATH_INFO">PATH_INFO</a></span></code>
<div class="block">Standard property: Request Path Info</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/handler/MessageContext.html#QUERY_STRING">QUERY_STRING</a></span></code>
<div class="block">Standard property: Query string for request.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/handler/MessageContext.html#REFERENCE_PARAMETERS">REFERENCE_PARAMETERS</a></span></code>
<div class="block">Standard property: WS Addressing Reference Parameters.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/handler/MessageContext.html#SERVLET_CONTEXT">SERVLET_CONTEXT</a></span></code>
<div class="block">Standard property: servlet context object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/handler/MessageContext.html#SERVLET_REQUEST">SERVLET_REQUEST</a></span></code>
<div class="block">Standard property: servlet request object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/handler/MessageContext.html#SERVLET_RESPONSE">SERVLET_RESPONSE</a></span></code>
<div class="block">Standard property: servlet response object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/handler/MessageContext.html#WSDL_DESCRIPTION">WSDL_DESCRIPTION</a></span></code>
<div class="block">Standard property: input source for WSDL document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/handler/MessageContext.html#WSDL_INTERFACE">WSDL_INTERFACE</a></span></code>
<div class="block">Standard property: name of wsdl interface (2.0) or port type (1.1).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/handler/MessageContext.html#WSDL_OPERATION">WSDL_OPERATION</a></span></code>
<div class="block">Standard property: name of WSDL operation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/handler/MessageContext.html#WSDL_PORT">WSDL_PORT</a></span></code>
<div class="block">Standard property: name of WSDL port.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/handler/MessageContext.html#WSDL_SERVICE">WSDL_SERVICE</a></span></code>
<div class="block">Standard property: name of WSDL service.</div>
</td>
</tr>
</table>
</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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><a href="../../../../jakarta/xml/ws/handler/MessageContext.Scope.html" title="enum in jakarta.xml.ws.handler">MessageContext.Scope</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/handler/MessageContext.html#getScope-java.lang.String-">getScope</a></span>(java.lang.String&nbsp;name)</code>
<div class="block">Gets the scope of a property.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/handler/MessageContext.html#setScope-java.lang.String-jakarta.xml.ws.handler.MessageContext.Scope-">setScope</a></span>(java.lang.String&nbsp;name,
<a href="../../../../jakarta/xml/ws/handler/MessageContext.Scope.html" title="enum in jakarta.xml.ws.handler">MessageContext.Scope</a>&nbsp;scope)</code>
<div class="block">Sets the scope of a property.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.util.Map">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="MESSAGE_OUTBOUND_PROPERTY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MESSAGE_OUTBOUND_PROPERTY</h4>
<pre>static final&nbsp;java.lang.String MESSAGE_OUTBOUND_PROPERTY</pre>
<div class="block">Standard property: message direction, <code>true</code> for
outbound messages, <code>false</code> for inbound.
<p>Type: boolean</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#jakarta.xml.ws.handler.MessageContext.MESSAGE_OUTBOUND_PROPERTY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="INBOUND_MESSAGE_ATTACHMENTS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INBOUND_MESSAGE_ATTACHMENTS</h4>
<pre>static final&nbsp;java.lang.String INBOUND_MESSAGE_ATTACHMENTS</pre>
<div class="block">Standard property: Map of attachments to a message for the inbound
message, key is the MIME Content-ID, value is a DataHandler.
<p>Type: <code>java.util.Map&lt;String, DataHandler&gt;</code></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#jakarta.xml.ws.handler.MessageContext.INBOUND_MESSAGE_ATTACHMENTS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="OUTBOUND_MESSAGE_ATTACHMENTS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OUTBOUND_MESSAGE_ATTACHMENTS</h4>
<pre>static final&nbsp;java.lang.String OUTBOUND_MESSAGE_ATTACHMENTS</pre>
<div class="block">Standard property: Map of attachments to a message for the outbound
message, key is the MIME Content-ID, value is a DataHandler.
<p>Type: <code>java.util.Map&lt;String, DataHandler&gt;</code></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#jakarta.xml.ws.handler.MessageContext.OUTBOUND_MESSAGE_ATTACHMENTS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="WSDL_DESCRIPTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WSDL_DESCRIPTION</h4>
<pre>static final&nbsp;java.lang.String WSDL_DESCRIPTION</pre>
<div class="block">Standard property: input source for WSDL document.
<p>Type: org.xml.sax.InputSource</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#jakarta.xml.ws.handler.MessageContext.WSDL_DESCRIPTION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="WSDL_SERVICE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WSDL_SERVICE</h4>
<pre>static final&nbsp;java.lang.String WSDL_SERVICE</pre>
<div class="block">Standard property: name of WSDL service.
<p>Type: javax.xml.namespace.QName</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#jakarta.xml.ws.handler.MessageContext.WSDL_SERVICE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="WSDL_PORT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WSDL_PORT</h4>
<pre>static final&nbsp;java.lang.String WSDL_PORT</pre>
<div class="block">Standard property: name of WSDL port.
<p>Type: javax.xml.namespace.QName</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#jakarta.xml.ws.handler.MessageContext.WSDL_PORT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="WSDL_INTERFACE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WSDL_INTERFACE</h4>
<pre>static final&nbsp;java.lang.String WSDL_INTERFACE</pre>
<div class="block">Standard property: name of wsdl interface (2.0) or port type (1.1).
<p>Type: javax.xml.namespace.QName</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#jakarta.xml.ws.handler.MessageContext.WSDL_INTERFACE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="WSDL_OPERATION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WSDL_OPERATION</h4>
<pre>static final&nbsp;java.lang.String WSDL_OPERATION</pre>
<div class="block">Standard property: name of WSDL operation.
<p>Type: javax.xml.namespace.QName</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#jakarta.xml.ws.handler.MessageContext.WSDL_OPERATION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="HTTP_RESPONSE_CODE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HTTP_RESPONSE_CODE</h4>
<pre>static final&nbsp;java.lang.String HTTP_RESPONSE_CODE</pre>
<div class="block">Standard property: HTTP response status code.
<p>Type: java.lang.Integer</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#jakarta.xml.ws.handler.MessageContext.HTTP_RESPONSE_CODE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="HTTP_REQUEST_HEADERS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HTTP_REQUEST_HEADERS</h4>
<pre>static final&nbsp;java.lang.String HTTP_REQUEST_HEADERS</pre>
<div class="block">Standard property: HTTP request headers.
<p>Type: <code>java.util.Map&lt;java.lang.String, java.util.List&lt;java.lang.String&gt;&gt;</code></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#jakarta.xml.ws.handler.MessageContext.HTTP_REQUEST_HEADERS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="HTTP_RESPONSE_HEADERS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HTTP_RESPONSE_HEADERS</h4>
<pre>static final&nbsp;java.lang.String HTTP_RESPONSE_HEADERS</pre>
<div class="block">Standard property: HTTP response headers.
<p>Type: <code>java.util.Map&lt;java.lang.String, java.util.List&lt;java.lang.String&gt;&gt;</code></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#jakarta.xml.ws.handler.MessageContext.HTTP_RESPONSE_HEADERS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="HTTP_REQUEST_METHOD">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HTTP_REQUEST_METHOD</h4>
<pre>static final&nbsp;java.lang.String HTTP_REQUEST_METHOD</pre>
<div class="block">Standard property: HTTP request method.
<p>Type: java.lang.String</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#jakarta.xml.ws.handler.MessageContext.HTTP_REQUEST_METHOD">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="SERVLET_REQUEST">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SERVLET_REQUEST</h4>
<pre>static final&nbsp;java.lang.String SERVLET_REQUEST</pre>
<div class="block">Standard property: servlet request object.
<p>Type: javax.servlet.http.HttpServletRequest</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#jakarta.xml.ws.handler.MessageContext.SERVLET_REQUEST">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="SERVLET_RESPONSE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SERVLET_RESPONSE</h4>
<pre>static final&nbsp;java.lang.String SERVLET_RESPONSE</pre>
<div class="block">Standard property: servlet response object.
<p>Type: javax.servlet.http.HttpServletResponse</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#jakarta.xml.ws.handler.MessageContext.SERVLET_RESPONSE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="SERVLET_CONTEXT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SERVLET_CONTEXT</h4>
<pre>static final&nbsp;java.lang.String SERVLET_CONTEXT</pre>
<div class="block">Standard property: servlet context object.
<p>Type: javax.servlet.ServletContext</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#jakarta.xml.ws.handler.MessageContext.SERVLET_CONTEXT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="QUERY_STRING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>QUERY_STRING</h4>
<pre>static final&nbsp;java.lang.String QUERY_STRING</pre>
<div class="block">Standard property: Query string for request.
<p>Type: String</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#jakarta.xml.ws.handler.MessageContext.QUERY_STRING">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PATH_INFO">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PATH_INFO</h4>
<pre>static final&nbsp;java.lang.String PATH_INFO</pre>
<div class="block">Standard property: Request Path Info
<p>Type: String</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#jakarta.xml.ws.handler.MessageContext.PATH_INFO">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="REFERENCE_PARAMETERS">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>REFERENCE_PARAMETERS</h4>
<pre>static final&nbsp;java.lang.String REFERENCE_PARAMETERS</pre>
<div class="block">Standard property: WS Addressing Reference Parameters.
The list MUST include all SOAP headers marked with the
wsa:IsReferenceParameter="true" attribute.
<p>Type: <code>List&lt;Element&gt;</code></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6, JAX-WS 2.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#jakarta.xml.ws.handler.MessageContext.REFERENCE_PARAMETERS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setScope-java.lang.String-jakarta.xml.ws.handler.MessageContext.Scope-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setScope</h4>
<pre>void&nbsp;setScope(java.lang.String&nbsp;name,
<a href="../../../../jakarta/xml/ws/handler/MessageContext.Scope.html" title="enum in jakarta.xml.ws.handler">MessageContext.Scope</a>&nbsp;scope)</pre>
<div class="block">Sets the scope of a property.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Name of the property associated with the
<code>MessageContext</code></dd>
<dd><code>scope</code> - Desired scope of the property</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if an illegal
property name is specified</dd>
</dl>
</li>
</ul>
<a name="getScope-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getScope</h4>
<pre><a href="../../../../jakarta/xml/ws/handler/MessageContext.Scope.html" title="enum in jakarta.xml.ws.handler">MessageContext.Scope</a>&nbsp;getScope(java.lang.String&nbsp;name)</pre>
<div class="block">Gets the scope of a property.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Name of the property</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Scope of the property</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if a non-existant
property name is specified</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/LogicalMessageContext.html" title="interface in jakarta.xml.ws.handler"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../jakarta/xml/ws/handler/MessageContext.Scope.html" title="enum in jakarta.xml.ws.handler"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?jakarta/xml/ws/handler/MessageContext.html" target="_top">Frames</a></li>
<li><a href="MessageContext.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>