aboutsummaryrefslogtreecommitdiffstats
path: root/ONAP-XACML/src/main/java/org/onap/policy/xacml/std/pap/StdPDPPolicyParams.java
blob: dddfe2576cbfde11c46060d68f236b3d4eaea4c0 (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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
/*-
 * ============LICENSE_START=======================================================
 * ONAP-XACML
 * ================================================================================
 * Copyright (C) 2018 Samsung Electronics Co., Ltd. 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=========================================================
 */

package org.onap.policy.xacml.std.pap;

import java.net.URI;

/**
 * Parameters class for StdPDPPolicy
 */
public class StdPDPPolicyParams {
    private String id;
    private boolean isRoot;
    private String name;
    private URI location;
    private boolean isValid;
    private String policyId;
    private String description;
    private String version;

    /**
     * Private constructor
     */
    private StdPDPPolicyParams(){
        super();
    }

    /**
     * Get an instance of builder class
     * @return StdPDPPolicyParamsBuilder
     */
    public static StdPDPPolicyParamsBuilder builder() {
        return new StdPDPPolicyParamsBuilder();
    }

    /**
     * Return id
     * @return id
     */
    public String getId() {
        return id;
    }

    /**
     * Boolean to indicate root
     * @return isRoot
     */
    public boolean isRoot() {
        return isRoot;
    }

    /**
     * Get name of policy
     * @return name
     */
    public String getName() {
        return name;
    }

    /**
     * Retrieve the uri
     * @return location
     */
    public URI getLocation() {
        return location;
    }

    /**
     * Check policy valid
     * @return isValid
     */
    public boolean isValid() {
        return isValid;
    }

    /**
     * Retrieve policy id
     * @return policy id
     */
    public String getPolicyId() {
        return policyId;
    }

    /**
     * Description of policy
     * @return description
     */
    public String getDescription() {
        return description;
    }

    /**
     * Retrieve version of policy
     * @return version
     */
    public String getVersion() {
        return version;
    }

    /**
     * Builder class for std pdp policy params class
     */
    public static class StdPDPPolicyParamsBuilder {
        StdPDPPolicyParams m = new StdPDPPolicyParams();

        /**
         * Build the policy params
         * @return stdPdpPolicyParams object
         */
        public StdPDPPolicyParams build() {
            return m;
        }

        /**
         * Set id
         * @param id - provide id
         * @return builder
         */
        public StdPDPPolicyParamsBuilder id(String id) {
            m.id = id;
            return this;
        }

        /**
         * Set whether isRoot
         * @param isRoot - true/false
         * @return builder
         */
        public StdPDPPolicyParamsBuilder isRoot(boolean isRoot) {
            m.isRoot = isRoot;
            return this;
        }

        /**
         * Set name
         * @param name - name of policy
         * @return builder
         */
        public StdPDPPolicyParamsBuilder name(String name) {
            m.name = name;
            return this;
        }

        /**
         * Set location uri
         * @param uri - for location
         * @return builder
         */
        public StdPDPPolicyParamsBuilder location(URI uri) {
            m.location = uri;
            return this;
        }

        /**
         * Set valid flag
         * @param isValid - whether the policy is valid
         * @return builder
         */
        public StdPDPPolicyParamsBuilder isValid(boolean isValid) {
            m.isValid = isValid;
            return this;
        }

        /**
         * Set policy id
         * @param policyId - policy id
         * @return builder
         */
        public StdPDPPolicyParamsBuilder policyId(String policyId) {
            m.policyId = policyId;
            return this;
        }

        /**
         * Set description of policy
         * @param description - of policy
         * @return builder
         */
        public StdPDPPolicyParamsBuilder description(String description) {
            m.description = description;
            return this;
        }

        /**
         * Set version of policy
         * @param version - of policy
         * @return builder
         */
        public StdPDPPolicyParamsBuilder version(String version) {
            m.version = version;
            return this;
        }
    }
}