blob: 0e289c3117685258c46b6d18913e9e10921caf06 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.2) on Wed Sep 23 17:36:24 GMT 2020 -->
<title>ContainerRequestContext (jakarta.ws.rs-api 3.0.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-09-23">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ContainerRequestContext (jakarta.ws.rs-api 3.0.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":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";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ContainerRequestContext.html">Use</a></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" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">jakarta.ws.rs.container</a></div>
<h2 title="Interface ContainerRequestContext" class="title">Interface ContainerRequestContext</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public interface <span class="typeNameLabel">ContainerRequestContext</span></pre>
<div class="block">Container request filter context.
A mutable class that provides request-specific information for the filter, such as request URI, message headers,
message entity or request-scoped properties. The exposed setters allow modification of the exposed request-specific
information.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Marek Potociar</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#abortWith(jakarta.ws.rs.core.Response)">abortWith</a></span>&#8203;(<a href="../core/Response.html" title="class in jakarta.ws.rs.core">Response</a>&nbsp;response)</code></th>
<td class="colLast">
<div class="block">Abort the filter chain with a response.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util" class="externalLink">Locale</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAcceptableLanguages()">getAcceptableLanguages</a></span>()</code></th>
<td class="colLast">
<div class="block">Get a list of languages that are acceptable for the response.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="../core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAcceptableMediaTypes()">getAcceptableMediaTypes</a></span>()</code></th>
<td class="colLast">
<div class="block">Get a list of media types that are acceptable for the response.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="../core/Cookie.html" title="class in jakarta.ws.rs.core">Cookie</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCookies()">getCookies</a></span>()</code></th>
<td class="colLast">
<div class="block">Get any cookies that accompanied the request.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink">Date</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDate()">getDate</a></span>()</code></th>
<td class="colLast">
<div class="block">Get message date.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEntityStream()">getEntityStream</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the entity input stream.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../core/MultivaluedMap.html" title="interface in jakarta.ws.rs.core">MultivaluedMap</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeaders()">getHeaders</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the mutable request headers multivalued map.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeaderString(java.lang.String)">getHeaderString</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Get a message header as a single string value.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util" class="externalLink">Locale</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLanguage()">getLanguage</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the language of the entity.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLength()">getLength</a></span>()</code></th>
<td class="colLast">
<div class="block">Get Content-Length value.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMediaType()">getMediaType</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the media type of the entity.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMethod()">getMethod</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the request method.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProperty(java.lang.String)">getProperty</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Returns the property with the given name registered in the current request/response exchange context, or <code>null</code>
if there is no property by that name.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPropertyNames()">getPropertyNames</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns an immutable <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>collection</code></a> containing the property names available within the
context of the current request/response exchange context.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../core/Request.html" title="interface in jakarta.ws.rs.core">Request</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRequest()">getRequest</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the injectable request information.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../core/SecurityContext.html" title="interface in jakarta.ws.rs.core">SecurityContext</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSecurityContext()">getSecurityContext</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the injectable security context information for the current request.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../core/UriInfo.html" title="interface in jakarta.ws.rs.core">UriInfo</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUriInfo()">getUriInfo</a></span>()</code></th>
<td class="colLast">
<div class="block">Get request URI information.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasEntity()">hasEntity</a></span>()</code></th>
<td class="colLast">
<div class="block">Check if there is a non-empty entity input stream available in the request message.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeProperty(java.lang.String)">removeProperty</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Removes a property with the given name from the current request/response exchange context.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEntityStream(java.io.InputStream)">setEntityStream</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a>&nbsp;input)</code></th>
<td class="colLast">
<div class="block">Set a new entity input stream.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMethod(java.lang.String)">setMethod</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;method)</code></th>
<td class="colLast">
<div class="block">Set the request method.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setProperty(java.lang.String,java.lang.Object)">setProperty</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;object)</code></th>
<td class="colLast">
<div class="block">Binds an object to a given property name in the current request/response exchange context.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRequestUri(java.net.URI)">setRequestUri</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a>&nbsp;requestUri)</code></th>
<td class="colLast">
<div class="block">Set a new request URI using the current base URI of the application to resolve the application-specific request URI
part.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRequestUri(java.net.URI,java.net.URI)">setRequestUri</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a>&nbsp;baseUri,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a>&nbsp;requestUri)</code></th>
<td class="colLast">
<div class="block">Set a new request URI using a new base URI to resolve the application-specific request URI part.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSecurityContext(jakarta.ws.rs.core.SecurityContext)">setSecurityContext</a></span>&#8203;(<a href="../core/SecurityContext.html" title="interface in jakarta.ws.rs.core">SecurityContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">Set a new injectable security context information for the current request.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getProperty(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProperty</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;getProperty&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</pre>
<div class="block">Returns the property with the given name registered in the current request/response exchange context, or <code>null</code>
if there is no property by that name.
<p>
A property allows a JAX-RS filters and interceptors to exchange additional custom information not already provided by
this interface.
</p>
<p>
A list of supported properties can be retrieved using <a href="#getPropertyNames()"><code>getPropertyNames()</code></a>. Custom property names should
follow the same convention as package names.
</p>
<p>
In a Servlet container, the properties are synchronized with the <code>ServletRequest</code> and expose all the attributes
available in the <code>ServletRequest</code>. Any modifications of the properties are also reflected in the set of
properties of the associated <code>ServletRequest</code>.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - a <code>String</code> specifying the name of the property.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an <code>Object</code> containing the value of the property, or <code>null</code> if no property exists matching the
given name.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#getPropertyNames()"><code>getPropertyNames()</code></a></dd>
</dl>
</li>
</ul>
<a id="getPropertyNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPropertyNames</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;&nbsp;getPropertyNames()</pre>
<div class="block">Returns an immutable <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>collection</code></a> containing the property names available within the
context of the current request/response exchange context.
<p>
Use the <a href="#getProperty(java.lang.String)"><code>getProperty(java.lang.String)</code></a> method with a property name to get the value of a property.
</p>
<p>
In a Servlet container, the properties are synchronized with the <code>ServletRequest</code> and expose all the attributes
available in the <code>ServletRequest</code>. Any modifications of the properties are also reflected in the set of
properties of the associated <code>ServletRequest</code>.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an immutable <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>collection</code></a> of property names.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#getProperty(java.lang.String)"><code>getProperty(java.lang.String)</code></a></dd>
</dl>
</li>
</ul>
<a id="setProperty(java.lang.String,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProperty</h4>
<pre class="methodSignature">void&nbsp;setProperty&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;object)</pre>
<div class="block">Binds an object to a given property name in the current request/response exchange context. If the name specified is
already used for a property, this method will replace the value of the property with the new value.
<p>
A property allows a JAX-RS filters and interceptors to exchange additional custom information not already provided by
this interface.
</p>
<p>
A list of supported properties can be retrieved using <a href="#getPropertyNames()"><code>getPropertyNames()</code></a>. Custom property names should
follow the same convention as package names.
</p>
<p>
If a <code>null</code> value is passed, the effect is the same as calling the <a href="#removeProperty(java.lang.String)"><code>removeProperty(String)</code></a> method.
</p>
<p>
In a Servlet container, the properties are synchronized with the <code>ServletRequest</code> and expose all the attributes
available in the <code>ServletRequest</code>. Any modifications of the properties are also reflected in the set of
properties of the associated <code>ServletRequest</code>.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - a <code>String</code> specifying the name of the property.</dd>
<dd><code>object</code> - an <code>Object</code> representing the property to be bound.</dd>
</dl>
</li>
</ul>
<a id="removeProperty(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeProperty</h4>
<pre class="methodSignature">void&nbsp;removeProperty&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</pre>
<div class="block">Removes a property with the given name from the current request/response exchange context. After removal, subsequent
calls to <a href="#getProperty(java.lang.String)"><code>getProperty(java.lang.String)</code></a> to retrieve the property value will return <code>null</code>.
<p>
In a Servlet container, the properties are synchronized with the <code>ServletRequest</code> and expose all the attributes
available in the <code>ServletRequest</code>. Any modifications of the properties are also reflected in the set of
properties of the associated <code>ServletRequest</code>.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - a <code>String</code> specifying the name of the property to be removed.</dd>
</dl>
</li>
</ul>
<a id="getUriInfo()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUriInfo</h4>
<pre class="methodSignature"><a href="../core/UriInfo.html" title="interface in jakarta.ws.rs.core">UriInfo</a>&nbsp;getUriInfo()</pre>
<div class="block">Get request URI information.
The returned object contains "live" view of the request URI information in a sense that any changes made to the
request URI using one of the <code>setRequestUri(...)</code> methods will be reflected in the previously returned
<a href="../core/UriInfo.html" title="interface in jakarta.ws.rs.core"><code>UriInfo</code></a> instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>request URI information.</dd>
</dl>
</li>
</ul>
<a id="setRequestUri(java.net.URI)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRequestUri</h4>
<pre class="methodSignature">void&nbsp;setRequestUri&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a>&nbsp;requestUri)</pre>
<div class="block">Set a new request URI using the current base URI of the application to resolve the application-specific request URI
part.
<p>
Note that the method is usable only in pre-matching filters, prior to the resource matching occurs. Trying to invoke
the method in a filter bound to a resource method results in an <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>IllegalStateException</code></a> being thrown.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>requestUri</code> - new URI of the request.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - in case the method is not invoked from a <a href="PreMatching.html" title="annotation in jakarta.ws.rs.container"><code>pre-matching</code></a> request
filter.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#setRequestUri(java.net.URI,java.net.URI)"><code>setRequestUri(java.net.URI, java.net.URI)</code></a></dd>
</dl>
</li>
</ul>
<a id="setRequestUri(java.net.URI,java.net.URI)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRequestUri</h4>
<pre class="methodSignature">void&nbsp;setRequestUri&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a>&nbsp;baseUri,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a>&nbsp;requestUri)</pre>
<div class="block">Set a new request URI using a new base URI to resolve the application-specific request URI part.
<p>
Note that the method is usable only in pre-matching filters, prior to the resource matching occurs. Trying to invoke
the method in a filter bound to a resource method results in an <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>IllegalStateException</code></a> being thrown.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>baseUri</code> - base URI that will be used to resolve the application-specific part of the request URI.</dd>
<dd><code>requestUri</code> - new URI of the request.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - in case the method is not invoked from a <a href="PreMatching.html" title="annotation in jakarta.ws.rs.container"><code>pre-matching</code></a> request
filter.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#setRequestUri(java.net.URI)"><code>setRequestUri(java.net.URI)</code></a></dd>
</dl>
</li>
</ul>
<a id="getRequest()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequest</h4>
<pre class="methodSignature"><a href="../core/Request.html" title="interface in jakarta.ws.rs.core">Request</a>&nbsp;getRequest()</pre>
<div class="block">Get the injectable request information.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>injectable request information.</dd>
</dl>
</li>
</ul>
<a id="getMethod()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMethod</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getMethod()</pre>
<div class="block">Get the request method.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the request method.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../HttpMethod.html" title="annotation in jakarta.ws.rs"><code>HttpMethod</code></a></dd>
</dl>
</li>
</ul>
<a id="setMethod(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMethod</h4>
<pre class="methodSignature">void&nbsp;setMethod&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;method)</pre>
<div class="block">Set the request method.
<p>
Note that the method is usable only in pre-matching filters, prior to the resource matching occurs. Trying to invoke
the method in a filter bound to a resource method results in an <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>IllegalStateException</code></a> being thrown.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>method</code> - new request method.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - in case the method is not invoked from a <a href="PreMatching.html" title="annotation in jakarta.ws.rs.container"><code>pre-matching</code></a> request
filter.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../HttpMethod.html" title="annotation in jakarta.ws.rs"><code>HttpMethod</code></a></dd>
</dl>
</li>
</ul>
<a id="getHeaders()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeaders</h4>
<pre class="methodSignature"><a href="../core/MultivaluedMap.html" title="interface in jakarta.ws.rs.core">MultivaluedMap</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;&nbsp;getHeaders()</pre>
<div class="block">Get the mutable request headers multivalued map.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>mutable multivalued map of request headers.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#getHeaderString(java.lang.String)"><code>getHeaderString(String)</code></a></dd>
</dl>
</li>
</ul>
<a id="getHeaderString(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeaderString</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getHeaderString&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</pre>
<div class="block">Get a message header as a single string value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the message header.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the message header value. If the message header is not present then <code>null</code> is returned. If the message
header is present but has no value then the empty string is returned. If the message header is present more than once
then the values of joined together and separated by a ',' character.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#getHeaders()"><code>getHeaders()</code></a></dd>
</dl>
</li>
</ul>
<a id="getDate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDate</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink">Date</a>&nbsp;getDate()</pre>
<div class="block">Get message date.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the message date, otherwise <code>null</code> if not present.</dd>
</dl>
</li>
</ul>
<a id="getLanguage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLanguage</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util" class="externalLink">Locale</a>&nbsp;getLanguage()</pre>
<div class="block">Get the language of the entity.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the language of the entity or <code>null</code> if not specified</dd>
</dl>
</li>
</ul>
<a id="getLength()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLength</h4>
<pre class="methodSignature">int&nbsp;getLength()</pre>
<div class="block">Get Content-Length value.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Content-Length as integer if present and valid number. In other cases returns <code>-1</code>.</dd>
</dl>
</li>
</ul>
<a id="getMediaType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMediaType</h4>
<pre class="methodSignature"><a href="../core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a>&nbsp;getMediaType()</pre>
<div class="block">Get the media type of the entity.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the media type or <code>null</code> if not specified (e.g. there's no request entity).</dd>
</dl>
</li>
</ul>
<a id="getAcceptableMediaTypes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAcceptableMediaTypes</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="../core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a>&gt;&nbsp;getAcceptableMediaTypes()</pre>
<div class="block">Get a list of media types that are acceptable for the response.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a read-only list of requested response media types sorted according to their q-value, with highest preference
first.</dd>
</dl>
</li>
</ul>
<a id="getAcceptableLanguages()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAcceptableLanguages</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util" class="externalLink">Locale</a>&gt;&nbsp;getAcceptableLanguages()</pre>
<div class="block">Get a list of languages that are acceptable for the response.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a read-only list of acceptable languages sorted according to their q-value, with highest preference first.</dd>
</dl>
</li>
</ul>
<a id="getCookies()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCookies</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="../core/Cookie.html" title="class in jakarta.ws.rs.core">Cookie</a>&gt;&nbsp;getCookies()</pre>
<div class="block">Get any cookies that accompanied the request.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a read-only map of cookie name (String) to <a href="../core/Cookie.html" title="class in jakarta.ws.rs.core"><code>Cookie</code></a>.</dd>
</dl>
</li>
</ul>
<a id="hasEntity()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasEntity</h4>
<pre class="methodSignature">boolean&nbsp;hasEntity()</pre>
<div class="block">Check if there is a non-empty entity input stream available in the request message.
The method returns <code>true</code> if the entity is present, returns <code>false</code> otherwise.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if there is an entity present in the message, <code>false</code> otherwise.</dd>
</dl>
</li>
</ul>
<a id="getEntityStream()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntityStream</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a>&nbsp;getEntityStream()</pre>
<div class="block">Get the entity input stream. The JAX-RS runtime is responsible for closing the input stream.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>entity input stream.</dd>
</dl>
</li>
</ul>
<a id="setEntityStream(java.io.InputStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEntityStream</h4>
<pre class="methodSignature">void&nbsp;setEntityStream&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a>&nbsp;input)</pre>
<div class="block">Set a new entity input stream. The JAX-RS runtime is responsible for closing the input stream.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>input</code> - new entity input stream.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - in case the method is invoked from a response filter.</dd>
</dl>
</li>
</ul>
<a id="getSecurityContext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSecurityContext</h4>
<pre class="methodSignature"><a href="../core/SecurityContext.html" title="interface in jakarta.ws.rs.core">SecurityContext</a>&nbsp;getSecurityContext()</pre>
<div class="block">Get the injectable security context information for the current request.
The <a href="../core/SecurityContext.html#getUserPrincipal()"><code>SecurityContext.getUserPrincipal()</code></a> must return <code>null</code> if the current request has not been
authenticated.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>injectable request security context information.</dd>
</dl>
</li>
</ul>
<a id="setSecurityContext(jakarta.ws.rs.core.SecurityContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSecurityContext</h4>
<pre class="methodSignature">void&nbsp;setSecurityContext&#8203;(<a href="../core/SecurityContext.html" title="interface in jakarta.ws.rs.core">SecurityContext</a>&nbsp;context)</pre>
<div class="block">Set a new injectable security context information for the current request.
The <a href="../core/SecurityContext.html#getUserPrincipal()"><code>SecurityContext.getUserPrincipal()</code></a> must return <code>null</code> if the current request has not been
authenticated.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - new injectable request security context information.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - in case the method is invoked from a response filter.</dd>
</dl>
</li>
</ul>
<a id="abortWith(jakarta.ws.rs.core.Response)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>abortWith</h4>
<pre class="methodSignature">void&nbsp;abortWith&#8203;(<a href="../core/Response.html" title="class in jakarta.ws.rs.core">Response</a>&nbsp;response)</pre>
<div class="block">Abort the filter chain with a response.
This method breaks the filter chain processing and returns the provided response back to the client. The provided
response goes through the chain of applicable response filters.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>response</code> - response to be sent back to the client.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - in case the method is invoked from a response filter.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ContainerRequestContext.html">Use</a></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" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small><p align="left">Copyright &#169; 2018, 2020 Eclipse Foundation.<br>Use is subject to <a href="../../../../resources/EFSL.html" target="_top">license terms</a>.</small></p>
</footer>
</body>
</html>