aboutsummaryrefslogtreecommitdiffstats
path: root/context/context-management/src/main/java/org/onap/policy/apex/context/impl/schema/java/JavaSchemaHelperJsonAdapterParameters.java
blob: 588f1e6a2d8fd7d4840b385f9e353afe527dd6b0 (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
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2018 Ericsson. All rights reserved.
 *  Modifications Copyright (C) 2021 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.apex.context.impl.schema.java;

import com.google.gson.JsonDeserializer;
import com.google.gson.JsonSerializer;
import com.google.gson.TypeAdapter;
import lombok.Getter;
import lombok.Setter;
import org.apache.commons.lang3.StringUtils;
import org.onap.policy.common.parameters.BeanValidationResult;
import org.onap.policy.common.parameters.BeanValidator;
import org.onap.policy.common.parameters.ParameterGroup;
import org.onap.policy.common.parameters.ValidationStatus;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;

//@formatter:off
/**
 * Event protocol parameters for JSON as an event protocol.
 *
 * <p>The parameters for this plugin are:
 * <ol>
 * <li>adaptedClass: The name of the class being adapted.
 * <li>adapterClass: the JSON adapter class to use for the adapted class.
 * </ol>
 *
 * @author Liam Fallon (liam.fallon@ericsson.com)
 */
//@formatter:on
@Getter
@Setter
public class JavaSchemaHelperJsonAdapterParameters implements ParameterGroup {
    private static final XLogger LOGGER = XLoggerFactory.getXLogger(JavaSchemaHelperJsonAdapterParameters.class);

    // Recurring string constants
    private static final String ADAPTED_CLASS = "adaptedClass";
    private static final String ADAPTOR_CLASS = "adaptorClass";

    private String adaptedClass;
    private String adaptorClass;

    /**
     * {@inheritDoc}.
     */
    @Override
    public String getName() {
        return getAdaptedClass();
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public void setName(String adaptedClass) {
        setAdaptedClass(adaptedClass);
    }

    /**
     * Gets the adapted class.
     *
     * @return the adapted class
     */
    public Class<?> getAdaptedClazz() {
        if (adaptedClass == null) {
            return null;
        }

        try {
            return Class.forName(adaptedClass);
        } catch (final ClassNotFoundException e) {
            LOGGER.warn("class \"" + adaptedClass + "\" not found: ", e);
            return null;
        }
    }

    /**
     * Gets the adaptor class.
     *
     * @return the adaptor class
     */
    public Class<?> getAdaptorClazz() {
        if (adaptorClass == null) {
            return null;
        }

        try {
            return Class.forName(adaptorClass);
        } catch (final ClassNotFoundException e) {
            LOGGER.warn("class \"" + adaptorClass + "\" not found: ", e);
            return null;
        }
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public BeanValidationResult validate() {
        final BeanValidationResult result = new BeanValidator().validateTop(getClass().getSimpleName(), this);

        getClass(ADAPTED_CLASS, adaptedClass, result);

        Class<?> adaptorClazz = getClass(ADAPTOR_CLASS, adaptorClass, result);

        if (adaptorClazz != null) {
            String errorMessage = null;

            if (TypeAdapter.class.isAssignableFrom(adaptorClazz)) {
                return result;
            }

            if (!JsonSerializer.class.isAssignableFrom(adaptorClazz)) {
                errorMessage = "class is not a JsonSerializer";
            }

            if (!JsonDeserializer.class.isAssignableFrom(adaptorClazz)) {
                if (errorMessage == null) {
                    errorMessage = "class is not a JsonDeserializer";
                } else {
                    errorMessage = "class is not a JsonSerializer or JsonDeserializer";
                }
            }

            if (errorMessage != null) {
                result.addResult(ADAPTOR_CLASS, adaptorClazz, ValidationStatus.INVALID, errorMessage);
            }
        }

        return result;
    }

    /**
     * Check a class exists.
     *
     * @param parameterName the parameter name of the class to check for existence
     * @param classToCheck the class to check for existence
     * @param result the result of the check
     */
    private Class<?> getClass(String parameterName, String classToCheck, final BeanValidationResult result) {
        if (StringUtils.isBlank(classToCheck)) {
            result.addResult(parameterName, classToCheck, ValidationStatus.INVALID, "parameter is null or blank");
            return null;
        }

        // Get the class for the event protocol
        try {
            return Class.forName(classToCheck);
        } catch (final ClassNotFoundException e) {
            result.addResult(parameterName, classToCheck, ValidationStatus.INVALID,
                            "class not found: " + e.getMessage());
            LOGGER.warn("class not found: ", e);
            return null;
        }
    }
}