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