blob: 86a2b29f4531f55784c65fa216ab7f4cd8d16998 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.13) on Tue Feb 08 12:40:05 CST 2022 -->
<title>HttpCookie (Eclipse Jetty API Doc - v10.0.8)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-02-08">
<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.5.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="HttpCookie (Eclipse Jetty API Doc - v10.0.8)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":9,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":9,"i12":9,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":9,"i19":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/HttpCookie.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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">org.eclipse.jetty.http</a></div>
<h2 title="Class HttpCookie" class="title">Class HttpCookie</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.http.HttpCookie</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">HttpCookie</span>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="HttpCookie.SameSite.html" title="enum in org.eclipse.jetty.http">HttpCookie.SameSite</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="HttpCookie.SetCookieHttpField.html" title="class in org.eclipse.jetty.http">HttpCookie.SetCookieHttpField</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HTTP_ONLY_COMMENT">HTTP_ONLY_COMMENT</a></span></code></th>
<td class="colLast">
<div class="block">If this string is found within the comment parsed with <a href="#isHttpOnlyInComment(java.lang.String)"><code>isHttpOnlyInComment(String)</code></a> the check will return true</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SAME_SITE_DEFAULT_ATTRIBUTE">SAME_SITE_DEFAULT_ATTRIBUTE</a></span></code></th>
<td class="colLast">
<div class="block">Name of context attribute with default SameSite cookie value</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SAME_SITE_LAX_COMMENT">SAME_SITE_LAX_COMMENT</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SAME_SITE_NONE_COMMENT">SAME_SITE_NONE_COMMENT</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SAME_SITE_STRICT_COMMENT">SAME_SITE_STRICT_COMMENT</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String)">HttpCookie</a></span>&#8203;(java.lang.String&nbsp;setCookie)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,java.lang.String)">HttpCookie</a></span>&#8203;(java.lang.String&nbsp;name,
java.lang.String&nbsp;value)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,java.lang.String,long)">HttpCookie</a></span>&#8203;(java.lang.String&nbsp;name,
java.lang.String&nbsp;value,
long&nbsp;maxAge)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,java.lang.String)">HttpCookie</a></span>&#8203;(java.lang.String&nbsp;name,
java.lang.String&nbsp;value,
java.lang.String&nbsp;domain,
java.lang.String&nbsp;path)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,java.lang.String,long,boolean,boolean)">HttpCookie</a></span>&#8203;(java.lang.String&nbsp;name,
java.lang.String&nbsp;value,
java.lang.String&nbsp;domain,
java.lang.String&nbsp;path,
long&nbsp;maxAge,
boolean&nbsp;httpOnly,
boolean&nbsp;secure)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,java.lang.String,long,boolean,boolean,java.lang.String,int)">HttpCookie</a></span>&#8203;(java.lang.String&nbsp;name,
java.lang.String&nbsp;value,
java.lang.String&nbsp;domain,
java.lang.String&nbsp;path,
long&nbsp;maxAge,
boolean&nbsp;httpOnly,
boolean&nbsp;secure,
java.lang.String&nbsp;comment,
int&nbsp;version)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,java.lang.String,long,boolean,boolean,java.lang.String,int,org.eclipse.jetty.http.HttpCookie.SameSite)">HttpCookie</a></span>&#8203;(java.lang.String&nbsp;name,
java.lang.String&nbsp;value,
java.lang.String&nbsp;domain,
java.lang.String&nbsp;path,
long&nbsp;maxAge,
boolean&nbsp;httpOnly,
boolean&nbsp;secure,
java.lang.String&nbsp;comment,
int&nbsp;version,
<a href="HttpCookie.SameSite.html" title="enum in org.eclipse.jetty.http">HttpCookie.SameSite</a>&nbsp;sameSite)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asString()">asString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getComment()">getComment</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCommentWithAttributes(java.lang.String,boolean,org.eclipse.jetty.http.HttpCookie.SameSite)">getCommentWithAttributes</a></span>&#8203;(java.lang.String&nbsp;comment,
boolean&nbsp;httpOnly,
<a href="HttpCookie.SameSite.html" title="enum in org.eclipse.jetty.http">HttpCookie.SameSite</a>&nbsp;sameSite)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCommentWithoutAttributes(java.lang.String)">getCommentWithoutAttributes</a></span>&#8203;(java.lang.String&nbsp;comment)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDomain()">getDomain</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxAge()">getMaxAge</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getName()">getName</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPath()">getPath</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRFC2965SetCookie()">getRFC2965SetCookie</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRFC6265SetCookie()">getRFC6265SetCookie</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="HttpCookie.SameSite.html" title="enum in org.eclipse.jetty.http">HttpCookie.SameSite</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSameSite()">getSameSite</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static <a href="HttpCookie.SameSite.html" title="enum in org.eclipse.jetty.http">HttpCookie.SameSite</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSameSiteDefault(org.eclipse.jetty.util.Attributes)">getSameSiteDefault</a></span>&#8203;(<a href="../util/Attributes.html" title="interface in org.eclipse.jetty.util">Attributes</a>&nbsp;contextAttributes)</code></th>
<td class="colLast">
<div class="block">Get the default value for SameSite cookie attribute, if one
has been set for the given context.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static <a href="HttpCookie.SameSite.html" title="enum in org.eclipse.jetty.http">HttpCookie.SameSite</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSameSiteFromComment(java.lang.String)">getSameSiteFromComment</a></span>&#8203;(java.lang.String&nbsp;comment)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSetCookie(org.eclipse.jetty.http.CookieCompliance)">getSetCookie</a></span>&#8203;(<a href="CookieCompliance.html" title="class in org.eclipse.jetty.http">CookieCompliance</a>&nbsp;compliance)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValue()">getValue</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVersion()">getVersion</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isExpired(long)">isExpired</a></span>&#8203;(long&nbsp;timeNanos)</code></th>
<td class="colLast">&nbsp;</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="#isHttpOnly()">isHttpOnly</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isHttpOnlyInComment(java.lang.String)">isHttpOnlyInComment</a></span>&#8203;(java.lang.String&nbsp;comment)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSecure()">isSecure</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="HTTP_ONLY_COMMENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HTTP_ONLY_COMMENT</h4>
<pre>public static final&nbsp;java.lang.String HTTP_ONLY_COMMENT</pre>
<div class="block">If this string is found within the comment parsed with <a href="#isHttpOnlyInComment(java.lang.String)"><code>isHttpOnlyInComment(String)</code></a> the check will return true</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.eclipse.jetty.http.HttpCookie.HTTP_ONLY_COMMENT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="SAME_SITE_NONE_COMMENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SAME_SITE_NONE_COMMENT</h4>
<pre>public static final&nbsp;java.lang.String SAME_SITE_NONE_COMMENT</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.eclipse.jetty.http.HttpCookie.SAME_SITE_NONE_COMMENT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="SAME_SITE_LAX_COMMENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SAME_SITE_LAX_COMMENT</h4>
<pre>public static final&nbsp;java.lang.String SAME_SITE_LAX_COMMENT</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.eclipse.jetty.http.HttpCookie.SAME_SITE_LAX_COMMENT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="SAME_SITE_STRICT_COMMENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SAME_SITE_STRICT_COMMENT</h4>
<pre>public static final&nbsp;java.lang.String SAME_SITE_STRICT_COMMENT</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.eclipse.jetty.http.HttpCookie.SAME_SITE_STRICT_COMMENT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="SAME_SITE_DEFAULT_ATTRIBUTE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SAME_SITE_DEFAULT_ATTRIBUTE</h4>
<pre>public static final&nbsp;java.lang.String SAME_SITE_DEFAULT_ATTRIBUTE</pre>
<div class="block">Name of context attribute with default SameSite cookie value</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.eclipse.jetty.http.HttpCookie.SAME_SITE_DEFAULT_ATTRIBUTE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HttpCookie</h4>
<pre>public&nbsp;HttpCookie&#8203;(java.lang.String&nbsp;name,
java.lang.String&nbsp;value)</pre>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.String,java.lang.String,java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HttpCookie</h4>
<pre>public&nbsp;HttpCookie&#8203;(java.lang.String&nbsp;name,
java.lang.String&nbsp;value,
java.lang.String&nbsp;domain,
java.lang.String&nbsp;path)</pre>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.String,java.lang.String,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HttpCookie</h4>
<pre>public&nbsp;HttpCookie&#8203;(java.lang.String&nbsp;name,
java.lang.String&nbsp;value,
long&nbsp;maxAge)</pre>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.String,java.lang.String,java.lang.String,java.lang.String,long,boolean,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HttpCookie</h4>
<pre>public&nbsp;HttpCookie&#8203;(java.lang.String&nbsp;name,
java.lang.String&nbsp;value,
java.lang.String&nbsp;domain,
java.lang.String&nbsp;path,
long&nbsp;maxAge,
boolean&nbsp;httpOnly,
boolean&nbsp;secure)</pre>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.String,java.lang.String,java.lang.String,java.lang.String,long,boolean,boolean,java.lang.String,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HttpCookie</h4>
<pre>public&nbsp;HttpCookie&#8203;(java.lang.String&nbsp;name,
java.lang.String&nbsp;value,
java.lang.String&nbsp;domain,
java.lang.String&nbsp;path,
long&nbsp;maxAge,
boolean&nbsp;httpOnly,
boolean&nbsp;secure,
java.lang.String&nbsp;comment,
int&nbsp;version)</pre>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.String,java.lang.String,java.lang.String,java.lang.String,long,boolean,boolean,java.lang.String,int,org.eclipse.jetty.http.HttpCookie.SameSite)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HttpCookie</h4>
<pre>public&nbsp;HttpCookie&#8203;(java.lang.String&nbsp;name,
java.lang.String&nbsp;value,
java.lang.String&nbsp;domain,
java.lang.String&nbsp;path,
long&nbsp;maxAge,
boolean&nbsp;httpOnly,
boolean&nbsp;secure,
java.lang.String&nbsp;comment,
int&nbsp;version,
<a href="HttpCookie.SameSite.html" title="enum in org.eclipse.jetty.http">HttpCookie.SameSite</a>&nbsp;sameSite)</pre>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HttpCookie</h4>
<pre>public&nbsp;HttpCookie&#8203;(java.lang.String&nbsp;setCookie)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getName()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the cookie name</dd>
</dl>
</li>
</ul>
<a id="getValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getValue()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the cookie value</dd>
</dl>
</li>
</ul>
<a id="getComment()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getComment</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getComment()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the cookie comment</dd>
</dl>
</li>
</ul>
<a id="getDomain()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDomain</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getDomain()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the cookie domain</dd>
</dl>
</li>
</ul>
<a id="getMaxAge()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxAge</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getMaxAge()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the cookie max age in seconds</dd>
</dl>
</li>
</ul>
<a id="getPath()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPath</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getPath()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the cookie path</dd>
</dl>
</li>
</ul>
<a id="isSecure()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSecure</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isSecure()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the cookie is valid for secure domains</dd>
</dl>
</li>
</ul>
<a id="getVersion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVersion</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getVersion()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the cookie version</dd>
</dl>
</li>
</ul>
<a id="getSameSite()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSameSite</h4>
<pre class="methodSignature">public&nbsp;<a href="HttpCookie.SameSite.html" title="enum in org.eclipse.jetty.http">HttpCookie.SameSite</a>&nbsp;getSameSite()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the cookie SameSite enum attribute</dd>
</dl>
</li>
</ul>
<a id="isHttpOnly()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isHttpOnly</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isHttpOnly()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the cookie is valid for the http protocol only</dd>
</dl>
</li>
</ul>
<a id="isExpired(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isExpired</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isExpired&#8203;(long&nbsp;timeNanos)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeNanos</code> - the time to check for cookie expiration, in nanoseconds</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the cookie is expired by the given time</dd>
</dl>
</li>
</ul>
<a id="asString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;asString()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string representation of this cookie</dd>
</dl>
</li>
</ul>
<a id="getSetCookie(org.eclipse.jetty.http.CookieCompliance)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSetCookie</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getSetCookie&#8203;(<a href="CookieCompliance.html" title="class in org.eclipse.jetty.http">CookieCompliance</a>&nbsp;compliance)</pre>
</li>
</ul>
<a id="getRFC2965SetCookie()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRFC2965SetCookie</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getRFC2965SetCookie()</pre>
</li>
</ul>
<a id="getRFC6265SetCookie()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRFC6265SetCookie</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getRFC6265SetCookie()</pre>
</li>
</ul>
<a id="isHttpOnlyInComment(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isHttpOnlyInComment</h4>
<pre class="methodSignature">public static&nbsp;boolean&nbsp;isHttpOnlyInComment&#8203;(java.lang.String&nbsp;comment)</pre>
</li>
</ul>
<a id="getSameSiteFromComment(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSameSiteFromComment</h4>
<pre class="methodSignature">public static&nbsp;<a href="HttpCookie.SameSite.html" title="enum in org.eclipse.jetty.http">HttpCookie.SameSite</a>&nbsp;getSameSiteFromComment&#8203;(java.lang.String&nbsp;comment)</pre>
</li>
</ul>
<a id="getSameSiteDefault(org.eclipse.jetty.util.Attributes)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSameSiteDefault</h4>
<pre class="methodSignature">public static&nbsp;<a href="HttpCookie.SameSite.html" title="enum in org.eclipse.jetty.http">HttpCookie.SameSite</a>&nbsp;getSameSiteDefault&#8203;(<a href="../util/Attributes.html" title="interface in org.eclipse.jetty.util">Attributes</a>&nbsp;contextAttributes)</pre>
<div class="block">Get the default value for SameSite cookie attribute, if one
has been set for the given context.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>contextAttributes</code> - the context to check for default SameSite value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the default SameSite value or null if one does not exist</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the default value is not a permitted value</dd>
</dl>
</li>
</ul>
<a id="getCommentWithoutAttributes(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCommentWithoutAttributes</h4>
<pre class="methodSignature">public static&nbsp;java.lang.String&nbsp;getCommentWithoutAttributes&#8203;(java.lang.String&nbsp;comment)</pre>
</li>
</ul>
<a id="getCommentWithAttributes(java.lang.String,boolean,org.eclipse.jetty.http.HttpCookie.SameSite)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCommentWithAttributes</h4>
<pre class="methodSignature">public static&nbsp;java.lang.String&nbsp;getCommentWithAttributes&#8203;(java.lang.String&nbsp;comment,
boolean&nbsp;httpOnly,
<a href="HttpCookie.SameSite.html" title="enum in org.eclipse.jetty.http">HttpCookie.SameSite</a>&nbsp;sameSite)</pre>
</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/HttpCookie.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>Copyright &#169; 1995&#x2013;2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>