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
24 package org.onap.dmaap.datarouter.authz;
\r
26 import java.util.List;
\r
29 * The <code>AuthorizationResponse</code> interface gives the caller access to information about an authorization
\r
30 * decision. This information includes the permit/deny decision itself,
\r
31 * along with supplementary information in the form of advice and obligations.
\r
32 * (The advice and obligations will not be used in Data Router R1.)
\r
34 * @author J. F. Lucas
\r
37 public interface AuthorizationResponse {
\r
40 * Indicates whether the request is authorized or not.
\r
42 * @return a boolean flag that is <code>true</code> if the request is permitted, and <code>false</code> otherwise.
\r
44 public boolean isAuthorized();
\r
47 * Returns any advice elements that were included in the authorization response.
\r
49 * @return A list of objects implementing the <code>AuthorizationResponseSupplement</code> interface,
\r
50 * each representing an advice element from the authorization response.
\r
52 public List<AuthorizationResponseSupplement> getAdvice();
\r
55 * Returns any obligation elements that were included in the authorization response.
\r
57 * @return A list of objects implementing the <code>AuthorizationResponseSupplement</code> interface,
\r
58 * each representing an obligation element from the authorization response.
\r
60 public List<AuthorizationResponseSupplement> getObligations();
\r