Improve CPS Exception handling
[cps.git] / cps-ri / src / main / java / org / onap / cps / spi / repository / ModuleRepository.java
1 /*
2  * ============LICENSE_START=======================================================
3  *  Copyright (C) 2020 Nordix Foundation
4  *  ================================================================================
5  *  Licensed under the Apache License, Version 2.0 (the "License");
6  *  you may not use this file except in compliance with the License.
7  *  You may obtain a copy of the License at
8  *
9  *        http://www.apache.org/licenses/LICENSE-2.0
10  *  Unless required by applicable law or agreed to in writing, software
11  *  distributed under the License is distributed on an "AS IS" BASIS,
12  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  *  See the License for the specific language governing permissions and
14  *  limitations under the License.
15  *
16  *  SPDX-License-Identifier: Apache-2.0
17  *  ============LICENSE_END=========================================================
18  */
19
20 package org.onap.cps.spi.repository;
21
22
23 import java.util.Optional;
24 import javax.validation.constraints.NotNull;
25 import org.onap.cps.spi.entities.Dataspace;
26 import org.onap.cps.spi.entities.Module;
27 import org.onap.cps.spi.exceptions.NotFoundInDataspaceException;
28 import org.springframework.data.jpa.repository.JpaRepository;
29 import org.springframework.stereotype.Repository;
30
31 @Repository
32 public interface ModuleRepository extends JpaRepository<Module, Integer> {
33
34     Optional<Module> findByDataspaceAndNamespaceAndRevision(@NotNull Dataspace dataspace,
35             @NotNull String namespace,
36             @NotNull String revision);
37
38     /**
39      * This method gets a Module by dataspace, namespace and revision.
40      *
41      * @param dataspace the dataspace
42      * @param namespace the namespace
43      * @param revision  the revision
44      * @return the Module
45      * @throws NotFoundInDataspaceException if Module not found
46      */
47     default Module getByDataspaceAndNamespaceAndRevision(@NotNull final Dataspace dataspace,
48             @NotNull final String namespace,
49             @NotNull final String revision) {
50         return findByDataspaceAndNamespaceAndRevision(dataspace, namespace, revision)
51                 .orElseThrow(() -> new NotFoundInDataspaceException("Validation Error", String.format(
52                         "Module with dataspace %s, revision %s does not exist in namespace %s.",
53                         dataspace.getName(), revision, namespace)));
54     }
55 }