Update project structure to org.onap

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

new file mode 100644 (file)

index 0000000..fae27ee
--- /dev/null
+++ b/datarouter-prov/src/main/java/org/onap/dmaap/datarouter/authz/impl/package.html
@@ -0,0 +1,68 @@
+#-------------------------------------------------------------------------------\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
+<head>\r
+</head>\r
+<body>\r
+<p>\r
+This package provides an implementation of the authorization-related interfaces \r
+defined by the <code>com.att.research.datarouter.authz</code> package, intended for\r
+use with the provisioning server for Data Router Release 1.   In DR R1, we do not\r
+have an external policy engine, so this implementation performs the authorization\r
+locally.\r
+</p>\r
+<p>\r
+In order to perform the authorization, this package needs access to provisioning data \r
+about feeds and subscriptions.  This package defines an interface\r
+(<code>com.att.research.datarouter.authz.impl.ProvDataProvider</code>) through which it\r
+expects to get this data.   The provisioning server code must provide an implementation\r
+of this interface.\r
+</p>\r
+<p>\r
+A software component that wishes to use this implementation must:\r
+<ul>\r
+<li>Provide an implementation of the \r
+<code>com.att.research.datarouter.authz.impl.ProvDataProvider</code>\r
+interface.\r
+</li>\r
+<li>\r
+Create an instance of the <code>ProvDataProvider</code> implementation.\r
+<li>\r
+Create an instance of the\r
+<code>com.att.research.datarouter.authz.impl.ProvAuthorizer</code>\r
+class defined in this package, passing it an instance of the <code>ProvDataProvider</code>\r
+implementation.\r
+</li>\r
+</ul>\r
+</p>\r
+<p>\r
+Example:\r
+<pre>\r
+<code>\r
+ProvDataProvider dataProv = new MyDataProvider();\r
+Authorizer authz = new ProvAuthorizer(dataProv);\r
+</code>\r
+</pre>\r
+</body>\r
+</html>\r