Plan/api/com/djrapitops/plan/delivery/web/resolver/request/Request.html

495 lines
18 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Request (api 5.4-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<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="Request (api 5.4-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All 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="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><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>Field&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">com.djrapitops.plan.delivery.web.resolver.request</a></div>
<h2 title="Class Request" class="title">Class Request</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.djrapitops.plan.delivery.web.resolver.request.Request</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public final class <span class="typeNameLabel">Request</span>
extends java.lang.Object</pre>
<div class="block">Represents a HTTP request to use with <a href="../Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver"><code>Resolver</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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,com.djrapitops.plan.delivery.web.resolver.request.URIPath,com.djrapitops.plan.delivery.web.resolver.request.URIQuery,com.djrapitops.plan.delivery.web.resolver.request.WebUser,java.util.Map,byte%5B%5D)">Request</a></span>&#8203;(java.lang.String&nbsp;method,
<a href="URIPath.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">URIPath</a>&nbsp;path,
<a href="URIQuery.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">URIQuery</a>&nbsp;query,
<a href="WebUser.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">WebUser</a>&nbsp;user,
java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;headers,
byte[]&nbsp;body)</code></th>
<td class="colLast">
<div class="block">Constructor.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,java.lang.String,com.djrapitops.plan.delivery.web.resolver.request.WebUser,java.util.Map)">Request</a></span>&#8203;(java.lang.String&nbsp;method,
java.lang.String&nbsp;target,
<a href="WebUser.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">WebUser</a>&nbsp;user,
java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;headers)</code></th>
<td class="colLast">
<div class="block">Special constructor that figures out URIPath and URIQuery from "/path/and?query=params" and has no form body.</div>
</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="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.util.Optional&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeader(java.lang.String)">getHeader</a></span>&#8203;(java.lang.String&nbsp;key)</code></th>
<td class="colLast">
<div class="block">Get a header in the request.</div>
</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="#getMethod()">getMethod</a></span>()</code></th>
<td class="colLast">
<div class="block">Get HTTP method.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="URIPath.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">URIPath</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPath()">getPath</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the Requested path.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="URIQuery.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">URIQuery</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQuery()">getQuery</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the Request parameters.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRequestBody()">getRequestBody</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the raw body, if present.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.Optional&lt;<a href="WebUser.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">WebUser</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUser()">getUser</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the user making the request.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#omitFirstInPath()">omitFirstInPath</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="#toString()">toString</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, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= 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,com.djrapitops.plan.delivery.web.resolver.request.URIPath,com.djrapitops.plan.delivery.web.resolver.request.URIQuery,com.djrapitops.plan.delivery.web.resolver.request.WebUser,java.util.Map,byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Request</h4>
<pre>public&nbsp;Request&#8203;(java.lang.String&nbsp;method,
<a href="URIPath.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">URIPath</a>&nbsp;path,
<a href="URIQuery.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">URIQuery</a>&nbsp;query,
<a href="WebUser.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">WebUser</a>&nbsp;user,
java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;headers,
byte[]&nbsp;body)</pre>
<div class="block">Constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>method</code> - HTTP method, GET, PUT, POST, etc</dd>
<dd><code>path</code> - Requested path /example/target</dd>
<dd><code>query</code> - Request parameters ?param=value etc</dd>
<dd><code>user</code> - Web user doing the request (if authenticated)</dd>
<dd><code>headers</code> - Request headers https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers</dd>
<dd><code>body</code> - Raw body as bytes, if present</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.String,java.lang.String,com.djrapitops.plan.delivery.web.resolver.request.WebUser,java.util.Map)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Request</h4>
<pre>public&nbsp;Request&#8203;(java.lang.String&nbsp;method,
java.lang.String&nbsp;target,
<a href="WebUser.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">WebUser</a>&nbsp;user,
java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;headers)</pre>
<div class="block">Special constructor that figures out URIPath and URIQuery from "/path/and?query=params" and has no form body.</div>
</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="getMethod()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMethod</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getMethod()</pre>
<div class="block">Get HTTP method.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>GET, PUT, POST, etc</dd>
</dl>
</li>
</ul>
<a id="getPath()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPath</h4>
<pre class="methodSignature">public&nbsp;<a href="URIPath.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">URIPath</a>&nbsp;getPath()</pre>
<div class="block">Get the Requested path.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="URIPath.html" title="class in com.djrapitops.plan.delivery.web.resolver.request"><code>URIPath</code></a>.</dd>
</dl>
</li>
</ul>
<a id="getQuery()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQuery</h4>
<pre class="methodSignature">public&nbsp;<a href="URIQuery.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">URIQuery</a>&nbsp;getQuery()</pre>
<div class="block">Get the Request parameters.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="URIQuery.html" title="class in com.djrapitops.plan.delivery.web.resolver.request"><code>URIQuery</code></a>.</dd>
</dl>
</li>
</ul>
<a id="getRequestBody()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequestBody</h4>
<pre class="methodSignature">public&nbsp;byte[]&nbsp;getRequestBody()</pre>
<div class="block">Get the raw body, if present.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>byte[].</dd>
</dl>
</li>
</ul>
<a id="getUser()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUser</h4>
<pre class="methodSignature">public&nbsp;java.util.Optional&lt;<a href="WebUser.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">WebUser</a>&gt;&nbsp;getUser()</pre>
<div class="block">Get the user making the request.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the user if authentication is enabled</dd>
</dl>
</li>
</ul>
<a id="getHeader(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeader</h4>
<pre class="methodSignature">public&nbsp;java.util.Optional&lt;java.lang.String&gt;&nbsp;getHeader&#8203;(java.lang.String&nbsp;key)</pre>
<div class="block">Get a header in the request.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Value if it is present in the request.</dd>
</dl>
</li>
</ul>
<a id="omitFirstInPath()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>omitFirstInPath</h4>
<pre class="methodSignature">public&nbsp;<a href="Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a>&nbsp;omitFirstInPath()</pre>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><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>Field&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>
</footer>
</body>
</html>