summaryrefslogtreecommitdiffstats
path: root/aai-schema-ingest/src/main/java/org/onap/aai/validation/SchemaErrorStrategy.java
blob: 0f2f26738ab95c8646d46eec6ac44078d5fe6599 (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
/** 
 * ============LICENSE_START=======================================================
 * org.onap.aai
 * ================================================================================
 * Copyright © 2017 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.
 * ============LICENSE_END=========================================================
 *
 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
 */

package org.onap.aai.validation;

/**
 * Controls response to finding problems in the schema files.
 */
public interface SchemaErrorStrategy {
	/**
	 * Gives if it is OK to proceed with whatever process
	 * invoked the validation (probably the installation of
	 * the A&AI instance).
	 * 
	 * @return boolean
	 */
	public boolean isOK();
	
	/**
	 * Gets the error message(s) gathered in the course
	 * of validation. 
	 * 
	 * @return String error message or messages concatenated together
	 */
	public String getErrorMsg();
	
	/**
	 * Invokes the ErrorStrategy to do whatever response to
	 * an issue in the schema having been found.
	 * 
	 * Options:
	 * -Throw an exception if the whole process should be 
	 *  immediately aborted
	 * -Set OK status to false, store the message and allow the
	 *  validation process to continue and find any other issues
	 * -Completely ignore that something is wrong
	 * etc.
	 * 
	 * @param String errorMsg - the error message from the validator module
	 */
	public void notifyOnError(String errorMsg);
}