code.grnet.gr Git - pithos/blob - src/gr/ebs/gss/client/Configuration.java

   1 /*
   2  * Copyright 2009 Electronic Business Systems Ltd.
   3  *
   4  * This file is part of GSS.
   5  *
   6  * GSS is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * GSS is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with GSS.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19 package gr.ebs.gss.client;
  20
  21 import com.google.gwt.i18n.client.Constants;
  22
  23
  24 /**
  25  * This interface contains bindings for the compile-time configurable
  26  * entities of the application.
  27  *
  28  * @author past
  29  */
  30 public interface Configuration extends Constants {
  31         /**
  32          * @return the name of the service
  33          */
  34         @DefaultStringValue("GSS")
  35         String serviceName();
  36
  37         /**
  38          * @return the login URL
  39          */
  40         @DefaultStringValue("/gss/login")
  41         String loginUrl();
  42
  43         /**
  44          * @return the logout URL
  45          */
  46         @DefaultStringValue("/gss/login")
  47         String logoutUrl();
  48
  49         /**
  50          * @return the authentication cookie name
  51          */
  52         @DefaultStringValue("_gss_a")
  53         String authCookie();
  54
  55         /**
  56          * @return the webdav cookie name
  57          */
  58         @DefaultStringValue("_gss_wd")
  59         String webdavCookie();
  60
  61         /**
  62          * @return the separator string between username and token in the
  63          * authentication cookie
  64          */
  65         @DefaultStringValue("|")
  66         String cookieSeparator();
  67
  68         /**
  69          * @return the relative path of the API root URL
  70          */
  71         @DefaultStringValue("rest/")
  72         String apiPath();
  73
  74         /**
  75          * @return the WebDAV URL
  76          */
  77         @DefaultStringValue("/webdav/")
  78         String webdavUrl();
  79
  80         /**
  81          * @return the URL of the service home page
  82          */
  83         @DefaultStringValue("http://localhost:8080/")
  84         String serviceHome();
  85
  86         /**
  87          * @return the token TTL note
  88          */
  89         @DefaultStringValue("")
  90         String tokenTTLNote();
  91
  92 }