diff options
author | 2018-07-24 12:38:24 +0100 | |
---|---|---|
committer | 2018-07-25 15:58:53 +0100 | |
commit | 32c6ed6b8cc4ba7b884508b68e376621fb763f65 (patch) | |
tree | 48d9a4705cd97a5b42163f6a6d655a9b38afad45 /common-parameters/src/main/java/org/onap/policy/common/parameters/ParameterValidator.java | |
parent | b40acf2d244058c162a8597968e59f2708e6abf4 (diff) |
Add common parameter handling
This common module is proposed to handle all parameters and properties
for the ONAP Policy Framework in a common way.
Parameters and Properties:
- are validated once when they are loaded and need not be checked again
in classes that use them
- are available for lookup in a parameter service, they need not be passed
in constructors and method arguments
- are input using a single implementiation of input method only
(JSON/YAML/Java properties/REST)
- are defined in a schema and the schema is used for validation as much
as possible
Issue-ID: POLICY-922
Change-Id: I1fac88b9e952b6b5fcbea04319cb4294a9653327
Signed-off-by: liamfallon <liam.fallon@ericsson.com>
Diffstat (limited to 'common-parameters/src/main/java/org/onap/policy/common/parameters/ParameterValidator.java')
-rw-r--r-- | common-parameters/src/main/java/org/onap/policy/common/parameters/ParameterValidator.java | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/common-parameters/src/main/java/org/onap/policy/common/parameters/ParameterValidator.java b/common-parameters/src/main/java/org/onap/policy/common/parameters/ParameterValidator.java new file mode 100644 index 00000000..0d718267 --- /dev/null +++ b/common-parameters/src/main/java/org/onap/policy/common/parameters/ParameterValidator.java @@ -0,0 +1,36 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2018 Ericsson. 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.common.parameters; + +/** + * This interface is implemented by ONAP PF parameter classes so that they can be validated. + * + * @author Liam Fallon (liam.fallon@ericsson.com) + */ +public interface ParameterValidator { + /** + * Validate a parameter java bean, if the parameter bean is valid, an empty string is returned, + * otherwise the string gives details of the invalid parameters. + * + * @return the string with validation errors + */ + String validate(); +} |