datarouter-prov/src/main/java/com/att/research/datarouter/authz/AuthorizationResponseSupplement.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 \r
  25 package com.att.research.datarouter.authz;\r
  26 \r
  27 import java.util.Map;\r
  28 \r
  29 /** An object that meets the <code>AuthorizationResponseSupplement</code> interface carries supplementary\r
  30  * information for an authorization response.  In a XACML-based system, a response to an authorization request\r
  31  * carries not just the permit/deny decision but, optionally, supplemental information in the form of advice and\r
  32  * obligation elements.  The structure of a XACML advice element and a XACML obligation element are similar: each has an identifier and\r
  33  * a set of attributes (name-value) pairs.  (The difference between a XACML advice element and a XACML obligation element is in\r
  34  * how the recipient of the response--the Policy Enforcement Point, in XACML terminology--handles the element.)\r
  35  * \r
  36  * @author J. F. Lucas\r
  37  *\r
  38  */\r
  39 public interface AuthorizationResponseSupplement {\r
  40         /** Return the identifier for the supplementary information element.\r
  41          * \r
  42          * @return a <code>String</code> containing the identifier.\r
  43          */\r
  44         public String getId();\r
  45         \r
  46         /** Return the attributes for the supplementary information element, as a <code>Map</code> in which\r
  47          * keys represent attribute identifiers and values represent attribute values.\r
  48          * \r
  49          * @return attributes for the supplementary information element.\r
  50          */\r
  51         public Map<String, String> getAttributes();\r
  52 }\r