Upstream/Plan
1
0
Fork 0
mirror of https://github.com/plan-player-analytics/Plan.git synced 2024-11-02 00:39:34 +01:00
Code Issues Projects Releases Wiki Activity
48c4b75b5c
Plan/api/com/djrapitops/plan/delivery/web/resolver/request/Request.html

426 lines
18 KiB
HTML
Raw Normal View History

Updated javadocs
2020-03-21 15:43:05 +01:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fi">
<head>
<!-- Generated by javadoc -->
<title>Request (api 5.1-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Request (api 5.1-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
Updated javadocs
2020-06-21 19:24:04 +02:00
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
Updated javadocs
2020-03-21 15:43:05 +01:00
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";
</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>Prev&nbsp;Class</li>
<li><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/URIPath.html" title="class in com.djrapitops.plan.delivery.web.resolver.request"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?com/djrapitops/plan/delivery/web/resolver/request/Request.html" target="_top">Frames</a></li>
<li><a href="Request.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>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 name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.djrapitops.plan.delivery.web.resolver.request</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>
<br>
<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="../../../../../../../com/djrapitops/plan/delivery/web/resolver/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 ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/Request.html#Request-java.lang.String-java.lang.String-com.djrapitops.plan.delivery.web.resolver.request.WebUser-java.util.Map-">Request</a></span>(java.lang.String&nbsp;method,
java.lang.String&nbsp;target,
<a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/WebUser.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">WebUser</a>&nbsp;user,
java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;headers)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/Request.html#Request-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-">Request</a></span>(java.lang.String&nbsp;method,
<a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/URIPath.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">URIPath</a>&nbsp;path,
<a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/URIQuery.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">URIQuery</a>&nbsp;query,
<a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/WebUser.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">WebUser</a>&nbsp;user,
java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;headers)</code>
<div class="block">Constructor.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.util.Optional&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/Request.html#getHeader-java.lang.String-">getHeader</a></span>(java.lang.String&nbsp;key)</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/Request.html#getMethod--">getMethod</a></span>()</code>
<div class="block">Get HTTP method.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/URIPath.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">URIPath</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/Request.html#getPath--">getPath</a></span>()</code>
<div class="block">Get the Requested path.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/URIQuery.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">URIQuery</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/Request.html#getQuery--">getQuery</a></span>()</code>
<div class="block">Get the Request parameters.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.Optional&lt;<a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/WebUser.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">WebUser</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/Request.html#getUser--">getUser</a></span>()</code>
<div class="block">Get the user making the request.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/Request.html#omitFirstInPath--">omitFirstInPath</a></span>()</code>&nbsp;</td>
</tr>
Updated javadocs
2020-06-21 19:24:04 +02:00
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/Request.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
Updated javadocs
2020-03-21 15:43:05 +01:00
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
Updated javadocs
2020-06-21 19:24:04 +02:00
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
Updated javadocs
2020-03-21 15:43:05 +01:00
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Request-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-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Request</h4>
<pre>public&nbsp;Request(java.lang.String&nbsp;method,
<a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/URIPath.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">URIPath</a>&nbsp;path,
<a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/URIQuery.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">URIQuery</a>&nbsp;query,
<a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/WebUser.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">WebUser</a>&nbsp;user,
java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;headers)</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>
</dl>
</li>
</ul>
<a name="Request-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(java.lang.String&nbsp;method,
java.lang.String&nbsp;target,
<a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/WebUser.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">WebUser</a>&nbsp;user,
java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;headers)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getMethod--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMethod</h4>
<pre>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 name="getPath--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPath</h4>
<pre>public&nbsp;<a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/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="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/URIPath.html" title="class in com.djrapitops.plan.delivery.web.resolver.request"><code>URIPath</code></a>.</dd>
</dl>
</li>
</ul>
<a name="getQuery--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQuery</h4>
<pre>public&nbsp;<a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/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="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/URIQuery.html" title="class in com.djrapitops.plan.delivery.web.resolver.request"><code>URIQuery</code></a>.</dd>
</dl>
</li>
</ul>
<a name="getUser--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUser</h4>
<pre>public&nbsp;java.util.Optional&lt;<a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/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 name="getHeader-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeader</h4>
<pre>public&nbsp;java.util.Optional&lt;java.lang.String&gt;&nbsp;getHeader(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 name="omitFirstInPath--">
<!-- -->
</a>
Updated javadocs
2020-06-21 19:24:04 +02:00
<ul class="blockList">
Updated javadocs
2020-03-21 15:43:05 +01:00
<li class="blockList">
<h4>omitFirstInPath</h4>
<pre>public&nbsp;<a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a>&nbsp;omitFirstInPath()</pre>
</li>
</ul>
Updated javadocs
2020-06-21 19:24:04 +02:00
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>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>
Updated javadocs
2020-03-21 15:43:05 +01:00
</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>Prev&nbsp;Class</li>
<li><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/URIPath.html" title="class in com.djrapitops.plan.delivery.web.resolver.request"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?com/djrapitops/plan/delivery/web/resolver/request/Request.html" target="_top">Frames</a></li>
<li><a href="Request.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>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 name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue Copy Permalink