cps-service/src/main/java/org/onap/cps/spi/exceptions/AlreadyDefinedException.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021 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.exceptions;
  21
  22 import java.util.Collection;
  23
  24 /**
  25  * Already defined exception. Indicates the cps object with same name already exists.
  26  */
  27
  28 @SuppressWarnings("squid:S110")  // Team agreed to accept 6 levels of inheritance for CPS Exceptions
  29 public class AlreadyDefinedException extends CpsAdminException {
  30
  31     private static final long serialVersionUID = 501929839139881112L;
  32
  33     /**
  34      * Constructor.
  35      *
  36      * @param objectType  the object type
  37      * @param objectName  the name of the object
  38      * @param contextName the context name e.g. Anchor or Dataspace
  39      * @param cause       the cause of the exception
  40      */
  41     private AlreadyDefinedException(final String objectType, final String objectName, final String contextName,
  42         final Throwable cause) {
  43         super("Already defined exception",
  44             String.format("%s with name %s already exists for %s.", objectType, objectName, contextName), cause);
  45     }
  46
  47     /**
  48      * Constructor.
  49      *
  50      * @param objectName the name of the object
  51      * @param cause      the cause of the exception
  52      */
  53     private AlreadyDefinedException(final String objectName, final Throwable cause) {
  54         super("Already defined exception", String.format("%s already exists.", objectName), cause);
  55     }
  56
  57     public static AlreadyDefinedException forDataspace(final String dataspaceName, final Throwable cause) {
  58         return new AlreadyDefinedException(dataspaceName, cause);
  59     }
  60
  61     public static AlreadyDefinedException forAnchor(final String anchorName, final String contextName,
  62         final Throwable cause) {
  63         return new AlreadyDefinedException("Anchor", anchorName, contextName, cause);
  64     }
  65
  66     public static AlreadyDefinedException forSchemaSet(final String schemaSetName, final String contextName,
  67         final Throwable cause) {
  68         return new AlreadyDefinedException("Schema Set", schemaSetName, contextName, cause);
  69     }
  70
  71     public static AlreadyDefinedException forDataNode(final String xpath, final String contextName,
  72         final Throwable cause) {
  73         return new AlreadyDefinedException("Data node", xpath, contextName, cause);
  74     }
  75
  76     public static AlreadyDefinedException forDataNodes(final Collection<String> xpaths, final String contextName,
  77         final Throwable cause) {
  78         final var name = String.format("(one or more) of %s", xpaths);
  79         return new AlreadyDefinedException("Data node", name, contextName, cause);
  80     }
  81 }