datarouter-prov/src/main/java/org/onap/dmaap/datarouter/authz/impl/ProvDataProvider.java

   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 package org.onap.dmaap.datarouter.authz.impl;\r
  25 \r
  26 /** Interface to access data about subscriptions and feeds.  A software component that\r
  27  * uses the <code>ProvAuthorizer</code> needs to supply an implementation of this interface.\r
  28  * @author J. F. Lucas\r
  29  *\r
  30  */\r
  31 public interface ProvDataProvider {\r
  32 \r
  33     /** Get the identity of the owner of a feed.\r
  34      *\r
  35      * @param feedId the feed ID of the feed whose owner is being looked up.\r
  36      * @return the feed owner's identity\r
  37      */\r
  38     public String getFeedOwner(String feedId);\r
  39 \r
  40     /** Get the security classification of a feed.\r
  41      *\r
  42      * @param feedId the ID of the feed whose classification is being looked up.\r
  43      * @return the classification of the feed.\r
  44      */\r
  45     public String getFeedClassification(String feedId);\r
  46 \r
  47     /** Get the identity of the owner of a feed.\r
  48      *\r
  49      * @param subId the ID of the subscripition whose owner is being looked up.\r
  50      * @return the subscription owner's identity.\r
  51      */\r
  52     public String getSubscriptionOwner(String subId);\r
  53 \r
  54     /** Get the identity of the owner of a feed by group id -  Rally : US708115.\r
  55      *\r
  56      * @param feedId user the ID of the feed whose owner is being looked up.\r
  57      * @return the feed owner's identity by group.\r
  58      */\r
  59     public String getGroupByFeedGroupId(String owner, String feedId);\r
  60 \r
  61     /** Get the identity of the owner of a sub by group id Rally : US708115.\r
  62      *\r
  63      * @param subId user the ID of the feed whose owner is being looked up.\r
  64      *\r
  65      * @return the feed owner's identity by group.\r
  66      */\r
  67     public String getGroupBySubGroupId(String owner, String subId);\r
  68 }\r