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