Update project structure to org.onap

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

diff --git a/datarouter-prov/src/main/java/org/onap/dmaap/datarouter/authz/AuthorizationResponseSupplement.java b/datarouter-prov/src/main/java/org/onap/dmaap/datarouter/authz/AuthorizationResponseSupplement.java
new file mode 100644 (file)
index 0000000..adb44ba
--- /dev/null
+++ b/datarouter-prov/src/main/java/org/onap/dmaap/datarouter/authz/AuthorizationResponseSupplement.java
@@ -0,0 +1,52 @@
+/*******************************************************************************\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
+\r
+package org.onap.dmaap.datarouter.authz;\r
+\r
+import java.util.Map;\r
+\r
+/** An object that meets the <code>AuthorizationResponseSupplement</code> interface carries supplementary\r
+ * information for an authorization response.  In a XACML-based system, a response to an authorization request\r
+ * carries not just the permit/deny decision but, optionally, supplemental information in the form of advice and\r
+ * obligation elements.  The structure of a XACML advice element and a XACML obligation element are similar: each has an identifier and\r
+ * a set of attributes (name-value) pairs.  (The difference between a XACML advice element and a XACML obligation element is in\r
+ * how the recipient of the response--the Policy Enforcement Point, in XACML terminology--handles the element.)\r
+ * \r
+ * @author J. F. Lucas\r
+ *\r
+ */\r
+public interface AuthorizationResponseSupplement {\r
+       /** Return the identifier for the supplementary information element.\r
+        * \r
+        * @return a <code>String</code> containing the identifier.\r
+        */\r
+       public String getId();\r
+       \r
+       /** Return the attributes for the supplementary information element, as a <code>Map</code> in which\r
+        * keys represent attribute identifiers and values represent attribute values.\r
+        * \r
+        * @return attributes for the supplementary information element.\r
+        */\r
+       public Map<String, String> getAttributes();\r
+}\r