org.talend.sdk.component.api.exception.DiscoverSchemaException Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2006-2024 Talend Inc. - www.talend.com
 *
 * 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.
 */
package org.talend.sdk.component.api.exception;

import javax.json.bind.annotation.JsonbCreator;
import javax.json.bind.annotation.JsonbPropertyOrder;

import lombok.Data;

/**
 * This class is dedicated to Studio's guess schema feature.
 * It has the same goal as ComponentException except that you can specify an action to execute in some cases.
 *
 * If you don't need such feature, just use ComponentException.
 *
 * See me TCOMP-2342 for more details.
 */
@Data
@JsonbPropertyOrder({ "localizedMessage", "message", "stackTrace", "suppressed", "possibleHandleErrorWith" })
public class DiscoverSchemaException extends RuntimeException {

    public enum HandleErrorWith {
        /**
         * default case
         */
        EXCEPTION,
        /**
         * unhandled.
         */
        SILENT,
        /**
         * unhandled.
         */
        RETRY,
        /**
         * Potentially execute a mock job in studio.
         * Will ask user's validation before executing.
         * When specifying this option, developer should be sure that no side effect can be generated by connector.
         */
        EXECUTE_MOCK_JOB,
        /**
         * Will execute a lifecycle through framework using only configuration.
         * This won't query for any user input.
         * When specifying this option, developer should be sure that no side effect can be generated by connector.
         */
        EXECUTE_LIFECYCLE;
    }

    private HandleErrorWith possibleHandleErrorWith = HandleErrorWith.EXCEPTION;

    public DiscoverSchemaException(final ComponentException e) {
        super(e.getOriginalMessage(), e.getCause());
    }

    public DiscoverSchemaException(final ComponentException e, final HandleErrorWith handling) {
        super(e.getOriginalMessage(), e.getCause());
        setPossibleHandleErrorWith(handling);
    }

    public DiscoverSchemaException(final String message, final HandleErrorWith handling) {
        super(message);
        setPossibleHandleErrorWith(handling);
    }

    @JsonbCreator
    public DiscoverSchemaException(final String message, final StackTraceElement[] stackTrace,
            final HandleErrorWith handling) {
        super(message);
        setStackTrace(stackTrace);
        setPossibleHandleErrorWith(handling);
    }

}