59c59e1651af2c021b7af269f332113be81c1ed2
[policy/distribution.git] /
1 /*-
2  * ============LICENSE_START=======================================================
3  *  Copyright (C) 2018 Ericsson. All rights reserved.
4  * ================================================================================
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  *      http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  * SPDX-License-Identifier: Apache-2.0
18  * ============LICENSE_END=========================================================
19  */
20
21 package org.onap.policy.distribution.reception.parameters;
22
23 import org.onap.policy.common.parameters.GroupValidationResult;
24 import org.onap.policy.common.parameters.ParameterGroup;
25 import org.onap.policy.common.parameters.ValidationStatus;
26
27 /**
28  * Class to hold all the policy decoder parameters.
29  *
30  * @author Ram Krishna Verma (ram.krishna.verma@ericsson.com)
31  */
32 public class PolicyDecoderParameters implements ParameterGroup {
33     private String decoderType;
34     private String decoderClassName;
35
36     /**
37      * Constructor for instantiating PolicyDecoderParameters.
38      *
39      * @param decoderType the policy decoder type
40      * @param decoderClassName the policy decoder class name
41      */
42     public PolicyDecoderParameters(final String decoderType, final String decoderClassName) {
43         this.decoderType = decoderType;
44         this.decoderClassName = decoderClassName;
45     }
46
47     /**
48      * Return the decoderType of this PolicyDecoderParameters instance.
49      *
50      * @return the decoderType
51      */
52     public String getDecoderType() {
53         return decoderType;
54     }
55
56     /**
57      * Return the decoderClassName of this PolicyDecoderParameters instance.
58      *
59      * @return the decoderClassName
60      */
61     public String getDecoderClassName() {
62         return decoderClassName;
63     }
64
65     @Override
66     public String getName() {
67         return null;
68     }
69
70     /**
71      * Validate the policy decoder parameters.
72      *
73      */
74     @Override
75     public GroupValidationResult validate() {
76         final GroupValidationResult validationResult = new GroupValidationResult(this);
77         if (decoderType == null || decoderType.trim().length() == 0) {
78             validationResult.setResult("decoderType", ValidationStatus.INVALID, "must be a non-blank string");
79         }
80         if (decoderClassName == null || decoderClassName.trim().length() == 0) {
81             validationResult.setResult("decoderClassName", ValidationStatus.INVALID,
82                     "must be a non-blank string containing full class name of the decoder");
83         } else {
84             validatePolicyDecoderClass(validationResult);
85         }
86         return validationResult;
87     }
88
89     private void validatePolicyDecoderClass(final GroupValidationResult validationResult) {
90         try {
91             Class.forName(decoderClassName);
92         } catch (final ClassNotFoundException e) {
93             validationResult.setResult("decoderClassName", ValidationStatus.INVALID,
94                     "policy decoder class not found in classpath");
95         }
96     }
97 }