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.impl;
\r
27 import java.util.ArrayList;
\r
28 import java.util.List;
\r
30 import org.onap.dmaap.datarouter.authz.AuthorizationResponse;
\r
31 import org.onap.dmaap.datarouter.authz.AuthorizationResponseSupplement;
\r
34 /** A representation of an authorization response returned by a XACML Policy Decision Point.
\r
35 * In Data Router R1, advice and obligations are not used.
\r
36 * @author J. F. Lucas
\r
39 public class AuthRespImpl implements AuthorizationResponse {
\r
40 private boolean authorized;
\r
41 private List<AuthorizationResponseSupplement> advice;
\r
42 private List<AuthorizationResponseSupplement> obligations;
\r
44 /** Constructor. This version will not be used in Data Router R1 since we will not have advice and obligations.
\r
46 * @param authorized flag indicating whether the response carried a permit response (<code>true</code>)
\r
47 * or something else (<code>false</code>).
\r
48 * @param advice list of advice elements returned in the response.
\r
49 * @param obligations list of obligation elements returned in the response.
\r
51 private AuthRespImpl(boolean authorized, List<AuthorizationResponseSupplement> advice,
\r
52 List<AuthorizationResponseSupplement> obligations) {
\r
53 this.authorized = authorized;
\r
54 this.advice = (advice == null ? null : new ArrayList<>(advice));
\r
55 this.obligations = (obligations == null ? null : new ArrayList<>(obligations));
\r
58 /** Constructor. Simple version for authorization responses that have no advice and no obligations.
\r
60 * @param authorized flag indicating whether the response carried a permit (<code>true</code>)
\r
61 * or something else (<code>false</code>).
\r
63 AuthRespImpl(boolean authorized) {
\r
64 this(authorized, null, null);
\r
68 * Indicates whether the request is authorized or not.
\r
70 * @return a boolean flag that is <code>true</code> if the request is permitted, and <code>false</code> otherwise.
\r
73 public boolean isAuthorized() {
\r
78 * Returns any advice elements that were included in the authorization response.
\r
80 * @return A list of objects implementing the <code>AuthorizationResponseSupplement</code> interface,
\r
81 * with each object representing an advice element from the authorization response.
\r
84 public List<AuthorizationResponseSupplement> getAdvice() {
\r
89 * Returns any obligation elements that were included in the authorization response.
\r
91 * @return A list of objects implementing the <code>AuthorizationResponseSupplement</code> interface,
\r
92 * with each object representing an obligation element from the authorization response.
\r
95 public List<AuthorizationResponseSupplement> getObligations() {
\r