code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/store/ResourceEventStore.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.store
  37
  38 import gr.grnet.aquarium.AquariumException
  39 import gr.grnet.aquarium.event.model.resource.ResourceEventModel
  40
  41 /**
  42  * An abstraction for Aquarium `ResourceEvent` stores.
  43  *
  44  * @author Christos KK Loverdos <loverdos@gmail.com>.
  45  * @author Georgios Gousios <gousiosg@gmail.com>.
  46  */
  47 trait ResourceEventStore {
  48   type ResourceEvent <: ResourceEventModel
  49
  50   def createResourceEventFromOther(event: ResourceEventModel): ResourceEvent
  51
  52   def clearResourceEvents(): Unit = {
  53     throw new AquariumException("Unsupported operation")
  54   }
  55
  56   def pingResourceEventStore(): Unit
  57
  58   def insertResourceEvent(event: ResourceEventModel): ResourceEvent
  59
  60   def findResourceEventById(id: String): Option[ResourceEvent]
  61
  62   def findResourceEventsByUserId(userId: String)(sortWith: Option[(ResourceEvent, ResourceEvent) => Boolean]): List[ResourceEvent]
  63
  64   /**
  65    * Returns the events for the given User after (or equal) the given timestamp.
  66    *
  67    * The events are returned in ascending timestamp order.
  68    */
  69   def findResourceEventsByUserIdAfterTimestamp(userId: String, timestamp: Long): List[ResourceEvent]
  70
  71   def findResourceEventHistory(userId: String, resName: String,
  72                                instid: Option[String], upTo: Long) : List[ResourceEvent]
  73
  74   def findResourceEventsForReceivedPeriod(userId: String, startTimeMillis: Long, stopTimeMillis: Long): List[ResourceEvent]
  75
  76   /**
  77    * Count and return the number of "out of sync" events for a billing month.
  78    */
  79   def countOutOfSyncEventsForBillingPeriod(userId: String, startMillis: Long, stopMillis: Long): Long
  80
  81   /**
  82    * Finds all relevant resource events for the billing period.
  83    * The relevant events are those:
  84    * a) whose `occurredMillis` is within the given billing period or
  85    * b) whose `receivedMillis` is within the given billing period.
  86    *
  87    * Order them by `occurredMillis`
  88    * FIXME: implement
  89    */
  90   def findAllRelevantResourceEventsForBillingPeriod(userId: String,
  91                                                     startMillis: Long,
  92                                                     stopMillis: Long): List[ResourceEvent]
  93 }