datarouter-prov/src/main/java/com/att/research/datarouter/authz/impl/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 <head>\r
  26 </head>\r
  27 <body>\r
  28 <p>\r
  29 This package provides an implementation of the authorization-related interfaces \r
  30 defined by the <code>com.att.research.datarouter.authz</code> package, intended for\r
  31 use with the provisioning server for Data Router Release 1.   In DR R1, we do not\r
  32 have an external policy engine, so this implementation performs the authorization\r
  33 locally.\r
  34 </p>\r
  35 <p>\r
  36 In order to perform the authorization, this package needs access to provisioning data \r
  37 about feeds and subscriptions.  This package defines an interface\r
  38 (<code>com.att.research.datarouter.authz.impl.ProvDataProvider</code>) through which it\r
  39 expects to get this data.   The provisioning server code must provide an implementation\r
  40 of this interface.\r
  41 </p>\r
  42 <p>\r
  43 A software component that wishes to use this implementation must:\r
  44 <ul>\r
  45 <li>Provide an implementation of the \r
  46 <code>com.att.research.datarouter.authz.impl.ProvDataProvider</code>\r
  47 interface.\r
  48 </li>\r
  49 <li>\r
  50 Create an instance of the <code>ProvDataProvider</code> implementation.\r
  51 <li>\r
  52 Create an instance of the\r
  53 <code>com.att.research.datarouter.authz.impl.ProvAuthorizer</code>\r
  54 class defined in this package, passing it an instance of the <code>ProvDataProvider</code>\r
  55 implementation.\r
  56 </li>\r
  57 </ul>\r
  58 </p>\r
  59 <p>\r
  60 Example:\r
  61 <pre>\r
  62 <code>\r
  63 ProvDataProvider dataProv = new MyDataProvider();\r
  64 Authorizer authz = new ProvAuthorizer(dataProv);\r
  65 </code>\r
  66 </pre>\r
  67 </body>\r
  68 </html>\r