Remove @author tags
[Sone.git] / src / main / java / net / pterodactylus / sone / web / page / FreenetRequest.java
1 /*
2  * Sone - FreenetRequest.java - Copyright © 2011–2016 David Roden
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
16  */
17
18 package net.pterodactylus.sone.web.page;
19
20 import java.net.URI;
21
22 import net.pterodactylus.util.web.Method;
23 import net.pterodactylus.util.web.Request;
24 import freenet.clients.http.ToadletContext;
25 import freenet.support.api.HTTPRequest;
26
27 /**
28  * Encapsulates all Freenet-specific properties of a request.
29  */
30 public class FreenetRequest extends Request {
31
32         /** The underlying HTTP request from Freenet. */
33         private final HTTPRequest httpRequest;
34
35         /** The toadlet context. */
36         private final ToadletContext toadletContext;
37
38         /**
39          * Creates a new freenet request.
40          *
41          * @param uri
42          *            The URI that is being accessed
43          * @param method
44          *            The method used to access this page
45          * @param httpRequest
46          *            The underlying HTTP request from Freenet
47          * @param toadletContext
48          *            The toadlet context
49          */
50         public FreenetRequest(URI uri, Method method, HTTPRequest httpRequest, ToadletContext toadletContext) {
51                 super(uri, method);
52                 this.httpRequest = httpRequest;
53                 this.toadletContext = toadletContext;
54         }
55
56         //
57         // ACCESSORS
58         //
59
60         /**
61          * Returns the underlying HTTP request from Freenet.
62          *
63          * @return The underlying HTTP request from Freenet
64          */
65         public HTTPRequest getHttpRequest() {
66                 return httpRequest;
67         }
68
69         /**
70          * Returns the toadlet context.
71          *
72          * @return The toadlet context
73          */
74         public ToadletContext getToadletContext() {
75                 return toadletContext;
76         }
77
78 }