1 /*******************************************************************************
\r
2 * ============LICENSE_START==================================================
\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
11 * * http://www.apache.org/licenses/LICENSE-2.0
\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
20 * * ECOMP is a trademark and service mark of AT&T Intellectual Property.
\r
22 ******************************************************************************/
\r
25 package org.onap.dmaap.datarouter.authz;
\r
27 import java.util.Map;
\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:
\r
33 * each has an identifier and a set of attributes (name-value) pairs.
\r
34 * (The difference between a XACML advice element and a XACML obligation element is in
\r
35 * how the recipient of the response--the Policy Enforcement Point, in XACML terminology--handles the element.)
\r
37 * @author J. F. Lucas
\r
40 public interface AuthorizationResponseSupplement {
\r
42 /** Return the identifier for the supplementary information element.
\r
44 * @return a <code>String</code> containing the identifier.
\r
46 public String getId();
\r
48 /** Return the attributes for the supplementary information element, as a <code>Map</code> in which
\r
49 * keys represent attribute identifiers and values represent attribute values.
\r
51 * @return attributes for the supplementary information element.
\r
53 public Map<String, String> getAttributes();
\r