Aquarium

/*

 * 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

 * conditions are met:

 *

 *   1. Redistributions of source code must retain the above

 *      copyright notice, this list of conditions and the following

 *      disclaimer.

 *

 *   2. Redistributions in binary form must reproduce the above

 *      copyright notice, this list of conditions and the following

 *      disclaimer in the documentation and/or other materials

 *      provided with the distribution.

 *

 * THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS

 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR

 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF

 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED

 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN

 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

 * POSSIBILITY OF SUCH DAMAGE.

 *

 * The views and conclusions contained in the software and

 * documentation are those of the authors and should not be

 * interpreted as representing official policies, either expressed

 * or implied, of GRNET S.A.

 */

package gr.grnet.aquarium.charging.state

import gr.grnet.aquarium.message.avro.gen.{UserAgreementMsg, IMEventMsg, UserAgreementHistoryMsg, UserStateMsg}

import gr.grnet.aquarium.Real

import scala.collection.immutable

import gr.grnet.aquarium.policy.UserAgreementModel

import gr.grnet.aquarium.message.avro.{MessageFactory, MessageHelpers, ModelFactory}

import gr.grnet.aquarium.logic.accounting.dsl.Timeslot

/**

 *

 * A wrapper around [[gr.grnet.aquarium.message.avro.gen.UserStateMsg]] and

 * [[]] with convenient (sorted)

 * user agreement history.

 *

 * @author Christos KK Loverdos <loverdos@gmail.com>

 */

final class UserStateModel(

    private[this] var _userStateMsg: UserStateMsg,

    private[this] var _userAgreementHistoryMsg: UserAgreementHistoryMsg

) {

  require(this._userStateMsg ne null, "this._userStateMsg ne null")

  require(this._userAgreementHistoryMsg ne null, "this._userAgreementHistoryMsg ne null")

  private[this] var _isInitial = true

  private[this] var _latestIMEventOccurredMillis = 0L

  private[this] var _userCreationIMEventMsgOpt: Option[IMEventMsg] = None

  private[this] var _userAgreementModels: immutable.SortedSet[UserAgreementModel] = {

    var userAgreementModels = immutable.SortedSet[UserAgreementModel]()

    val userAgreements = _userAgreementHistoryMsg.getAgreements.iterator()

    while(userAgreements.hasNext) {

      val userAgreement = userAgreements.next()

      val userAgreementModel = ModelFactory.newUserAgreementModel(userAgreement)

      userAgreementModels += userAgreementModel

      checkUserCreationIMEvent(userAgreement.getRelatedIMEventMsg)

      checkLatestIMEventOccurredMillis(userAgreement.getRelatedIMEventMsg)

    }

    userAgreementModels

  }

  private[this] def checkUserCreationIMEvent(imEvent: IMEventMsg) {

    if(MessageHelpers.isUserCreationIMEvent(imEvent)) {

      this._userCreationIMEventMsgOpt = Some(imEvent)

    }

  }

  private[this] def checkLatestIMEventOccurredMillis(imEvent: IMEventMsg) {

    if(imEvent ne null) {

      if(this._latestIMEventOccurredMillis < imEvent.getOccurredMillis) {

        this._latestIMEventOccurredMillis = imEvent.getOccurredMillis

      }

    }

  }

  private[this] def updateOtherVars(imEvent: IMEventMsg) {

    this._isInitial = false

    checkUserCreationIMEvent(imEvent)

    checkLatestIMEventOccurredMillis(imEvent)

  }

  def isInitial = this._isInitial

  def userID = this._userAgreementHistoryMsg.getUserID

  def latestIMEventOccurredMillis = this._latestIMEventOccurredMillis

  def hasUserCreationEvent = this._userCreationIMEventMsgOpt.isDefined

  def userCreationIMEventOpt = this._userCreationIMEventMsgOpt

  def unsafeUserCreationIMEvent = this._userCreationIMEventMsgOpt.get

  def unsafeUserCreationMillis = unsafeUserCreationIMEvent.getOccurredMillis

  def size: Int = _userAgreementHistoryMsg.getAgreements.size()

  def userStateMsg = this._userStateMsg

  def updateUserStateMsg(msg: UserStateMsg) {

    this._userStateMsg = msg

    this._isInitial = false

  }

  def userAgreementHistoryMsg = this._userAgreementHistoryMsg

  def updateUserAgreementHistoryMsg(msg: UserAgreementHistoryMsg) {

    this._userAgreementHistoryMsg = msg

    this._isInitial = false

  }

  def agreementByTimeslot: immutable.SortedMap[Timeslot, UserAgreementModel] = {

    immutable.TreeMap(_userAgreementModels.map(ag ⇒ (ag.timeslot, ag)).toSeq: _*)

  }

  def insertUserAgreementModel(userAgreement: UserAgreementModel) {

    MessageHelpers.insertUserAgreement(this._userAgreementHistoryMsg, userAgreement.msg)

    this._userAgreementModels += userAgreement

    updateOtherVars(userAgreement.msg.getRelatedIMEventMsg)

  }

  def insertUserAgreementMsg(userAgreementMsg: UserAgreementMsg) {

    insertUserAgreementModel(ModelFactory.newUserAgreementModel(userAgreementMsg))

  }

  def insertUserAgreementMsgFromIMEvent(imEvent: IMEventMsg) {

    val userAgreementMsg = MessageFactory.newUserAgreementFromIMEventMsg(imEvent)

    insertUserAgreementMsg(userAgreementMsg)

  }

  def oldestAgreementModel: Option[UserAgreementModel] = {

    _userAgreementModels.headOption

  }

  def newestAgreementModel: Option[UserAgreementModel] = {

    _userAgreementModels.lastOption

  }

  def latestResourceEventOccurredMillis = this._userStateMsg.getLatestResourceEventOccurredMillis

  @inline final def totalCreditsAsReal: Real = Real(this._userStateMsg.getTotalCredits)

  @inline final def totalCredits: String = this._userStateMsg.getTotalCredits

  override def toString = _userStateMsg.toString

}