datarouter-prov/src/main/java/com/att/research/datarouter/reports/package.html

   1 #-------------------------------------------------------------------------------\r
   2 # ============LICENSE_START==================================================\r
   3 # * org.onap.dmaap\r
   4 # * ===========================================================================\r
   5 # * Copyright © 2017 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 # * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
  21 # *\r
  22 #-------------------------------------------------------------------------------\r
  23 \r
  24 <html>\r
  25 <body>\r
  26 <p>\r
  27 This package provides various classes which are used to generate .CSV files from the logs\r
  28 in the database.\r
  29 The .CSV files can then be used to generate reports on another web server external from the DR network.\r
  30 </p>\r
  31 <p>\r
  32 The classes in this package, and the reports they generate are:\r
  33 </p>\r
  34 <table>\r
  35 <tr><th>Class</th><th>Report</th></tr>\r
  36 <tr><td>{@link com.att.research.datarouter.reports.DailyLatencyReport}</td><td>dailylatency.csv</td></tr>\r
  37 <tr><td>{@link com.att.research.datarouter.reports.FeedReport}</td><td>NOT CURRENTLY USED</td></tr>\r
  38 <tr><td>{@link com.att.research.datarouter.reports.LatencyReport}</td><td></td></tr>\r
  39 <tr><td>{@link com.att.research.datarouter.reports.SubscriberReport}</td><td>subscriber.csv</td></tr>\r
  40 <tr><td>{@link com.att.research.datarouter.reports.VolumeReport}</td><td>volumes.csv</td></tr>\r
  41 </table>\r
  42 </body>\r
  43 </html>\r