Update project structure to org.onap

[dmaap/datarouter.git] / datarouter-prov / src / main / java / org / onap / dmaap / datarouter / reports / package.html
diff --git a/datarouter-prov/src/main/java/org/onap/dmaap/datarouter/reports/package.html b/datarouter-prov/src/main/java/org/onap/dmaap/datarouter/reports/package.html

new file mode 100644 (file)

index 0000000..2c2d26b
--- /dev/null
+++ b/datarouter-prov/src/main/java/org/onap/dmaap/datarouter/reports/package.html
@@ -0,0 +1,43 @@
+#-------------------------------------------------------------------------------\r
+# ============LICENSE_START==================================================\r
+# * org.onap.dmaap\r
+# * ===========================================================================\r
+# * Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
+# * ===========================================================================\r
+# * Licensed under the Apache License, Version 2.0 (the "License");\r
+# * you may not use this file except in compliance with the License.\r
+# * You may obtain a copy of the License at\r
+# * \r
+#  *      http://www.apache.org/licenses/LICENSE-2.0\r
+# * \r
+#  * Unless required by applicable law or agreed to in writing, software\r
+# * distributed under the License is distributed on an "AS IS" BASIS,\r
+# * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+# * See the License for the specific language governing permissions and\r
+# * limitations under the License.\r
+# * ============LICENSE_END====================================================\r
+# *\r
+# * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
+# *\r
+#-------------------------------------------------------------------------------\r
+\r
+<html>\r
+<body>\r
+<p>\r
+This package provides various classes which are used to generate .CSV files from the logs\r
+in the database.\r
+The .CSV files can then be used to generate reports on another web server external from the DR network.\r
+</p>\r
+<p>\r
+The classes in this package, and the reports they generate are:\r
+</p>\r
+<table>\r
+<tr><th>Class</th><th>Report</th></tr>\r
+<tr><td>{@link com.att.research.datarouter.reports.DailyLatencyReport}</td><td>dailylatency.csv</td></tr>\r
+<tr><td>{@link com.att.research.datarouter.reports.FeedReport}</td><td>NOT CURRENTLY USED</td></tr>\r
+<tr><td>{@link com.att.research.datarouter.reports.LatencyReport}</td><td></td></tr>\r
+<tr><td>{@link com.att.research.datarouter.reports.SubscriberReport}</td><td>subscriber.csv</td></tr>\r
+<tr><td>{@link com.att.research.datarouter.reports.VolumeReport}</td><td>volumes.csv</td></tr>\r
+</table>\r
+</body>\r
+</html>\r