modules/core/src/main/java/org/apache/ignite/services/ServiceDeploymentException.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */

package org.apache.ignite.services;

import java.util.Collection;
import org.apache.ignite.IgniteException;
import org.jetbrains.annotations.Nullable;

/**
 * Exception indicating service deployment failure.
 */
public class ServiceDeploymentException extends IgniteException {
    /** */
    private static final long serialVersionUID = 0L;

    /** */
    private final Collection<ServiceConfiguration> cfgs;

    /**
     * Creates service deployment exception with error message.
     *
     * @param msg Error message.
     * @param cfgs Configurations of services that failed to deploy.
     */
    public ServiceDeploymentException(String msg, Collection<ServiceConfiguration> cfgs) {
        super(msg);

        this.cfgs = cfgs;
    }

    /**
     * Creates service deployment exception with {@link Throwable} as a cause.
     *
     * @param cause Cause.
     * @param cfgs Configurations of services that failed to deploy.
     */
    public ServiceDeploymentException(Throwable cause, Collection<ServiceConfiguration> cfgs) {
        super(cause);

        this.cfgs = cfgs;
    }

    /**
     * Creates service deployment exception with error message and {@link Throwable} as a cause.
     *
     * @param msg Error message.
     * @param cause Cause.
     * @param cfgs Configurations of services that failed to deploy.
     */
    public ServiceDeploymentException(String msg, @Nullable Throwable cause, Collection<ServiceConfiguration> cfgs) {
        super(msg, cause);

        this.cfgs = cfgs;
    }

    /**
     * @return Configurations of services that failed to deploy.
     */
    public Collection<ServiceConfiguration> getFailedConfigurations() {
        return cfgs;
    }
}