code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/service/RESTPaths.scala

   1 /*
   2  * Copyright 2011-2012 GRNET S.A. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or
   5  * without modification, are permitted provided that the following
   6  * conditions are met:
   7  *
   8  *   1. Redistributions of source code must retain the above
   9  *      copyright notice, this list of conditions and the following
  10  *      disclaimer.
  11  *
  12  *   2. Redistributions in binary form must reproduce the above
  13  *      copyright notice, this list of conditions and the following
  14  *      disclaimer in the documentation and/or other materials
  15  *      provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
  18  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  20  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
  21  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  24  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  25  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  27  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28  * POSSIBILITY OF SUCH DAMAGE.
  29  *
  30  * The views and conclusions contained in the software and
  31  * documentation are those of the authors and should not be
  32  * interpreted as representing official policies, either expressed
  33  * or implied, of GRNET S.A.
  34  */
  35
  36 package gr.grnet.aquarium.service
  37
  38 import gr.grnet.aquarium.ResourceLocator
  39
  40 /**
  41  * Paths recognized and served by the REST API.
  42  *
  43  * @author Christos KK Loverdos <loverdos@gmail.com>.
  44  */
  45 object RESTPaths {
  46   final val PingPath = "/ping".r
  47
  48   final val AdminPrefix = "/admin"
  49
  50   private def fixREDot(s: String) = s.replaceAll("""\.""", """\\.""")
  51   private def toResourcesPath(name: String) = AdminPrefix + "/resources/%s".format(fixREDot(name))
  52   private def toEventPath(name: String)     = AdminPrefix + "/%s/([^/]+)/?".format(name)
  53
  54   final val ResourcesPath = (AdminPrefix + "/resources/?").r
  55
  56   final val ResourcesAquariumPropertiesPath = toResourcesPath(ResourceLocator.ResourceNames.AQUARIUM_PROPERTIES).r
  57
  58   final val ResourcesLogbackXMLPath = toResourcesPath(ResourceLocator.ResourceNames.LOGBACK_XML).r
  59
  60     final val ResourcesPolicyJSONPath = toResourcesPath(ResourceLocator.ResourceNames.POLICY_JSON).r
  61
  62     final val ResourceEventPath = toEventPath("rcevent").r
  63
  64     final val IMEventPath = toEventPath("imevent").r
  65
  66     /**
  67      * Use this URI path to query for the user balance. The parenthesized regular expression part
  68      * represents the user ID.
  69      */
  70     final val UserBalancePath = "/user/([^/]+)/balance/?".r
  71
  72     /**
  73      * Use this URI path to query for the user state.
  74      */
  75     final val UserStatePath = "/user/([^/]+)/state/?".r
  76
  77     final val UserWalletPath = "/user/([^/]+)/wallet/?".r
  78
  79     final val UserBillPath = "/user/([^/]+)/bill/([0-9]+)/([0-9]+)/?".r
  80
  81   final val UserActorCacheContentsPath = (AdminPrefix + "/cache/actor/user/contents").r
  82   final val UserActorCacheCountPath    = (AdminPrefix + "/cache/actor/user/size").r
  83   final val UserActorCacheStatsPath    = (AdminPrefix + "/cache/actor/user/stats").r
  84 }