aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/forwarding-plugins/src/main/java/org/onap/policy/distribution/forwarding/xacml/pdp/XacmlPdpPolicyForwarderParameterGroup.java
blob: 5c547673178b5cb7b8428fe9fd789b0d418a91fb (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
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2018 Ericsson. All rights reserved.
 *  Modifications Copyright (C) 2019 AT&T Intellectual Property.
 * ================================================================================
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.distribution.forwarding.xacml.pdp;

import org.onap.policy.common.parameters.GroupValidationResult;
import org.onap.policy.common.parameters.ValidationStatus;
import org.onap.policy.common.utils.validation.ParameterValidationUtils;
import org.onap.policy.distribution.main.parameters.PolicyForwarderConfigurationParameterGroup;

/**
 * Holds the parameters for the{@link XacmlPdpPolicyForwarder}.
 */
public class XacmlPdpPolicyForwarderParameterGroup extends PolicyForwarderConfigurationParameterGroup {
    public static final String POLICY_FORWARDER_PLUGIN_CLASS = XacmlPdpPolicyForwarder.class.getName();

    private boolean useHttps;
    private String hostname;
    private int port;
    private String userName;
    private String password;
    private String clientAuth;
    private boolean isManaged;
    private String pdpGroup;

    /**
     * Construct an instance.
     *
     * @param builder the builder create the instance from
     */
    private XacmlPdpPolicyForwarderParameterGroup(final XacmlPdpPolicyForwarderParameterGroupBuilder builder) {
        this.useHttps = builder.useHttps;
        this.hostname = builder.hostname;
        this.port = builder.port;
        this.userName = builder.userName;
        this.password = builder.password;
        this.clientAuth = builder.clientAuth;
        this.isManaged = builder.isManaged;
        this.pdpGroup = builder.pdpGroup;
    }

    public boolean isUseHttps() {
        return useHttps;
    }

    public String getHostname() {
        return hostname;
    }

    public int getPort() {
        return port;
    }

    public String getUserName() {
        return userName;
    }

    public String getPassword() {
        return password;
    }

    public String getClientAuth() {
        return clientAuth;
    }

    public boolean isManaged() {
        return isManaged;
    }

    public String getPdpGroup() {
        return pdpGroup;
    }

    /**
     * Builder for XacmlPdpPolicyForwarderParameterGroup.
     */
    public static class XacmlPdpPolicyForwarderParameterGroupBuilder {
        private boolean useHttps = false;
        private String hostname;
        private int port;
        private String userName;
        private String password;
        private String clientAuth;
        private boolean isManaged = true;
        private String pdpGroup;

        public XacmlPdpPolicyForwarderParameterGroupBuilder setUseHttps(final boolean useHttps) {
            this.useHttps = useHttps;
            return this;
        }

        public XacmlPdpPolicyForwarderParameterGroupBuilder setHostname(final String hostname) {
            this.hostname = hostname;
            return this;
        }

        public XacmlPdpPolicyForwarderParameterGroupBuilder setPort(final int port) {
            this.port = port;
            return this;
        }

        public XacmlPdpPolicyForwarderParameterGroupBuilder setUserName(final String userName) {
            this.userName = userName;
            return this;
        }

        public XacmlPdpPolicyForwarderParameterGroupBuilder setPassword(final String password) {
            this.password = password;
            return this;
        }

        public XacmlPdpPolicyForwarderParameterGroupBuilder setClientAuth(final String clientAuth) {
            this.clientAuth = clientAuth;
            return this;
        }

        public XacmlPdpPolicyForwarderParameterGroupBuilder setIsManaged(final boolean isManaged) {
            this.isManaged = isManaged;
            return this;
        }

        public XacmlPdpPolicyForwarderParameterGroupBuilder setPdpGroup(final String pdpGroup) {
            this.pdpGroup = pdpGroup;
            return this;
        }

        /**
         * Creates a new XacmlPapServletPolicyForwarderParameterGroup instance.
         */
        public XacmlPdpPolicyForwarderParameterGroup build() {
            return new XacmlPdpPolicyForwarderParameterGroup(this);
        }
    }

    @Override
    public GroupValidationResult validate() {
        final GroupValidationResult validationResult = new GroupValidationResult(this);
        if (!ParameterValidationUtils.validateStringParameter(hostname)) {
            validationResult.setResult("hostname", ValidationStatus.INVALID,
                    "must be a non-blank string containing hostname/ipaddress");
        }
        if (!ParameterValidationUtils.validateIntParameter(port)) {
            validationResult.setResult("port", ValidationStatus.INVALID, "must be a positive integer containing port");
        }
        if (!ParameterValidationUtils.validateStringParameter(userName)) {
            validationResult.setResult("userName", ValidationStatus.INVALID,
                    "must be a non-blank string containing userName");
        }
        if (!ParameterValidationUtils.validateStringParameter(password)) {
            validationResult.setResult("password", ValidationStatus.INVALID,
                    "must be a non-blank string containing password");
        }
        if (!ParameterValidationUtils.validateStringParameter(clientAuth)) {
            validationResult.setResult("clientAuth", ValidationStatus.INVALID,
                    "must be a non-blank string containing clientAuth");
        }
        if (!ParameterValidationUtils.validateStringParameter(pdpGroup)) {
            validationResult.setResult("pdpGroup", ValidationStatus.INVALID,
                    "must be a non-blank string containing pdpGroup");
        }
        return validationResult;
    }

}