Servlet: lepší komentáře.
1.1 --- a/java/nekurak.net-web/src/java/cz/frantovo/nekurak/servlet/Fotky.java Sat Mar 13 23:11:01 2010 +0100
1.2 +++ b/java/nekurak.net-web/src/java/cz/frantovo/nekurak/servlet/Fotky.java Sat Mar 13 23:26:55 2010 +0100
1.3 @@ -14,16 +14,25 @@
1.4 import javax.servlet.http.HttpServletResponse;
1.5
1.6 /**
1.7 - * Servlet pro zpřístupnění fotek, které se nacházejí ve zvláštním adresáři.
1.8 + * <p>Servlet pro zpřístupnění fotek, které se nacházejí ve zvláštním adresáři.</p>
1.9 *
1.10 - * Má jeden inicializační parametr:
1.11 - * adresar – cesta k adresáři na disku, kde se nacházejí fotky.
1.12 - * např. /var/www/nekurak.net/fotky
1.13 + * <p>Má jeden inicializační parametr:</p>
1.14 + * <ul>
1.15 + * <li><code>adresar</code> – cesta k adresáři na disku, kde se nacházejí fotky.</li>
1.16 + * <li>např. <code>/var/www/nekurak.net/fotky</code></li>
1.17 + * </ul>
1.18 *
1.19 - * Očekává se struktura adresářů tohoto typu:
1.20 - * Plné rozlišení: /var/www/nekurak.net/fotky/original/1.jpg
1.21 - * Náhled fotky: /var/www/nekurak.net/fotky/nahled/1.jpg
1.22 - * Lze ovlivnit konstantami níže
1.23 + * <p>Očekává se struktura adresářů tohoto typu:</p>
1.24 + * <ul>
1.25 + * <li>Plné rozlišení: <code>/var/www/nekurak.net/fotky/original/1.jpg</code></li>
1.26 + * <li>Náhled fotky: <code>/var/www/nekurak.net/fotky/nahled/1.jpg</code></li>
1.27 + * </ul>
1.28 + * <p>Lze ovlivnit konstantami níže.</p>
1.29 + *
1.30 + * <p>URL respektují fyzické umístění fotek na serveru (není např. ID v GET parametru stylem <code>/fotky?id=123</code>),
1.31 + * díky tomu je možné, aby fotky později servírovala přímo reverzní proxy a nemusely procházet přes naši aplikaci
1.32 + * (fotky jsou veřejné, není potřeba řešit autorizaci)</p>
1.33 + *
1.34 * @author fiki
1.35 */
1.36 public class Fotky extends HttpServlet {
1.37 @@ -58,8 +67,8 @@
1.38
1.39 /**
1.40 * @param pozadavek pouze GET (není důvod podporovat POST)
1.41 - * @param odpoved
1.42 - * @throws ServletException např. pokud parametr id není číslo
1.43 + * @param odpoved odešleme fotku s MIME typem podle konstanty, délkou a datem podle souboru.
1.44 + * @throws ServletException pokud je požadovaná cesta chybná (nevyhovuje vzoru)
1.45 * @throws IOException
1.46 */
1.47 @Override
1.48 @@ -103,7 +112,7 @@
1.49 }
1.50
1.51 /**
1.52 - * @param cesta cesta požadovaná klientem: request.getPathInfo();
1.53 + * @param cesta cesta požadovaná klientem: <code>request.getPathInfo()</code>
1.54 * @throws ServletException pokud cesta nevyhovuje vzoru
1.55 */
1.56 private static String zkontrolujParametr(String cesta) throws ServletException {