src/main/java/net/pterodactylus/sone/web/WebInterface.java

   1 /*
   2  * FreenetSone - WebInterface.java - Copyright © 2010 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.sone.web;
  19
  20 import freenet.clients.http.SessionManager;
  21 import freenet.l10n.BaseL10n;
  22
  23 /**
  24  * Bundles functionality that a web interface of a Freenet plugin needs, e.g.
  25  * references to l10n helpers.
  26  *
  27  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  28  */
  29 public class WebInterface {
  30
  31         /** The node’s l10n helper. */
  32         private final BaseL10n l10n;
  33
  34         /** The node’s session manager. */
  35         private final SessionManager sessionManager;
  36
  37         /**
  38          * Creates a new web interface.
  39          *
  40          * @param l10n
  41          *            The node’s l10n helper
  42          * @param sessionManager
  43          *            The node’s session manager
  44          */
  45         public WebInterface(BaseL10n l10n, SessionManager sessionManager) {
  46                 this.l10n = l10n;
  47                 this.sessionManager = sessionManager;
  48         }
  49
  50         //
  51         // ACCESSORS
  52         //
  53
  54         /**
  55          * Returns the l10n helper of the node.
  56          *
  57          * @return The node’s l10n helper
  58          */
  59         public BaseL10n l10n() {
  60                 return l10n;
  61         }
  62
  63         /**
  64          * Returns the session manager of the node.
  65          *
  66          * @return The node’s session manager
  67          */
  68         public SessionManager sessionManager() {
  69                 return sessionManager;
  70         }
  71
  72 }