http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/content/site/apidocs/org/apache/juneau/http/Host.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/http/Host.html b/content/site/apidocs/org/apache/juneau/http/Host.html new file mode 100644 index 0000000..1027a80 --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/http/Host.html @@ -0,0 +1,298 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Host (Apache Juneau (incubating) 6.2.1-incubating-SNAPSHOT)</title> +<link rel="stylesheet" type="text/css" href="../../../../javadoc.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="Host (Apache Juneau (incubating) 6.2.1-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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="../../../../org/apache/juneau/http/HeaderUri.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/http/Host.html" target="_top">Frames</a></li> +<li><a href="Host.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">org.apache.juneau.http</div> +<h2 title="Class Host" class="title">Class Host</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../org/apache/juneau/http/HeaderString.html" title="class in org.apache.juneau.http">org.apache.juneau.http.HeaderString</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.juneau.http.Host</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <a href="../../../../src-html/org/apache/juneau/http/Host.html#line.58">Host</a> +extends <a href="../../../../org/apache/juneau/http/HeaderString.html" title="class in org.apache.juneau.http">HeaderString</a></pre> +<div class="block">Represents a parsed <l>Host</l> HTTP request header. + <p> + The domain name of the server (for virtual hosting), and the TCP port number on which the server is listening. + The port number may be omitted if the port is the standard port for the service requested. + Mandatory since HTTP/1.1. + + <h6 class='figure'>Example</h6> + <p class='bcode'> + Host: en.wikipedia.org:8080 + Host: en.wikipedia.org + </p> + + <h6 class='topic'>RFC2616 Specification</h6> + + The Host request-header field specifies the Internet host and port number of the resource being requested, as + obtained from the original URI given by the user or referring resource (generally an HTTP URL, as described in + section 3.2.2). + The Host field value MUST represent the naming authority of the origin server or gateway given by the original URL. + This allows the origin server or gateway to differentiate between internally-ambiguous URLs, such as the root "/" URL + of a server for multiple host names on a single IP address. + <p class='bcode'> + Host = "Host" ":" host [ ":" port ] ; Section 3.2.2 + </p> + <p> + A "host" without any trailing port information implies the default port for the service requested (e.g., "80" for an + HTTP URL). + For example, a request on the origin server for <http://www.w3.org/pub/WWW/> would properly include: + <p class='bcode'> + GET /pub/WWW/ HTTP/1.1 + Host: www.w3.org + </p> + <p> + A client MUST include a Host header field in all HTTP/1.1 request messages. + If the requested URI does not include an Internet host name for the service being requested, then the Host header + field MUST be given with an empty value. + An HTTP/1.1 proxy MUST ensure that any request message it forwards does contain an appropriate Host header field that + identifies the service being requested by the proxy. + All Internet-based HTTP/1.1 servers MUST respond with a 400 (Bad Request) status code to any HTTP/1.1 request + message which lacks a Host header field. + <p> + See sections 5.2 and 19.6.1.1 for other requirements relating to Host.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>static <a href="../../../../org/apache/juneau/http/Host.html" title="class in org.apache.juneau.http">Host</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/Host.html#forString-java.lang.String-">forString</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> value)</code> +<div class="block">Returns a parsed <code>Host</code> header.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.http.HeaderString"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.juneau.http.<a href="../../../../org/apache/juneau/http/HeaderString.html" title="class in org.apache.juneau.http">HeaderString</a></h3> +<code><a href="../../../../org/apache/juneau/http/HeaderString.html#asString--">asString</a>, <a href="../../../../org/apache/juneau/http/HeaderString.html#eq-java.lang.String-">eq</a>, <a href="../../../../org/apache/juneau/http/HeaderString.html#eqIC-java.lang.String-">eqIC</a>, <a href="../../../../org/apache/juneau/http/HeaderString.html#toString--">toString</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></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="forString-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>forString</h4> +<pre>public static <a href="../../../../org/apache/juneau/http/Host.html" title="class in org.apache.juneau.http">Host</a> <a href="../../../../src-html/org/apache/juneau/http/Host.html#line.66">forString</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> value)</pre> +<div class="block">Returns a parsed <code>Host</code> header.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - The <code>Host</code> header string.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The parsed <code>Host</code> header, or <jk>null</jk> if the string was null.</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="../../../../org/apache/juneau/http/HeaderUri.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/http/Host.html" target="_top">Frames</a></li> +<li><a href="Host.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 ======= --> +<p class="legalCopy"><small>Copyright © 2017 <a href="http://www.apache.org/";>Apache</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/content/site/apidocs/org/apache/juneau/http/HttpMethod.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/http/HttpMethod.html b/content/site/apidocs/org/apache/juneau/http/HttpMethod.html new file mode 100644 index 0000000..d1484ea --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/http/HttpMethod.html @@ -0,0 +1,476 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>HttpMethod (Apache Juneau (incubating) 6.2.1-incubating-SNAPSHOT)</title> +<link rel="stylesheet" type="text/css" href="../../../../javadoc.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="HttpMethod (Apache Juneau (incubating) 6.2.1-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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="../../../../org/apache/juneau/http/Host.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/IfMatch.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/http/HttpMethod.html" target="_top">Frames</a></li> +<li><a href="HttpMethod.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><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </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">org.apache.juneau.http</div> +<h2 title="Enum HttpMethod" class="title">Enum HttpMethod</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http">HttpMethod</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.juneau.http.HttpMethod</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true"; title="class or interface in java.lang">Comparable</a><<a href="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http">HttpMethod</a>></dd> +</dl> +<hr> +<br> +<pre>public enum <a href="../../../../src-html/org/apache/juneau/http/HttpMethod.html#line.20">HttpMethod</a> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">Enum</a><<a href="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http">HttpMethod</a>></pre> +<div class="block">Represents valid HTTP 1.1 method names per the <a class='doclink' href='https://www.ietf.org/rfc/rfc2616.txt'>RFC 2616</a> spec.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/HttpMethod.html#CONNECT">CONNECT</a></span></code> +<div class="block"><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.9'>CONNECT</a></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/HttpMethod.html#DELETE">DELETE</a></span></code> +<div class="block"><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.7'>DELETE</a></div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/HttpMethod.html#GET">GET</a></span></code> +<div class="block"><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.3'>GET</a></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/HttpMethod.html#HEAD">HEAD</a></span></code> +<div class="block"><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.4'>HEAD</a></div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/HttpMethod.html#OPTIONS">OPTIONS</a></span></code> +<div class="block"><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.2'>OPTIONS</a></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/HttpMethod.html#OTHER">OTHER</a></span></code> +<div class="block">A non-standard value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/HttpMethod.html#POST">POST</a></span></code> +<div class="block"><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.5'>POST</a></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/HttpMethod.html#PUT">PUT</a></span></code> +<div class="block"><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.6'>PUT</a></div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/HttpMethod.html#TRACE">TRACE</a></span></code> +<div class="block"><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.8'>TRACE</a></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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>static <a href="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http">HttpMethod</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/HttpMethod.html#forString-java.lang.String-">forString</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> key)</code> +<div class="block">Returns the enum for the specified key.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http">HttpMethod</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/HttpMethod.html#valueOf-java.lang.String-">valueOf</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http">HttpMethod</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/HttpMethod.html#values--">values</a></span>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">Enum</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#compareTo-E-"; title="class or interface in java.lang">compareTo</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass--"; title="class or interface in java.lang">getDeclaringClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/ api/java/lang/Enum.html?is-external=true#name--" title="class or interface in java.lang">name</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#ordinal--"; title="class or interface in java.lang">ordinal</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-"; title="class or interface in java.lang">valueOf</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--"; title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="OPTIONS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OPTIONS</h4> +<pre>public static final <a href="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http">HttpMethod</a> <a href="../../../../src-html/org/apache/juneau/http/HttpMethod.html#line.23">OPTIONS</a></pre> +<div class="block"><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.2'>OPTIONS</a></div> +</li> +</ul> +<a name="GET"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>GET</h4> +<pre>public static final <a href="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http">HttpMethod</a> <a href="../../../../src-html/org/apache/juneau/http/HttpMethod.html#line.26">GET</a></pre> +<div class="block"><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.3'>GET</a></div> +</li> +</ul> +<a name="HEAD"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HEAD</h4> +<pre>public static final <a href="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http">HttpMethod</a> <a href="../../../../src-html/org/apache/juneau/http/HttpMethod.html#line.29">HEAD</a></pre> +<div class="block"><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.4'>HEAD</a></div> +</li> +</ul> +<a name="POST"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>POST</h4> +<pre>public static final <a href="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http">HttpMethod</a> <a href="../../../../src-html/org/apache/juneau/http/HttpMethod.html#line.32">POST</a></pre> +<div class="block"><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.5'>POST</a></div> +</li> +</ul> +<a name="PUT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PUT</h4> +<pre>public static final <a href="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http">HttpMethod</a> <a href="../../../../src-html/org/apache/juneau/http/HttpMethod.html#line.35">PUT</a></pre> +<div class="block"><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.6'>PUT</a></div> +</li> +</ul> +<a name="DELETE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DELETE</h4> +<pre>public static final <a href="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http">HttpMethod</a> <a href="../../../../src-html/org/apache/juneau/http/HttpMethod.html#line.38">DELETE</a></pre> +<div class="block"><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.7'>DELETE</a></div> +</li> +</ul> +<a name="TRACE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TRACE</h4> +<pre>public static final <a href="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http">HttpMethod</a> <a href="../../../../src-html/org/apache/juneau/http/HttpMethod.html#line.41">TRACE</a></pre> +<div class="block"><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.8'>TRACE</a></div> +</li> +</ul> +<a name="CONNECT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CONNECT</h4> +<pre>public static final <a href="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http">HttpMethod</a> <a href="../../../../src-html/org/apache/juneau/http/HttpMethod.html#line.44">CONNECT</a></pre> +<div class="block"><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.9'>CONNECT</a></div> +</li> +</ul> +<a name="OTHER"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>OTHER</h4> +<pre>public static final <a href="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http">HttpMethod</a> <a href="../../../../src-html/org/apache/juneau/http/HttpMethod.html#line.47">OTHER</a></pre> +<div class="block">A non-standard value.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http">HttpMethod</a>[] <a href="../../../../src-html/org/apache/juneau/http/HttpMethod.html#line.20">values</a>()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (HttpMethod c : HttpMethod.values()) + System.out.println(c); +</pre></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an array containing the constants of this enum type, in the order they are declared</dd> +</dl> +</li> +</ul> +<a name="valueOf-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http">HttpMethod</a> <a href="../../../../src-html/org/apache/juneau/http/HttpMethod.html#line.20">valueOf</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the enum constant with the specified name</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true"; title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd> +</dl> +</li> +</ul> +<a name="forString-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>forString</h4> +<pre>public static <a href="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http">HttpMethod</a> <a href="../../../../src-html/org/apache/juneau/http/HttpMethod.html#line.69">forString</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> key)</pre> +<div class="block">Returns the enum for the specified key. + <p> + Case is ignored.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>key</code> - The HTTP method name.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The HttpMethod enum, or <a href="../../../../org/apache/juneau/http/HttpMethod.html#OTHER"><code>OTHER</code></a> if it's not a standard method name.</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="../../../../org/apache/juneau/http/Host.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/IfMatch.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/http/HttpMethod.html" target="_top">Frames</a></li> +<li><a href="HttpMethod.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><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2017 <a href="http://www.apache.org/";>Apache</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/content/site/apidocs/org/apache/juneau/http/IfMatch.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/http/IfMatch.html b/content/site/apidocs/org/apache/juneau/http/IfMatch.html new file mode 100644 index 0000000..abf07fb --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/http/IfMatch.html @@ -0,0 +1,313 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>IfMatch (Apache Juneau (incubating) 6.2.1-incubating-SNAPSHOT)</title> +<link rel="stylesheet" type="text/css" href="../../../../javadoc.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="IfMatch (Apache Juneau (incubating) 6.2.1-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/IfModifiedSince.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/http/IfMatch.html" target="_top">Frames</a></li> +<li><a href="IfMatch.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">org.apache.juneau.http</div> +<h2 title="Class IfMatch" class="title">Class IfMatch</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../org/apache/juneau/http/HeaderEntityValidatorArray.html" title="class in org.apache.juneau.http">org.apache.juneau.http.HeaderEntityValidatorArray</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.juneau.http.IfMatch</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <a href="../../../../src-html/org/apache/juneau/http/IfMatch.html#line.73">IfMatch</a> +extends <a href="../../../../org/apache/juneau/http/HeaderEntityValidatorArray.html" title="class in org.apache.juneau.http">HeaderEntityValidatorArray</a></pre> +<div class="block">Represents a parsed <l>If-Match</l> HTTP request header. + <p> + Only perform the action if the client supplied entity matches the same entity on the server. + This is mainly for methods like PUT to only update a resource if it has not been modified since the user last + updated it. + + <h6 class='figure'>Example</h6> + <p class='bcode'> + If-Match: "737060cd8c284d8af7ad3082f209582d" + </p> + + <h6 class='topic'>RFC2616 Specification</h6> + + The If-Match request-header field is used with a method to make it conditional. + A client that has one or more entities previously obtained from the resource can verify that one of those entities + is current by including a list of their associated entity tags in the If-Match header field. + Entity tags are defined in section 3.11. + The purpose of this feature is to allow efficient updates of cached information with a minimum amount of transaction + overhead. + It is also used, on updating requests, to prevent inadvertent modification of the wrong version of a resource. + As a special case, the value "*" matches any current entity of the resource. + <p class='bcode'> + If-Match = "If-Match" ":" ( "*" | 1#entity-tag ) + </p> + <p> + If any of the entity tags match the entity tag of the entity that would have been returned in the response to a + similar GET request (without the If-Match header) on that resource, or if "*" is given and any current entity exists + for that resource, then the server MAY perform the requested method as if the If-Match header field did not exist. + <p> + A server MUST use the strong comparison function (see section 13.3.3) to compare the entity tags in If-Match. + <p> + If none of the entity tags match, or if "*" is given and no current entity exists, the server MUST NOT perform the + requested method, and MUST return a 412 (Precondition Failed) response. + This behavior is most useful when the client wants to prevent an updating method, such as PUT, from modifying a + resource that has changed since the client last retrieved it. + <p> + If the request would, without the If-Match header field, result in anything other than a 2xx or 412 status, then the + If-Match header MUST be ignored. + <p> + The meaning of "If-Match: *" is that the method SHOULD be performed if the representation selected by the origin + server (or by a cache, possibly using the Vary mechanism, see section 14.44) exists, and MUST NOT be performed if the + representation does not exist. + <p> + A request intended to update a resource (e.g., a PUT) MAY include an If-Match header field to signal that the request + method MUST NOT be applied if the entity corresponding to the If-Match value (a single entity tag) is no longer a + representation of that resource. + This allows the user to indicate that they do not wish the request to be successful if the resource has been changed + without their knowledge. + Examples: + <p class='bcode'> + If-Match: "xyzzy" + If-Match: "xyzzy", "r2d2xxxx", "c3piozzzz" + If-Match: * + </p> + The result of a request having both an If-Match header field and either an If-None-Match or an If-Modified-Since + header fields is undefined by this specification.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>static <a href="../../../../org/apache/juneau/http/IfMatch.html" title="class in org.apache.juneau.http">IfMatch</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/IfMatch.html#forString-java.lang.String-">forString</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> value)</code> +<div class="block">Returns a parsed <code>If-Match</code> header.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.http.HeaderEntityValidatorArray"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.juneau.http.<a href="../../../../org/apache/juneau/http/HeaderEntityValidatorArray.html" title="class in org.apache.juneau.http">HeaderEntityValidatorArray</a></h3> +<code><a href="../../../../org/apache/juneau/http/HeaderEntityValidatorArray.html#asValidators--">asValidators</a>, <a href="../../../../org/apache/juneau/http/HeaderEntityValidatorArray.html#toString--">toString</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></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="forString-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>forString</h4> +<pre>public static <a href="../../../../org/apache/juneau/http/IfMatch.html" title="class in org.apache.juneau.http">IfMatch</a> <a href="../../../../src-html/org/apache/juneau/http/IfMatch.html#line.81">forString</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> value)</pre> +<div class="block">Returns a parsed <code>If-Match</code> header.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - The <code>If-Match</code> header string.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The parsed <code>If-Match</code> header, or <jk>null</jk> if the string was null.</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="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/IfModifiedSince.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/http/IfMatch.html" target="_top">Frames</a></li> +<li><a href="IfMatch.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 ======= --> +<p class="legalCopy"><small>Copyright © 2017 <a href="http://www.apache.org/";>Apache</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/content/site/apidocs/org/apache/juneau/http/IfModifiedSince.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/http/IfModifiedSince.html b/content/site/apidocs/org/apache/juneau/http/IfModifiedSince.html new file mode 100644 index 0000000..686538c --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/http/IfModifiedSince.html @@ -0,0 +1,315 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>IfModifiedSince (Apache Juneau (incubating) 6.2.1-incubating-SNAPSHOT)</title> +<link rel="stylesheet" type="text/css" href="../../../../javadoc.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="IfModifiedSince (Apache Juneau (incubating) 6.2.1-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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="../../../../org/apache/juneau/http/IfMatch.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/IfNoneMatch.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/http/IfModifiedSince.html" target="_top">Frames</a></li> +<li><a href="IfModifiedSince.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">org.apache.juneau.http</div> +<h2 title="Class IfModifiedSince" class="title">Class IfModifiedSince</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../org/apache/juneau/http/HeaderDate.html" title="class in org.apache.juneau.http">org.apache.juneau.http.HeaderDate</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.juneau.http.IfModifiedSince</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <a href="../../../../src-html/org/apache/juneau/http/IfModifiedSince.html#line.75">IfModifiedSince</a> +extends <a href="../../../../org/apache/juneau/http/HeaderDate.html" title="class in org.apache.juneau.http">HeaderDate</a></pre> +<div class="block">Represents a parsed <l>If-Modified-Since</l> HTTP request header. + <p> + Allows a 304 Not Modified to be returned if content is unchanged. + + <h6 class='figure'>Example</h6> + <p class='bcode'> + If-Modified-Since: Sat, 29 Oct 1994 19:43:31 GMT + </p> + + <h6 class='topic'>RFC2616 Specification</h6> + + The If-Modified-Since request-header field is used with a method to make it conditional: + if the requested variant has not been modified since the time specified in this field, an entity will not be returned + from the server; instead, a 304 (not modified) response will be returned without any message-body. + <p class='bcode'> + If-Modified-Since = "If-Modified-Since" ":" HTTP-date + </p> + <p> + An example of the field is: + <p class='bcode'> + If-Modified-Since: Sat, 29 Oct 1994 19:43:31 GMT + </p> + <p> + A GET method with an If-Modified-Since header and no Range header requests that the identified entity be transferred + only if it has been modified since the date given by the If-Modified-Since header. + The algorithm for determining this includes the following cases: + <ol> + <li>If the request would normally result in anything other than a 200 (OK) status, or if the passed + If-Modified-Since date is invalid, the response is exactly the same as for a normal GET. + A date which is later than the server's current time is invalid. + <li>If the variant has been modified since the If-Modified-Since date, the response is exactly the same as for a + normal GET. + <li>If the variant has not been modified since a valid If-Modified-Since date, the server SHOULD return a 304 + (Not Modified) response. + </ol> + The purpose of this feature is to allow efficient updates of cached information with a minimum amount of transaction + overhead. + <p> + Note: The Range request-header field modifies the meaning of If-Modified-Since; see section 14.35 for full details. + <p> + Note: If-Modified-Since times are interpreted by the server, whose clock might not be synchronized with the client. + <p> + Note: When handling an If-Modified-Since header field, some servers will use an exact date comparison function, + rather than a less-than function, for deciding whether to send a 304 (Not Modified) response. + To get best results when sending an If-Modified-Since header field for cache validation, clients are + advised to use the exact date string received in a previous Last-Modified header field whenever possible. + <p> + Note: If a client uses an arbitrary date in the If-Modified-Since header instead of a date taken from the + Last-Modified header for the same request, the client should be aware of the fact that this date is interpreted in + the server's understanding of time. + The client should consider unsynchronized clocks and rounding problems due to the different encodings of time between + the client and server. + This includes the possibility of race conditions if the document has changed between the time it was first requested + and the If-Modified-Since date of a subsequent request, and the possibility of clock-skew-related problems if the + If-Modified-Since date is derived from the client's clock without correction to the server's clock. + Corrections for different time bases between client and server are at best approximate due to network latency. + The result of a request having both an If-Modified-Since header field and either an If-Match or an + If-Unmodified-Since header fields is undefined by this specification.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>static <a href="../../../../org/apache/juneau/http/IfModifiedSince.html" title="class in org.apache.juneau.http">IfModifiedSince</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/IfModifiedSince.html#forString-java.lang.String-">forString</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> value)</code> +<div class="block">Returns a parsed <code>If-Modified-Since</code> header.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.http.HeaderDate"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.juneau.http.<a href="../../../../org/apache/juneau/http/HeaderDate.html" title="class in org.apache.juneau.http">HeaderDate</a></h3> +<code><a href="../../../../org/apache/juneau/http/HeaderDate.html#asDate--">asDate</a>, <a href="../../../../org/apache/juneau/http/HeaderDate.html#toString--">toString</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></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="forString-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>forString</h4> +<pre>public static <a href="../../../../org/apache/juneau/http/IfModifiedSince.html" title="class in org.apache.juneau.http">IfModifiedSince</a> <a href="../../../../src-html/org/apache/juneau/http/IfModifiedSince.html#line.83">forString</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> value)</pre> +<div class="block">Returns a parsed <code>If-Modified-Since</code> header.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - The <code>If-Modified-Since</code> header string.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The parsed <code>If-Modified-Since</code> header, or <jk>null</jk> if the string was null.</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="../../../../org/apache/juneau/http/IfMatch.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/IfNoneMatch.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/http/IfModifiedSince.html" target="_top">Frames</a></li> +<li><a href="IfModifiedSince.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 ======= --> +<p class="legalCopy"><small>Copyright © 2017 <a href="http://www.apache.org/";>Apache</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/content/site/apidocs/org/apache/juneau/http/IfNoneMatch.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/http/IfNoneMatch.html b/content/site/apidocs/org/apache/juneau/http/IfNoneMatch.html new file mode 100644 index 0000000..eb53d35 --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/http/IfNoneMatch.html @@ -0,0 +1,318 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>IfNoneMatch (Apache Juneau (incubating) 6.2.1-incubating-SNAPSHOT)</title> +<link rel="stylesheet" type="text/css" href="../../../../javadoc.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="IfNoneMatch (Apache Juneau (incubating) 6.2.1-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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="../../../../org/apache/juneau/http/IfModifiedSince.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/IfRange.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/http/IfNoneMatch.html" target="_top">Frames</a></li> +<li><a href="IfNoneMatch.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">org.apache.juneau.http</div> +<h2 title="Class IfNoneMatch" class="title">Class IfNoneMatch</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../org/apache/juneau/http/HeaderEntityValidatorArray.html" title="class in org.apache.juneau.http">org.apache.juneau.http.HeaderEntityValidatorArray</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.juneau.http.IfNoneMatch</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <a href="../../../../src-html/org/apache/juneau/http/IfNoneMatch.html#line.78">IfNoneMatch</a> +extends <a href="../../../../org/apache/juneau/http/HeaderEntityValidatorArray.html" title="class in org.apache.juneau.http">HeaderEntityValidatorArray</a></pre> +<div class="block">Represents a parsed <l>If-None-Match</l> HTTP request header. + <p> + Allows a 304 Not Modified to be returned if content is unchanged. + + <h6 class='figure'>Example</h6> + <p class='bcode'> + If-None-Match: "737060cd8c284d8af7ad3082f209582d" + </p> + + <h6 class='topic'>RFC2616 Specification</h6> + + The If-None-Match request-header field is used with a method to make it conditional. + A client that has one or more entities previously obtained from the resource can verify that none of those entities + is current by including a list of their associated entity tags in the If-None-Match header field. + The purpose of this feature is to allow efficient updates of cached information with a minimum amount of transaction + overhead. + It is also used to prevent a method (e.g. PUT) from inadvertently modifying an existing resource when the client + believes that the resource does not exist. + <p> + As a special case, the value "*" matches any current entity of the resource. + <p class='bcode'> + If-None-Match = "If-None-Match" ":" ( "*" | 1#entity-tag ) + </p> + <p> + If any of the entity tags match the entity tag of the entity that would have been returned in the response to a + similar GET request (without the If-None-Match header) on that resource, or if "*" is given + and any current entity exists for that resource, then the server MUST NOT perform the requested method, unless + required to do so because the resource's modification date fails to match that supplied in an If-Modified-Since + header field in the request. + Instead, if the request method was GET or HEAD, the server SHOULD respond with a 304 (Not Modified) response, + including the cache- related header fields (particularly ETag) of one of the entities that matched. + For all other request methods, the server MUST respond with a status of 412 (Precondition Failed). + <p> + See section 13.3.3 for rules on how to determine if two entities tags match. + The weak comparison function can only be used with GET or HEAD requests. + <p> + If none of the entity tags match, then the server MAY perform the requested method as if the If-None-Match header + field did not exist, but MUST also ignore any If-Modified-Since header field(s) in the request. + That is, if no entity tags match, then the server MUST NOT return a 304 (Not Modified) response. + <p> + If the request would, without the If-None-Match header field, result in anything other than a 2xx or 304 status, + then the If-None-Match header MUST be ignored. + (See section 13.3.4 for a discussion of server behavior when both If-Modified-Since and If-None-Match appear in the + same request.) + <p> + The meaning of "If-None-Match: *" is that the method MUST NOT be performed if the representation selected by the + origin server (or by a cache, possibly using the Vary mechanism, see section 14.44) exists, and SHOULD be performed + if the representation does not exist. + This feature is intended to be useful in preventing races between PUT operations. + <p> + Examples: + <p class='bcode'> + If-None-Match: "xyzzy" + If-None-Match: W/"xyzzy" + If-None-Match: "xyzzy", "r2d2xxxx", "c3piozzzz" + If-None-Match: W/"xyzzy", W/"r2d2xxxx", W/"c3piozzzz" + If-None-Match: * + </p> + <p> + The result of a request having both an If-None-Match header field and either an If-Match or an If-Unmodified-Since + header fields is undefined by this specification.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>static <a href="../../../../org/apache/juneau/http/IfNoneMatch.html" title="class in org.apache.juneau.http">IfNoneMatch</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/IfNoneMatch.html#forString-java.lang.String-">forString</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> value)</code> +<div class="block">Returns a parsed <code>If-None-Match</code> header.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.http.HeaderEntityValidatorArray"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.juneau.http.<a href="../../../../org/apache/juneau/http/HeaderEntityValidatorArray.html" title="class in org.apache.juneau.http">HeaderEntityValidatorArray</a></h3> +<code><a href="../../../../org/apache/juneau/http/HeaderEntityValidatorArray.html#asValidators--">asValidators</a>, <a href="../../../../org/apache/juneau/http/HeaderEntityValidatorArray.html#toString--">toString</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></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="forString-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>forString</h4> +<pre>public static <a href="../../../../org/apache/juneau/http/IfNoneMatch.html" title="class in org.apache.juneau.http">IfNoneMatch</a> <a href="../../../../src-html/org/apache/juneau/http/IfNoneMatch.html#line.86">forString</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> value)</pre> +<div class="block">Returns a parsed <code>If-None-Match</code> header.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - The <code>If-None-Match</code> header string.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The parsed <code>If-None-Match</code> header, or <jk>null</jk> if the string was null.</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="../../../../org/apache/juneau/http/IfModifiedSince.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/IfRange.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/http/IfNoneMatch.html" target="_top">Frames</a></li> +<li><a href="IfNoneMatch.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 ======= --> +<p class="legalCopy"><small>Copyright © 2017 <a href="http://www.apache.org/";>Apache</a>. All rights reserved.</small></p> +</body> +</html>
