/*
- * shortener - Page.java - Copyright © 2010 David Roden
+ * Sone - Page.java - Copyright © 2010 David Roden
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
/**
* A page is responsible for handling HTTP requests and creating appropriate
* responses.
- *
+ *
* @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
public interface Page {
/**
* Returns the path of this toadlet.
- *
+ *
* @return The path of this toadlet
*/
public String getPath();
/**
* Handles a request.
- *
+ *
* @param request
* The request to handle
* @return The response
/**
* Container for request data.
- *
+ *
* @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
public class Request {
+ /**
+ * Enumeration for all possible HTTP request methods.
+ *
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’
+ * Roden</a>
+ */
+ public enum Method {
+
+ /** GET. */
+ GET,
+
+ /** POST. */
+ POST,
+
+ /** PUT. */
+ PUT,
+
+ /** DELETE. */
+ DELETE,
+
+ /** HEAD. */
+ HEAD,
+
+ /** OPTIONS. */
+ OPTIONS,
+
+ /** TRACE. */
+ TRACE,
+
+ }
+
/** The URI that was accessed. */
private final URI uri;
/** The HTTP method that was used. */
- private final String method;
+ private final Method method;
/** The HTTP request. */
private final HTTPRequest httpRequest;
/**
* Creates a new request that holds the given data.
- *
+ *
* @param uri
* The URI of the request
* @param method
* @param toadletContext
* The toadlet context of the request
*/
- public Request(URI uri, String method, HTTPRequest httpRequest, ToadletContext toadletContext) {
+ public Request(URI uri, Method method, HTTPRequest httpRequest, ToadletContext toadletContext) {
this.uri = uri;
this.method = method;
this.httpRequest = httpRequest;
/**
* Returns the URI that was accessed.
- *
+ *
* @return The accessed URI
*/
- public URI getURI() {
+ public URI getUri() {
return uri;
}
/**
* Returns the HTTP method that was used to access the page.
- *
+ *
* @return The HTTP method
*/
- public String getMethod() {
+ public Method getMethod() {
return method;
}
/**
* Returns the HTTP request.
- *
+ *
* @return The HTTP request
*/
public HTTPRequest getHttpRequest() {
/**
* Returns the toadlet context.
- *
+ *
* @return The toadlet context
*/
public ToadletContext getToadletContext() {
/**
* Container for the HTTP response of a {@link Page}.
- *
+ *
* @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
public class Response {
/**
* Creates a new response.
- *
+ *
* @param statusCode
* The HTTP status code of the response
* @param statusText
/**
* Creates a new response.
- *
+ *
* @param statusCode
* The HTTP status code of the response
* @param statusText
* The content of the reponse body
*/
public Response(int statusCode, String statusText, String contentType, byte[] content) {
- this(statusCode, statusText, contentType, null, content);
+ this(statusCode, statusText, contentType, new HashMap<String, String>(), content);
}
/**
* Creates a new response.
- *
+ *
* @param statusCode
* The HTTP status code of the response
* @param statusText
/**
* Creates a new response.
- *
+ *
* @param statusCode
* The HTTP status code of the response
* @param statusText
/**
* Creates a new response.
- *
+ *
* @param statusCode
* The HTTP status code of the response
* @param statusText
/**
* Returns the HTTP status code of the response.
- *
+ *
* @return The HTTP status code
*/
public int getStatusCode() {
/**
* Returns the HTTP status text.
- *
+ *
* @return The HTTP status text
*/
public String getStatusText() {
/**
* Returns the content type of the response.
- *
+ *
* @return The content type of the reponse
*/
public String getContentType() {
/**
* Returns HTTP headers of the response. May be {@code null} if no
* headers are returned.
- *
+ *
* @return The response headers, or {@code null} if there are no
* response headers
*/
}
/**
+ * Sets the HTTP header with the given name to the given value. Multiple
+ * headers with the same name are not implemented so that latest call to
+ * {@link #setHeader(String, String)} determines what is sent to the
+ * browser.
+ *
+ * @param name
+ * The name of the header
+ * @param value
+ * The value of the header
+ */
+ public void setHeader(String name, String value) {
+ headers.put(name, value);
+ }
+
+ /**
* Returns the content of the response body. May be {@code null} if the
* response does not have a body.
- *
+ *
* @return The content of the response body
*/
public InputStream getContent() {
/**
* Returns the UTF-8 representation of the given text.
- *
+ *
* @param text
* The text to encode
* @return The encoded text
/**
* Creates a header map containing a single header.
- *
+ *
* @param name
* The name of the header
* @param value
/**
* {@link Response} implementation that performs an HTTP redirect.
- *
+ *
* @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
public class RedirectResponse extends Response {
/**
* Creates a new redirect response to the new location.
- *
+ *
* @param newLocation
* The new location
*/
/**
* Creates a new redirect response to the new location.
- *
+ *
* @param newLocation
* The new location
* @param permanent
projects / Sone.git / blobdiff