aboutsummaryrefslogtreecommitdiffstats
path: root/datarouter-prov/src/main/java/org/onap/dmaap/datarouter/authz/impl/AuthRespImpl.java
blob: c7d71996a3107bec524f21e5869c0d2639c4a57f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
/*******************************************************************************
 * ============LICENSE_START==================================================
 * * org.onap.dmaap
 * * ===========================================================================
 * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
 * * ===========================================================================
 * * Licensed under the Apache License, Version 2.0 (the "License");
 * * you may not use this file except in compliance with the License.
 * * You may obtain a copy of the License at
 * *
 *  *      http://www.apache.org/licenses/LICENSE-2.0
 * *
 *  * Unless required by applicable law or agreed to in writing, software
 * * distributed under the License is distributed on an "AS IS" BASIS,
 * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * * See the License for the specific language governing permissions and
 * * limitations under the License.
 * * ============LICENSE_END====================================================
 * *
 * * ECOMP is a trademark and service mark of AT&T Intellectual Property.
 * *
 ******************************************************************************/


package org.onap.dmaap.datarouter.authz.impl;

import java.util.ArrayList;
import java.util.List;

import org.onap.dmaap.datarouter.authz.AuthorizationResponse;
import org.onap.dmaap.datarouter.authz.AuthorizationResponseSupplement;


/** A representation of an authorization response returned by a XACML Policy Decision Point.
 *  In Data Router R1, advice and obligations are not used.
 * @author J. F. Lucas
 *
 */
public class AuthRespImpl implements AuthorizationResponse {
    private boolean authorized;
    private List<AuthorizationResponseSupplement> advice;
    private List<AuthorizationResponseSupplement> obligations;

    /** Constructor.  This version will not be used in Data Router R1 since we will not have advice and obligations.
     *
     * @param authorized flag indicating whether the response carried a permit response (<code>true</code>)
     *                   or something else (<code>false</code>).
     * @param advice list of advice elements returned in the response.
     * @param obligations list of obligation elements returned in the response.
     */
    private AuthRespImpl(boolean authorized, List<AuthorizationResponseSupplement> advice,
            List<AuthorizationResponseSupplement> obligations) {
        this.authorized = authorized;
        this.advice = (advice == null ? null : new ArrayList<>(advice));
        this.obligations = (obligations == null ? null : new ArrayList<>(obligations));
    }

    /** Constructor.  Simple version for authorization responses that have no advice and no obligations.
     *
     * @param authorized flag indicating whether the response carried a permit (<code>true</code>)
     *                   or something else (<code>false</code>).
     */
    AuthRespImpl(boolean authorized) {
        this(authorized, null, null);
    }

    /**
     * Indicates whether the request is authorized or not.
     *
     * @return a boolean flag that is <code>true</code> if the request is permitted, and <code>false</code> otherwise.
     */
    @Override
    public boolean isAuthorized() {
        return authorized;
    }

    /**
     * Returns any advice elements that were included in the authorization response.
     *
     * @return A list of objects implementing the <code>AuthorizationResponseSupplement</code> interface,
     * with each object representing an advice element from the authorization response.
     */
    @Override
    public List<AuthorizationResponseSupplement> getAdvice() {
        return advice;
    }

    /**
     * Returns any obligation elements that were included in the authorization response.
     *
     * @return A list of objects implementing the <code>AuthorizationResponseSupplement</code> interface,
     * with each object representing an obligation element from the authorization response.
     */
    @Override
    public List<AuthorizationResponseSupplement> getObligations() {
        return obligations;
    }

}