Update project structure to org.onap

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

diff --git a/datarouter-prov/src/main/java/org/onap/dmaap/datarouter/authz/impl/ProvDataProvider.java b/datarouter-prov/src/main/java/org/onap/dmaap/datarouter/authz/impl/ProvDataProvider.java
new file mode 100644 (file)
index 0000000..580fe99
--- /dev/null
+++ b/datarouter-prov/src/main/java/org/onap/dmaap/datarouter/authz/impl/ProvDataProvider.java
@@ -0,0 +1,66 @@
+/*******************************************************************************\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
+package org.onap.dmaap.datarouter.authz.impl;\r
+\r
+/** Interface to access data about subscriptions and feeds.  A software component that \r
+ * uses the <code>ProvAuthorizer</code> needs to supply an implementation of this interface.\r
+ * @author J. F. Lucas\r
+ *\r
+ */\r
+public interface ProvDataProvider {\r
+       \r
+       /** Get the identity of the owner of a feed.\r
+        * \r
+        * @param feedId the feed ID of the feed whose owner is being looked up.\r
+        * @return the feed owner's identity\r
+        */\r
+       public String getFeedOwner(String feedId);\r
+       \r
+       /** Get the security classification of a feed.\r
+        * \r
+        * @param feedId the ID of the feed whose classification is being looked up.\r
+        * @return the classification of the feed.\r
+        */\r
+       public String getFeedClassification(String feedId);\r
+       \r
+       /** Get the identity of the owner of a feed\r
+        * \r
+        * @param subId the ID of the subscripition whose owner is being looked up.\r
+        * @return the subscription owner's identity.\r
+        */\r
+       public String getSubscriptionOwner(String subId);\r
+\r
+       /** Get the identity of the owner of a feed by group id -  Rally : US708115\r
+        * \r
+        * @param feedid, user the ID of the feed whose owner is being looked up.\r
+        * @return the feed owner's identity by group.\r
+        */\r
+       public String getGroupByFeedGroupId(String owner, String feedId);\r
+       \r
+       /** Get the identity of the owner of a sub by group id Rally : US708115\r
+        * \r
+        * @param subid, user the ID of the feed whose owner is being looked up.\r
+        * @return the feed owner's identity by group.\r
+        */\r
+       public String getGroupBySubGroupId(String owner, String subId);\r
+}\r