misc/env/src/main/java/org/onap/aaf/misc/env/Trans.java

   1 /**\r
   2  * ============LICENSE_START====================================================\r
   3  * org.onap.aaf\r
   4  * ===========================================================================\r
   5  * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.\r
   6  * ===========================================================================\r
   7  * Licensed under the Apache License, Version 2.0 (the "License");\r
   8  * you may not use this file except in compliance with the License.\r
   9  * You may obtain a copy of the License at\r
  10  * \r
  11  *      http://www.apache.org/licenses/LICENSE-2.0\r
  12  * \r
  13  * Unless required by applicable law or agreed to in writing, software\r
  14  * distributed under the License is distributed on an "AS IS" BASIS,\r
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16  * See the License for the specific language governing permissions and\r
  17  * limitations under the License.\r
  18  * ============LICENSE_END====================================================\r
  19  *\r
  20  */\r
  21 \r
  22 package org.onap.aaf.misc.env;\r
  23 \r
  24 \r
  25 \r
  26 \r
  27 /**\r
  28  * A Trans is like an Env, however, it's purpose it to track the Transient \r
  29  * Data associated with Transactions, or other short term elements.\r
  30  * \r
  31  * Any Object implementing Trans should expect to go in an out of scope quickly\r
  32  * \r
  33  * Implementations should also overload the concepts of "Start", etc and build up\r
  34  * and Audit Log, so it can implement "metric" below\r
  35  * \r
  36  * All Transactions (i.e. a call to a service) will need these items.\r
  37  * \r
  38  * @author Jonathan\r
  39  *\r
  40  */\r
  41 public interface Trans extends Env {\r
  42     /**\r
  43      * Add a completed entry in the Audit Trail for tracking purposes.\r
  44      * \r
  45      * @param text\r
  46      */\r
  47     public void checkpoint(String text);\r
  48 \r
  49     /**\r
  50      * Add a completed entry in the Audit Trail for tracking purposes, and combine flag with "CHECKPOINT" \r
  51      * \r
  52      * @param text\r
  53      */\r
  54     public void checkpoint(String text, int additionalFlag);\r
  55 \r
  56     /**\r
  57      * Output an Audit Trail onto the StringBuilder\r
  58      *\r
  59      * Load metrics into an array of floats from passed in Flags\r
  60      * \r
  61      * @param flag\r
  62      * @param sb\r
  63      * @return     \r
  64      */\r
  65     public Metric auditTrail(LogTarget lt, int indent, StringBuilder sb, int ... flag);\r
  66 \r
  67     public Metric auditTrail(int indent, StringBuilder sb, int ... flag);\r
  68 \r
  69     public class Metric {\r
  70         public float[] buckets;\r
  71         public float   total;\r
  72         public int     entries;\r
  73     }\r
  74 }