X-Git-Url: https://code.wpia.club/?a=blobdiff_plain;f=src%2Forg%2Fcacert%2Fgigi%2Fpages%2FPage.java;h=9a5c178a8d0a576422305094b7fe4383b5361e09;hb=aade4c55a068d4b8211d67754cb6060e6c7a42b0;hp=7b59f9f11521d21d27e66fd05000794b3abb887d;hpb=4fc466a7d4d7bf71f2cdb62e11eeccfbffdbb274;p=gigi.git diff --git a/src/org/cacert/gigi/pages/Page.java b/src/org/cacert/gigi/pages/Page.java index 7b59f9f1..9a5c178a 100644 --- a/src/org/cacert/gigi/pages/Page.java +++ b/src/org/cacert/gigi/pages/Page.java @@ -1,28 +1,96 @@ package org.cacert.gigi.pages; import java.io.IOException; +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.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; + URL resource = getClass().getResource(getClass().getSimpleName() + ".templ"); + if (resource != null) { + defaultTemplate = new Template(resource); + } } - public abstract void doGet(HttpServletRequest req, HttpServletResponse resp) - throws IOException; + /** + * Retrieves the default template (<className>.templ) which has + * already been loaded. + * + * @return the default template. + */ + public Template getDefaultTemplate() { + return defaultTemplate; + } + + /** + * 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 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 true + * + * @return if the page needs login. + */ + public boolean needsLogin() { + return true; + } + public String getTitle() { return title; } @@ -30,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"); } @@ -38,8 +107,5 @@ public abstract class Page { Language l = getLanguage(req); return l.getTranslation(string); } - public boolean needsLogin() { - return true; - } }