aboutsummaryrefslogtreecommitdiffstats
path: root/cps-service/src/main/java/org/onap/cps/exceptions/CpsExceptionBuilder.java
blob: 2acbb923223ba1c9a4c4073d1bf7e8507a16de8f (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
/*
 *  ============LICENSE_START=======================================================
 *  Copyright (C) 2020 Pantheon.tech
 *  ================================================================================
 *  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.cps.exceptions;

import lombok.AccessLevel;
import lombok.NoArgsConstructor;

/**
 * Utility class.
 * Serves error message consistency for same error cases occurred in different CPS modules.
 */
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public class CpsExceptionBuilder {

    private static final String SCHEMA_SET_IS_INVALID = "Schema Set is invalid.";

    /**
     * Generates validation error exception for case when requested dataspace is absent.
     *
     * @param dataspaceName dataspace name
     */
    public static CpsException invalidDataspaceException(final String dataspaceName) {
        return new CpsValidationException("Dataspace is invalid.",
            String.format("Dataspace with name %s does not exist.", dataspaceName));
    }

    /**
     * Generates validation error exception for case when requested schema set is absent for existing dataspace.
     *
     * @param dataspaceName dataspace name
     * @param schemaSetName schema set name
     */
    public static CpsException invalidSchemaSetException(final String dataspaceName, final String schemaSetName) {
        return new CpsValidationException(SCHEMA_SET_IS_INVALID,
            String.format("Schema Set with name %s was not found for dataspace %s.", schemaSetName, dataspaceName));
    }

    /**
     * Returns validation error exception for case when SchemaSet contains no files.
     */
    public static CpsException emptySchemaSetException() {
        return new CpsValidationException(SCHEMA_SET_IS_INVALID, "Schema Set has no YANG resources to store");
    }

    /**
     * Generates validation error exception for case when SchemaSet with same name already exists in the dataspace.
     *
     * @param dataspaceName dataspace name
     * @param schemaSetName schema set name
     */
    public static CpsException duplicateSchemaSetException(final String dataspaceName, final String schemaSetName) {
        return new CpsValidationException(SCHEMA_SET_IS_INVALID,
            String.format("Schema Set with name %s already exists for dataspace %s.", schemaSetName, dataspaceName));
    }

    /**
     * Generates no data found exception for case when requested dataspace is absent.
     *
     * @param dataspaceName dataspace name
     */
    public static CpsException dataspaceNotFoundException(final String dataspaceName) {
        return new CpsNotFoundException("Dataspace was not found.",
            String.format("Dataspace with name %s does not exist.", dataspaceName));
    }

    /**
     * Generates no data found exception for case when requested SchemaSet is absent for existing dataspace.
     *
     * @param dataspaceName dataspace name
     * @param schemaSetName schema set name
     */
    public static CpsException schemaSetNotFoundException(final String dataspaceName, final String schemaSetName) {
        return new CpsNotFoundException("Schema Set was not found.",
            String.format("Schema Set with name %s was not found for dataspace %s.", schemaSetName, dataspaceName));
    }

}