# HG changeset patch
# User František Kučera <franta-hg@frantovo.cz>
# Date 1268519215 -3600
# Node ID 68f2a5ab49c1a47c66a6c7725c58257ee486f451
# Parent  a2e6f8fc4c345617a4f7db8584f91a5908f4b3e6
Servlet: lepší komentáře.

diff -r a2e6f8fc4c34 -r 68f2a5ab49c1 java/nekurak.net-web/src/java/cz/frantovo/nekurak/servlet/Fotky.java
--- a/java/nekurak.net-web/src/java/cz/frantovo/nekurak/servlet/Fotky.java	Sat Mar 13 23:11:01 2010 +0100
+++ b/java/nekurak.net-web/src/java/cz/frantovo/nekurak/servlet/Fotky.java	Sat Mar 13 23:26:55 2010 +0100
@@ -14,16 +14,25 @@
 import javax.servlet.http.HttpServletResponse;
 
 /**
- * Servlet pro zpřístupnění fotek, které se nacházejí ve zvláštním adresáři.
+ * <p>Servlet pro zpřístupnění fotek, které se nacházejí ve zvláštním adresáři.</p>
  *
- * Má jeden inicializační parametr:
- *     adresar – cesta k adresáři na disku, kde se nacházejí fotky.
- *     např. /var/www/nekurak.net/fotky
+ * <p>Má jeden inicializační parametr:</p>
+ *  <ul>
+ *     <li><code>adresar</code> – cesta k adresáři na disku, kde se nacházejí fotky.</li>
+ *     <li>např. <code>/var/www/nekurak.net/fotky</code></li>
+ *  </ul>
  *
- * Očekává se struktura adresářů tohoto typu:
- *     Plné rozlišení: /var/www/nekurak.net/fotky/original/1.jpg
- *     Náhled fotky:   /var/www/nekurak.net/fotky/nahled/1.jpg
- * Lze ovlivnit konstantami níže
+ * <p>Očekává se struktura adresářů tohoto typu:</p>
+ *  <ul>
+ *	<li>Plné rozlišení: <code>/var/www/nekurak.net/fotky/original/1.jpg</code></li>
+ *      <li>Náhled fotky:   <code>/var/www/nekurak.net/fotky/nahled/1.jpg</code></li>
+ *  </ul>
+ * <p>Lze ovlivnit konstantami níže.</p>
+ *
+ * <p>URL respektují fyzické umístění fotek na serveru (není např. ID v GET parametru stylem <code>/fotky?id=123</code>),
+ * 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
+ * (fotky jsou veřejné, není potřeba řešit autorizaci)</p>
+ *
  * @author fiki
  */
 public class Fotky extends HttpServlet {
@@ -58,8 +67,8 @@
 
     /**
      * @param pozadavek pouze GET (není důvod podporovat POST)
-     * @param odpoved
-     * @throws ServletException např. pokud parametr id není číslo
+     * @param odpoved odešleme fotku s MIME typem podle konstanty, délkou a datem podle souboru.
+     * @throws ServletException pokud je požadovaná cesta chybná (nevyhovuje vzoru)
      * @throws IOException
      */
     @Override
@@ -103,7 +112,7 @@
     }
 
     /**
-     * @param cesta cesta požadovaná klientem: request.getPathInfo();
+     * @param cesta cesta požadovaná klientem: <code>request.getPathInfo()</code>
      * @throws ServletException pokud cesta nevyhovuje vzoru
      */
     private static String zkontrolujParametr(String cesta) throws ServletException {