code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/store/ResourceEventStore.scala

   1 /*
   2  * Copyright 2011 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 com.ckkloverdos.maybe.Maybe
  39 import gr.grnet.aquarium.logic.events.ResourceEvent
  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   def storeResourceEvent(event: ResourceEvent): Maybe[RecordID]
  49
  50   def findResourceEventById(id: String): Maybe[ResourceEvent]
  51
  52   def findResourceEventsByUserId(userId: String)(sortWith: Option[(ResourceEvent, ResourceEvent) => Boolean]): List[ResourceEvent]
  53
  54   /**
  55    * Returns the events for the given User after (or equal) the given timestamp.
  56    *
  57    * The events are returned in ascending timestamp order.
  58    */
  59   def findResourceEventsByUserIdAfterTimestamp(userId: String, timestamp: Long): List[ResourceEvent]
  60
  61   def findResourceEventHistory(userId: String, resName: String,
  62                                instid: Option[String], upTo: Long) : List[ResourceEvent]
  63
  64   def findResourceEventsForReceivedPeriod(userId: String, startTimeMillis: Long, stopTimeMillis: Long): List[ResourceEvent]
  65
  66   /**
  67    * Count and return the number of "out of sync" events for a billing month.
  68    */
  69   def countOutOfSyncEventsForBillingPeriod(userId: String, startMillis: Long, stopMillis: Long): Maybe[Long]
  70
  71   /**
  72    * Finds all relevant resource events for the billing period.
  73    * The relevant events are those:
  74    * a) whose `occurredMillis` is within the given billing period or
  75    * b) whose `receivedMillis` is within the given billing period.
  76    *
  77    * Order them by `occurredMillis`
  78    * FIXME: implement
  79    */
  80   def findAllRelevantResourceEventsForBillingPeriod(userId: String,
  81                                                     startMillis: Long,
  82                                                     stopMillis: Long): List[ResourceEvent]
  83 }