code.grnet.gr Git - aquarium/blob - src/main/avro/aquarium-user-state.avdl

   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 @namespace("gr.grnet.aquarium.message.avro.gen")
  37 protocol AquariumUserState {
  38   import idl "aquarium-policy.avdl";
  39   import idl "aquarium-anyvalue.avdl";
  40   import idl "aquarium-events.avdl";
  41
  42   record UserAgreementMsg {
  43     string id;
  44     union {string, null} relatedIMEventID;
  45     long @order("ascending") validFromMillis;
  46     long validToMillis;
  47     string role;
  48     union {FullPriceTableMsg, null} fullPriceTableRef; // If null, then get from aquarium policy
  49   }
  50
  51   record WorkingResourceInstanceChargingStateMsg {
  52     map<AnyValueMsg> details;
  53     array<ResourceEventMsg> previousEvents;
  54     array<ResourceEventMsg> implicitlyIssuedStartEvents;
  55     double accumulatingAmount;
  56     double oldAccumulatingAmount;
  57     double previousValue;
  58     double currentValue;
  59   }
  60
  61   record WorkingResourcesChargingStateMsg {
  62     map<AnyValueMsg> details;
  63     map<WorkingResourceInstanceChargingStateMsg> stateOfResourceInstance;
  64   }
  65
  66   record WorkingAgreementHistoryMsg {
  67     array<UserAgreementMsg> agreements;
  68   }
  69
  70   record ChargeslotMsg {
  71     long startMillis;
  72     long stopMillis;
  73     double unitPrice;
  74     string explanation = "";
  75     double creditsToSubtract;
  76   }
  77
  78   record WalletEntryMsg {
  79     string userID;
  80     double sumOfCreditsToSubtract;
  81     double oldTotalCredits;
  82     double newTotalCredits;
  83     long whenComputedMillis;
  84     long referenceStartMillis;
  85     long referenceStopMillis;
  86     int billingYear;
  87     int billingMonth;
  88     int billingDay;
  89     array<ChargeslotMsg> chargeslots;
  90     array<ResourceEventMsg> resourceEvents; // current is the last one
  91     ResourceTypeMsg resourceType;
  92     boolean isSynthetic = false;
  93   }
  94
  95   record WorkingUserStateMsg {
  96     string userID;
  97     union {string, null} parentUserStateIDInStore;
  98     map<ResourceTypeMsg> resourceTypesMap;
  99     map<WorkingResourcesChargingStateMsg> workingStateOfResources;
 100     double totalCredits;
 101     WorkingAgreementHistoryMsg workingAgreementHistory;
 102     long latestUpdateMillis;
 103     long latestResourceEventOccurredMillis;
 104     long billingPeriodOutOfSyncResourceEventsCounter;
 105     array<WalletEntryMsg> walletEntries;
 106   }
 107 }