Change all copyright headers to include 2012.
[Sone.git] / src / main / java / net / pterodactylus / sone / web / page / FreenetRequest.java
1 /*
2  * Sone - FreenetRequest.java - Copyright © 2011–2012 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  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
31  */
32 public class FreenetRequest extends Request {
33
34         /** The underlying HTTP request from Freenet. */
35         private final HTTPRequest httpRequest;
36
37         /** The toadlet context. */
38         private final ToadletContext toadletContext;
39
40         /**
41          * Creates a new freenet request.
42          *
43          * @param uri
44          *            The URI that is being accessed
45          * @param method
46          *            The method used to access this page
47          * @param httpRequest
48          *            The underlying HTTP request from Freenet
49          * @param toadletContext
50          *            The toadlet context
51          */
52         public FreenetRequest(URI uri, Method method, HTTPRequest httpRequest, ToadletContext toadletContext) {
53                 super(uri, method);
54                 this.httpRequest = httpRequest;
55                 this.toadletContext = toadletContext;
56         }
57
58         //
59         // ACCESSORS
60         //
61
62         /**
63          * Returns the underlying HTTP request from Freenet.
64          *
65          * @return The underlying HTTP request from Freenet
66          */
67         public HTTPRequest getHttpRequest() {
68                 return httpRequest;
69         }
70
71         /**
72          * Returns the toadlet context.
73          *
74          * @return The toadlet context
75          */
76         public ToadletContext getToadletContext() {
77                 return toadletContext;
78         }
79
80 }