fish.payara.microprofile.faulttolerance.FaultToleranceService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
There is a newer version: 7.2024.1.Alpha1
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2019-2021 Payara Foundation and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://github.com/payara/Payara/blob/master/LICENSE.txt
 * See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * The Payara Foundation designates this particular file as subject to the "Classpath"
 * exception as provided by the Payara Foundation in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package fish.payara.microprofile.faulttolerance;

import jakarta.enterprise.context.control.RequestContextController;
import jakarta.interceptor.InvocationContext;

import fish.payara.microprofile.faulttolerance.policy.FaultTolerancePolicy;
import fish.payara.microprofile.faulttolerance.service.Stereotypes;

/**
 * Essentially a list of all methods needed to process FT behaviour.
 * 
 * Decouples the FT processing facilities and state from any specific implementation to allow e.g. unit testing.
 *
 * @author Jan Bernitt
 */
public interface FaultToleranceService {

    /**
     * Creates an instance of a {@link FaultToleranceConfig} bound to the given {@link InvocationContext} and
     * {@link Stereotypes} lookup.
     * 
     * @param context     currently processed context
     * @param stereotypes way to lookup sterotype annotations
     * @return a thread safe {@link FaultToleranceConfig} instance bound to the given context
     */
    FaultToleranceConfig getConfig(InvocationContext context, Stereotypes stereotypes);

    /**
     * Get or create the context object for processing the annotated method represented by the given
     * {@link InvocationContext}.
     * 
     * @param context represents the FT annotated method being called
     * @param policy  the policy being used for this execution
     * @param requestContextController the controller to use or null
     * @return the {@link FaultToleranceMethodContext} to use to process the method invocation with FT semantics. This
     *         is a context specific to the target object and called method.
     */
    FaultToleranceMethodContext getMethodContext(InvocationContext context, FaultTolerancePolicy policy,
            RequestContextController requestContextController);

    default FaultToleranceMethodContext getMethodContext(InvocationContext context, FaultTolerancePolicy policy) {
        return getMethodContext(context, policy, null);
    }
}