X-Git-Url: https://code.wpia.club/?a=blobdiff_plain;f=src%2Forg%2Fcacert%2Fgigi%2Fpages%2FPage.java;h=9a5c178a8d0a576422305094b7fe4383b5361e09;hb=ca82909d6bb910769eb756058d51d55e6d257914;hp=386a6d75fcc7d96cb6f4e25cd7afa992abf775bc;hpb=dc71766639ada349bb35f676ad811eb113311d4c;p=gigi.git

diff --git a/src/org/cacert/gigi/pages/Page.java b/src/org/cacert/gigi/pages/Page.java
index 386a6d75..9a5c178a 100644
--- a/src/org/cacert/gigi/pages/Page.java
+++ b/src/org/cacert/gigi/pages/Page.java
@@ -1,50 +1,96 @@
 package org.cacert.gigi.pages;
 
 import java.io.IOException;
-import java.io.InputStream;
-import java.io.InputStreamReader;
-import java.io.UnsupportedEncodingException;
+import java.net.URL;
 
 import javax.servlet.ServletRequest;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
 import org.cacert.gigi.Language;
-import org.cacert.gigi.output.Template;
+import org.cacert.gigi.output.template.Template;
 
+/**
+ * This class encapsulates a sub page of Gigi. A template residing nearby this
+ * class with name <className>.templ will be loaded automatically.
+ */
 public abstract class Page {
 	private String title;
 	private Template defaultTemplate;
 
 	public Page(String title) {
 		this.title = title;
-		try {
-			InputStream resource = getClass().getResourceAsStream(
-					getClass().getSimpleName() + ".templ");
-			if (resource != null) {
-				defaultTemplate = new Template(new InputStreamReader(resource,
-						"UTF-8"));
-			}
-		} catch (UnsupportedEncodingException e) {
-			e.printStackTrace();
+		URL resource = getClass().getResource(getClass().getSimpleName() + ".templ");
+		if (resource != null) {
+			defaultTemplate = new Template(resource);
 		}
 	}
+
+	/**
+	 * Retrieves the default template (<className>.templ) which has
+	 * already been loaded.
+	 * 
+	 * @return the default template.
+	 */
 	public Template getDefaultTemplate() {
 		return defaultTemplate;
 	}
 
-	public boolean beforeTemplate(HttpServletRequest req,
-			HttpServletResponse resp) throws IOException {
+	/**
+	 * This method can be overridden to execute code and do stuff before the
+	 * default template is applied.
+	 * 
+	 * @param req
+	 *            the request to handle.
+	 * @param resp
+	 *            the response to write to
+	 * @return true, if the request is consumed and the default template should
+	 *         not be applied.
+	 * @throws IOException
+	 *             if output goes wrong.
+	 */
+	public boolean beforeTemplate(HttpServletRequest req, HttpServletResponse resp) throws IOException {
 		return false;
 	}
-	public abstract void doGet(HttpServletRequest req, HttpServletResponse resp)
-			throws IOException;
 
-	public void doPost(HttpServletRequest req, HttpServletResponse resp)
-			throws IOException {
+	/**
+	 * This method is called to generate the content inside the default
+	 * template.
+	 * 
+	 * @param req
+	 *            the request to handle.
+	 * @param resp
+	 *            the response to write to
+	 * @throws IOException
+	 *             if output goes wrong.
+	 */
+	public abstract void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException;
+
+	/**
+	 * Same as {@link #doGet(HttpServletRequest, HttpServletResponse)} but for
+	 * POST requests. By default they are redirected to
+	 * {@link #doGet(HttpServletRequest, HttpServletResponse)};
+	 * 
+	 * @param req
+	 *            the request to handle.
+	 * @param resp
+	 *            the response to write to
+	 * @throws IOException
+	 *             if output goes wrong.
+	 */
+	public void doPost(HttpServletRequest req, HttpServletResponse resp) throws IOException {
 		doGet(req, resp);
 	}
 
+	/**
+	 * Returns true, if this page requires login. Default is <code>true</code>
+	 * 
+	 * @return if the page needs login.
+	 */
+	public boolean needsLogin() {
+		return true;
+	}
+
 	public String getTitle() {
 		return title;
 	}
@@ -52,6 +98,7 @@ public abstract class Page {
 	public void setTitle(String title) {
 		this.title = title;
 	}
+
 	public static Language getLanguage(ServletRequest req) {
 		return Language.getInstance("de");
 	}
@@ -60,8 +107,5 @@ public abstract class Page {
 		Language l = getLanguage(req);
 		return l.getTranslation(string);
 	}
-	public boolean needsLogin() {
-		return true;
-	}
 
 }