1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.api.services.model;
20
21 import org.apache.maven.api.model.Model;
22 import org.apache.maven.api.services.ModelBuilderRequest;
23 import org.apache.maven.api.services.ModelProblemCollector;
24
25 /**
26 * Checks the model for missing or invalid values.
27 *
28 */
29 public interface ModelValidator {
30 /**
31 * Denotes minimal validation of POMs. This validation level is meant for processing of POMs from repositories
32 * during metadata retrieval.
33 */
34 int VALIDATION_LEVEL_MINIMAL = 0;
35 /**
36 * Denotes validation as performed by Maven 2.0. This validation level is meant as a compatibility mode to allow
37 * users to migrate their projects.
38 */
39 int VALIDATION_LEVEL_MAVEN_2_0 = 20;
40 /**
41 * Denotes validation as performed by Maven 3.0. This validation level is meant for existing projects.
42 */
43 int VALIDATION_LEVEL_MAVEN_3_0 = 30;
44 /**
45 * Denotes validation as performed by Maven 3.1. This validation level is meant for existing projects.
46 */
47 int VALIDATION_LEVEL_MAVEN_3_1 = 31;
48 /**
49 * Denotes validation as performed by Maven 4.0. This validation level is meant for new projects.
50 */
51 int VALIDATION_LEVEL_MAVEN_4_0 = 40;
52 /**
53 * Denotes strict validation as recommended by the current Maven version.
54 */
55 int VALIDATION_LEVEL_STRICT = VALIDATION_LEVEL_MAVEN_4_0;
56
57 /**
58 * Checks the specified file model for missing or invalid values. This model is directly created from the POM
59 * file and has not been subjected to inheritance, interpolation or profile/default injection.
60 *
61 * @param model The model to validate, must not be {@code null}.
62 * @param validationLevel The validation level.
63 * @param request The model building request that holds further settings, must not be {@code null}.
64 * @param problems The container used to collect problems that were encountered, must not be {@code null}.
65 */
66 default void validateFileModel(
67 Model model, int validationLevel, ModelBuilderRequest request, ModelProblemCollector problems) {
68 // do nothing
69 }
70
71 /**
72 * Checks the specified (raw) model for missing or invalid values. The raw model is the file model + buildpom filter
73 * transformation and has not been subjected to inheritance, interpolation or profile/default injection.
74 *
75 * @param model The model to validate, must not be {@code null}.
76 * @param validationLevel The validation level.
77 * @param request The model building request that holds further settings, must not be {@code null}.
78 * @param problems The container used to collect problems that were encountered, must not be {@code null}.
79 */
80 void validateRawModel(
81 Model model, int validationLevel, ModelBuilderRequest request, ModelProblemCollector problems);
82
83 /**
84 * Checks the specified (effective) model for missing or invalid values. The effective model is fully assembled and
85 * has undergone inheritance, interpolation and other model operations.
86 *
87 * @param model The model to validate, must not be {@code null}.
88 * @param validationLevel The validation level.
89 * @param request The model building request that holds further settings, must not be {@code null}.
90 * @param problems The container used to collect problems that were encountered, must not be {@code null}.
91 */
92 void validateEffectiveModel(
93 Model model, int validationLevel, ModelBuilderRequest request, ModelProblemCollector problems);
94 }