env/src/main/java/com/att/inno/env/Trans.java

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