/*
- * Copyright 2011 GRNET S.A. All rights reserved.
+ * Copyright 2011-2012 GRNET S.A. All rights reserved.
*
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the following
package gr.grnet.aquarium.store.mongodb
-import gr.grnet.aquarium.util.Loggable
import com.mongodb.util.JSON
import gr.grnet.aquarium.user.UserState
-import gr.grnet.aquarium.util.displayableObjectInfo
+import gr.grnet.aquarium.user.UserState.{JsonNames => UserStateJsonNames}
import gr.grnet.aquarium.util.json.JsonSupport
import collection.mutable.ListBuffer
+import gr.grnet.aquarium.event.im.IMEventModel.{Names => IMEventNames}
import gr.grnet.aquarium.store._
-import gr.grnet.aquarium.logic.events.ResourceEvent.{JsonNames => ResourceJsonNames}
-import gr.grnet.aquarium.logic.events.WalletEntry.{JsonNames => WalletJsonNames}
+import gr.grnet.aquarium.event.ResourceEvent.{JsonNames => ResourceJsonNames}
+import gr.grnet.aquarium.event.WalletEntry.{JsonNames => WalletJsonNames}
+import gr.grnet.aquarium.event.PolicyEntry.{JsonNames => PolicyJsonNames}
import java.util.Date
-import com.ckkloverdos.maybe.Maybe
+import gr.grnet.aquarium.logic.accounting.Policy
import com.mongodb._
-import gr.grnet.aquarium.logic.events.{UserEvent, WalletEntry, ResourceEvent, AquariumEvent}
+import org.bson.types.ObjectId
+import gr.grnet.aquarium.event._
+import com.ckkloverdos.maybe.{NoVal, Maybe}
+import im.IMEventModel
+import gr.grnet.aquarium.util._
+import gr.grnet.aquarium.converter.{Conversions, StdConverters}
/**
* Mongodb implementation of the various aquarium stores.
val database: String,
val username: String,
val password: String)
- extends ResourceEventStore with UserStateStore
- with WalletEntryStore with UserEventStore
+ extends ResourceEventStore
+ with UserStateStore
+ with WalletEntryStore
+ with IMEventStore
+ with PolicyStore
with Loggable {
- private[store] lazy val rcEvents = getCollection(MongoDBStore.RESOURCE_EVENTS_COLLECTION)
- private[store] lazy val userStates = getCollection(MongoDBStore.USER_STATES_COLLECTION)
- private[store] lazy val userEvents = getCollection(MongoDBStore.USER_EVENTS_COLLECTION)
- private[store] lazy val walletEntries = getCollection(MongoDBStore.WALLET_ENTRIES_COLLECTION)
+ override type IMEvent = MongoDBIMEvent
+
+ private[store] lazy val resourceEvents = getCollection(MongoDBStore.RESOURCE_EVENTS_COLLECTION)
+ private[store] lazy val userStates = getCollection(MongoDBStore.USER_STATES_COLLECTION)
+ private[store] lazy val imEvents = getCollection(MongoDBStore.IM_EVENTS_COLLECTION)
+ private[store] lazy val unparsedIMEvents = getCollection(MongoDBStore.UNPARSED_IM_EVENTS_COLLECTION)
+ private[store] lazy val walletEntries = getCollection(MongoDBStore.WALLET_ENTRIES_COLLECTION)
+ private[store] lazy val policyEntries = getCollection(MongoDBStore.POLICY_ENTRIES_COLLECTION)
private[this] def getCollection(name: String): DBCollection = {
val db = mongo.getDB(database)
+ //logger.debug("Authenticating to mongo")
if(!db.isAuthenticated && !db.authenticate(username, password.toCharArray)) {
throw new StoreException("Could not authenticate user %s".format(username))
}
db.getCollection(name)
}
- private[this] def _sortByTimestampAsc[A <: AquariumEvent](one: A, two: A): Boolean = {
+ private[this] def _sortByTimestampAsc[A <: AquariumEventModel](one: A, two: A): Boolean = {
if (one.occurredMillis > two.occurredMillis) false
else if (one.occurredMillis < two.occurredMillis) true
else true
}
- private[this] def _sortByTimestampDesc[A <: AquariumEvent](one: A, two: A): Boolean = {
+ private[this] def _sortByTimestampDesc[A <: AquariumEventSkeleton](one: A, two: A): Boolean = {
if (one.occurredMillis < two.occurredMillis) false
else if (one.occurredMillis > two.occurredMillis) true
else true
}
//+ResourceEventStore
- def storeResourceEvent(event: ResourceEvent): Maybe[RecordID] =
- MongoDBStore.storeAquariumEvent(event, rcEvents)
+ def storeResourceEvent(event: ResourceEvent) = {
+ MongoDBStore.storeAny[ResourceEvent](
+ event,
+ resourceEvents,
+ ResourceJsonNames.id,
+ (e) => e.id,
+ MongoDBStore.jsonSupportToDBObject)
+ }
def findResourceEventById(id: String): Maybe[ResourceEvent] =
- MongoDBStore.findById(id, rcEvents, MongoDBStore.dbObjectToResourceEvent)
+ MongoDBStore.findById(id, resourceEvents, MongoDBStore.dbObjectToResourceEvent)
def findResourceEventsByUserId(userId: String)
(sortWith: Option[(ResourceEvent, ResourceEvent) => Boolean]): List[ResourceEvent] = {
val query = new BasicDBObject(ResourceJsonNames.userId, userId)
- MongoDBStore.runQuery(query, rcEvents)(MongoDBStore.dbObjectToResourceEvent)(sortWith)
+ MongoDBStore.runQuery(query, resourceEvents)(MongoDBStore.dbObjectToResourceEvent)(sortWith)
}
def findResourceEventsByUserIdAfterTimestamp(userId: String, timestamp: Long): List[ResourceEvent] = {
val query = new BasicDBObject()
query.put(ResourceJsonNames.userId, userId)
- query.put(ResourceJsonNames.timestamp, new BasicDBObject("$gte", timestamp))
+ query.put(ResourceJsonNames.occurredMillis, new BasicDBObject("$gt", timestamp))
- val sort = new BasicDBObject(ResourceJsonNames.timestamp, 1)
+ val sort = new BasicDBObject(ResourceJsonNames.occurredMillis, 1)
+
+ val cursor = resourceEvents.find(query).sort(sort)
+
+ try {
+ val buffer = new scala.collection.mutable.ListBuffer[ResourceEvent]
+ while(cursor.hasNext) {
+ buffer += MongoDBStore.dbObjectToResourceEvent(cursor.next())
+ }
+ buffer.toList.sortWith(_sortByTimestampAsc)
+ } finally {
+ cursor.close()
+ }
+ }
- val cursor = rcEvents.find(query).sort(sort)
+ def findResourceEventHistory(userId: String, resName: String,
+ instid: Option[String], upTo: Long) : List[ResourceEvent] = {
+ val query = new BasicDBObject()
+ query.put(ResourceJsonNames.userId, userId)
+ query.put(ResourceJsonNames.occurredMillis, new BasicDBObject("$lt", upTo))
+ query.put(ResourceJsonNames.resource, resName)
+
+ instid match {
+ case Some(id) =>
+ Policy.policy.findResource(resName) match {
+ case Some(y) => query.put(ResourceJsonNames.details,
+ new BasicDBObject(y.descriminatorField, instid.get))
+ case None =>
+ }
+ case None =>
+ }
+
+ val sort = new BasicDBObject(ResourceJsonNames.occurredMillis, 1)
+ val cursor = resourceEvents.find(query).sort(sort)
try {
val buffer = new scala.collection.mutable.ListBuffer[ResourceEvent]
while(cursor.hasNext) {
buffer += MongoDBStore.dbObjectToResourceEvent(cursor.next())
}
- buffer.toList
+ buffer.toList.sortWith(_sortByTimestampAsc)
} finally {
cursor.close()
}
}
+
+ def findResourceEventsForReceivedPeriod(userId: String, startTimeMillis: Long, stopTimeMillis: Long): List[ResourceEvent] = {
+ val query = new BasicDBObject()
+ query.put(ResourceJsonNames.userId, userId)
+ query.put(ResourceJsonNames.receivedMillis, new BasicDBObject("$gte", startTimeMillis))
+ query.put(ResourceJsonNames.receivedMillis, new BasicDBObject("$lte", stopTimeMillis))
+
+ // Sort them by increasing order for occurred time
+ val orderBy = new BasicDBObject(ResourceJsonNames.occurredMillis, 1)
+
+ MongoDBStore.runQuery[ResourceEvent](query, resourceEvents, orderBy)(MongoDBStore.dbObjectToResourceEvent)(None)
+ }
+
+ def countOutOfSyncEventsForBillingPeriod(userId: String, startMillis: Long, stopMillis: Long): Maybe[Long] = {
+ Maybe {
+ // FIXME: Implement
+ 0L
+ }
+ }
+
+ def findAllRelevantResourceEventsForBillingPeriod(userId: String,
+ startMillis: Long,
+ stopMillis: Long): List[ResourceEvent] = {
+ // FIXME: Implement
+ Nil
+ }
//-ResourceEventStore
- //+UserStateStore
- def storeUserState(userState: UserState): Maybe[RecordID] =
+ //+ UserStateStore
+ def storeUserState(userState: UserState): Maybe[RecordID] = {
MongoDBStore.storeUserState(userState, userStates)
+ }
def findUserStateByUserId(userId: String): Maybe[UserState] = {
Maybe {
- val query = new BasicDBObject(ResourceJsonNames.userId, userId)
+ val query = new BasicDBObject(UserStateJsonNames.userId, userId)
val cursor = userStates find query
try {
}
}
}
- //-UserStateStore
+
+ def findLatestUserStateForEndOfBillingMonth(userId: String,
+ yearOfBillingMonth: Int,
+ billingMonth: Int): Maybe[UserState] = {
+ NoVal // FIXME: implement
+ }
+
+ def deleteUserState(userId: String) = {
+ val query = new BasicDBObject(UserStateJsonNames.userId, userId)
+ userStates.findAndRemove(query)
+ }
+ //- UserStateStore
//+WalletEntryStore
- def storeWalletEntry(entry: WalletEntry): Maybe[RecordID] =
- MongoDBStore.storeAquariumEvent(entry, walletEntries)
+ def storeWalletEntry(entry: WalletEntry): Maybe[RecordID] = {
+ Maybe {
+ MongoDBStore.storeAny[WalletEntry](
+ entry,
+ walletEntries,
+ ResourceJsonNames.id,
+ (e) => e.id,
+ MongoDBStore.jsonSupportToDBObject)
+ }
+ }
def findWalletEntryById(id: String): Maybe[WalletEntry] =
MongoDBStore.findById[WalletEntry](id, walletEntries, MongoDBStore.dbObjectToWalletEntry)
def findUserWalletEntriesFromTo(userId: String, from: Date, to: Date) : List[WalletEntry] = {
val q = new BasicDBObject()
// TODO: Is this the correct way for an AND query?
- q.put(ResourceJsonNames.timestamp, new BasicDBObject("$gt", from.getTime))
- q.put(ResourceJsonNames.timestamp, new BasicDBObject("$lt", to.getTime))
- q.put(ResourceJsonNames.userId, userId)
+ q.put(WalletJsonNames.occurredMillis, new BasicDBObject("$gt", from.getTime))
+ q.put(WalletJsonNames.occurredMillis, new BasicDBObject("$lt", to.getTime))
+ q.put(WalletJsonNames.userId, userId)
+
+ MongoDBStore.runQuery[WalletEntry](q, walletEntries)(MongoDBStore.dbObjectToWalletEntry)(Some(_sortByTimestampAsc))
+ }
+
+ def findWalletEntriesAfter(userId: String, from: Date) : List[WalletEntry] = {
+ val q = new BasicDBObject()
+ q.put(WalletJsonNames.occurredMillis, new BasicDBObject("$gt", from.getTime))
+ q.put(WalletJsonNames.userId, userId)
MongoDBStore.runQuery[WalletEntry](q, walletEntries)(MongoDBStore.dbObjectToWalletEntry)(Some(_sortByTimestampAsc))
}
def findLatestUserWalletEntries(userId: String) = {
Maybe {
- val orderBy = new BasicDBObject(ResourceJsonNames.occurredMillis, -1) // -1 is descending order
+ val orderBy = new BasicDBObject(WalletJsonNames.occurredMillis, -1) // -1 is descending order
val cursor = walletEntries.find().sort(orderBy)
try {
}
//-WalletEntryStore
- //+UserEventStore
- def storeUserEvent(event: UserEvent): Maybe[RecordID] =
- MongoDBStore.storeAny[UserEvent](event, userEvents, ResourceJsonNames.userId,
- _.userId, MongoDBStore.jsonSupportToDBObject)
+ //+IMEventStore
+ def isLocalIMEvent(event: IMEventModel) = {
+ MongoDBStore.isLocalIMEvent(event)
+ }
+
+ def createIMEventFromJson(json: String) = {
+ MongoDBStore.createIMEventFromJson(json)
+ }
+ def createIMEventFromOther(event: IMEventModel) = {
+ MongoDBStore.createIMEventFromOther(event)
+ }
- def findUserEventById(id: String): Maybe[UserEvent] =
- MongoDBStore.findById[UserEvent](id, userEvents, MongoDBStore.dbObjectToUserEvent)
+// def storeUnparsed(json: String): Maybe[RecordID] = {
+// MongoDBStore.storeJustJson(json, unparsedIMEvents)
+// }
- def findUserEventsByUserId(userId: String)
- (sortWith: Option[(UserEvent, UserEvent) => Boolean]): List[UserEvent] = {
- val query = new BasicDBObject(ResourceJsonNames.userId, userId)
- MongoDBStore.runQuery(query, userEvents)(MongoDBStore.dbObjectToUserEvent)(sortWith)
+ def insertIMEvent(event: IMEventModel): IMEvent = {
+ val localEvent = MongoDBIMEvent.fromOther(event, new ObjectId())
+ MongoDBStore.insertObject(localEvent, imEvents, MongoDBStore.jsonSupportToDBObject)
+ localEvent
+ }
+
+ def findIMEventById(id: String): Maybe[IMEvent] =
+ MongoDBStore.findById[IMEvent](id, imEvents, MongoDBStore.dbObjectToIMEvent)
+
+ def findIMEventsByUserId(userId: String): List[IMEvent] = {
+ val query = new BasicDBObject(IMEventNames.userID, userId)
+ MongoDBStore.runQuery(query, imEvents)(MongoDBStore.dbObjectToIMEvent)(Some(_sortByTimestampAsc))
+ }
+ //-IMEventStore
+
+ //+PolicyStore
+ def loadPolicyEntriesAfter(after: Long): List[PolicyEntry] = {
+ val query = new BasicDBObject(PolicyEntry.JsonNames.validFrom,
+ new BasicDBObject("$gt", after))
+ MongoDBStore.runQuery(query, policyEntries)(MongoDBStore.dbObjectToPolicyEntry)(Some(_sortByTimestampAsc))
}
- //-UserEventStore
+
+ def storePolicyEntry(policy: PolicyEntry): Maybe[RecordID] = MongoDBStore.storePolicyEntry(policy, policyEntries)
+
+
+ def updatePolicyEntry(policy: PolicyEntry) = {
+ //Find the entry
+ val query = new BasicDBObject(PolicyEntry.JsonNames.id, policy.id)
+ val policyObject = MongoDBStore.jsonSupportToDBObject(policy)
+ policyEntries.update(query, policyObject, true, false)
+ }
+
+ def findPolicyEntry(id: String) =
+ MongoDBStore.findById[PolicyEntry](id, policyEntries, MongoDBStore.dbObjectToPolicyEntry)
+
+ //-PolicyStore
}
object MongoDBStore {
+ object JsonNames {
+ final val _id = "_id"
+ }
+
/**
- * Collection holding the [[gr.grnet.aquarium.logic.events.ResourceEvent]]s.
+ * Collection holding the [[gr.grnet.aquarium.event.ResourceEvent]]s.
*
* Resource events are coming from all systems handling billable resources.
*/
/**
* Collection holding the snapshots of [[gr.grnet.aquarium.user.UserState]].
*
- * [[gr.grnet.aquarium.user.UserState]] is held internally within [[gr.grnet.aquarium.user.actor.UserActor]]s.
+ * [[gr.grnet.aquarium.user.UserState]] is held internally within [[gr.grnet.aquarium.actor.service.user .UserActor]]s.
*/
final val USER_STATES_COLLECTION = "userstates"
/**
- * Collection holding [[gr.grnet.aquarium.logic.events.UserEvent]]s.
+ * Collection holding [[gr.grnet.aquarium.event.im.IMEventModel]]s.
*
* User events are coming from the IM module (external).
*/
- final val USER_EVENTS_COLLECTION = "userevents"
+ final val IM_EVENTS_COLLECTION = "imevents"
+ /**
+ * Collection holding [[gr.grnet.aquarium.event.im.IMEventModel]]s that could not be parsed to normal objects.
+ *
+ * We of course assume at least a valid JSON representation.
+ *
+ * User events are coming from the IM module (external).
+ */
+ final val UNPARSED_IM_EVENTS_COLLECTION = "unparsed_imevents"
/**
- * Collection holding [[gr.grnet.aquarium.logic.events.WalletEntry]].
+ * Collection holding [[gr.grnet.aquarium.event.WalletEntry]].
*
* Wallet entries are generated internally in Aquarium.
*/
final val WALLET_ENTRIES_COLLECTION = "wallets"
+ /**
+ * Collection holding [[gr.grnet.aquarium.logic.accounting.dsl.DSLPolicy]].
+ */
+// final val POLICIES_COLLECTION = "policies"
+
+ /**
+ * Collection holding [[gr.grnet.aquarium.event.PolicyEntry]].
+ */
+ final val POLICY_ENTRIES_COLLECTION = "policyEntries"
+
/* TODO: Some of the following methods rely on JSON (de-)serialization).
* A method based on proper object serialization would be much faster.
*/
WalletEntry.fromJson(JSON.serialize(dbObj))
}
- def dbObjectToUserEvent(dbObj: DBObject): UserEvent = {
- UserEvent.fromJson(JSON.serialize(dbObj))
+ def dbObjectToIMEvent(dbObj: DBObject): MongoDBIMEvent = {
+ MongoDBIMEvent.fromJson(JSON.serialize(dbObj))
+ }
+
+ def dbObjectToPolicyEntry(dbObj: DBObject): PolicyEntry = {
+ PolicyEntry.fromJson(JSON.serialize(dbObj))
}
- def findById[A >: Null <: AquariumEvent](id: String, collection: DBCollection, deserializer: (DBObject) => A) : Maybe[A] = Maybe {
+ def findById[A >: Null <: AnyRef](id: String, collection: DBCollection, deserializer: (DBObject) => A) : Maybe[A] =
+ Maybe {
val query = new BasicDBObject(ResourceJsonNames.id, id)
val cursor = collection find query
}
}
- def runQuery[A <: AquariumEvent](query: DBObject, collection: DBCollection, orderBy: DBObject = null)
+ def runQuery[A <: AquariumEventModel](query: DBObject, collection: DBCollection, orderBy: DBObject = null)
(deserializer: (DBObject) => A)
(sortWith: Option[(A, A) => Boolean]): List[A] = {
val cursor0 = collection find query
}
}
- def storeAquariumEvent[A <: AquariumEvent](event: A, collection: DBCollection) : Maybe[RecordID] = {
- storeAny[A](event, collection, ResourceJsonNames.id, (e) => e.id, MongoDBStore.jsonSupportToDBObject)
- }
-
def storeUserState(userState: UserState, collection: DBCollection): Maybe[RecordID] = {
- storeAny[UserState](userState, collection, ResourceJsonNames.userId, _.userId, MongoDBStore.jsonSupportToDBObject)
+ Maybe(storeAny[UserState](userState, collection, ResourceJsonNames.userId, _.userId, MongoDBStore.jsonSupportToDBObject))
+ }
+
+ def storePolicyEntry(policyEntry: PolicyEntry, collection: DBCollection): Maybe[RecordID] = {
+ Maybe(storeAny[PolicyEntry](policyEntry, collection, PolicyJsonNames.id, _.id, MongoDBStore.jsonSupportToDBObject))
}
def storeAny[A](any: A,
collection: DBCollection,
idName: String,
idValueProvider: (A) => String,
- serializer: (A) => DBObject) : Maybe[RecordID] = Maybe {
- // Store
- val dbObj = serializer apply any
- val writeResult = collection insert dbObj
+ serializer: (A) => DBObject) : RecordID = {
+
+ val dbObject = serializer apply any
+ val _id = new ObjectId()
+ dbObject.put("_id", _id)
+ val writeResult = collection.insert(dbObject, WriteConcern.JOURNAL_SAFE)
writeResult.getLastError().throwOnError()
- // Get back to retrieve unique id
- val cursor = collection.find(new BasicDBObject(idName, idValueProvider(any)))
+ RecordID(dbObject.get("_id").toString)
+ }
- try {
- // TODO: better way to get _id?
- if(cursor.hasNext)
- RecordID(cursor.next().get(ResourceJsonNames._id).toString)
- else
- throw new StoreException("Could not store %s to %s".format(any, collection))
- } finally {
- cursor.close()
- }
- }
-
- def jsonSupportToDBObject(any: JsonSupport): DBObject = {
- JSON.parse(any.toJson) match {
- case dbObject: DBObject ⇒
- dbObject
- case _ ⇒
- throw new StoreException("Could not transform %s -> %s".format(displayableObjectInfo(any), classOf[DBObject].getName))
+ def insertObject[A <: MongoDBEventModel](obj: A, collection: DBCollection, serializer: (A) => DBObject) : ObjectId = {
+ val dbObject = serializer apply obj
+ val objectId = obj._id match {
+ case null ⇒
+ val _id = new ObjectId()
+ dbObject.put("_id", _id)
+ _id
+
+ case _id ⇒
+ _id
}
+
+ dbObject.put(JsonNames._id, objectId)
+
+ val writeResult = collection.insert(dbObject, WriteConcern.JOURNAL_SAFE)
+ writeResult.getLastError().throwOnError()
+
+ objectId
+ }
+
+ def jsonSupportToDBObject(jsonSupport: JsonSupport) = {
+ Conversions.jsonSupportToDBObject(jsonSupport)
+ }
+
+ final def isLocalIMEvent(event: IMEventModel) = event match {
+ case _: MongoDBIMEvent ⇒ true
+ case _ ⇒ false
+ }
+
+ final def createIMEventFromJson(json: String) = {
+ MongoDBIMEvent.fromJson(json)
+ }
+
+ final def createIMEventFromOther(event: IMEventModel) = {
+ MongoDBIMEvent.fromOther(event)
+ }
+
+ final def createIMEventFromJsonBytes(jsonBytes: Array[Byte]) = {
+ MongoDBIMEvent.fromJsonBytes(jsonBytes)
}
}
projects / aquarium / blobdiff