com.oracle.bmc.circuitbreaker.JaxRsCircuitBreaker Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of oci-java-sdk-circuitbreaker Show documentation

This project contains the Circuit Breaker module used for Oracle Cloud Infrastructure SDKs

There is a newer version: 3.49.0

Show newest version

/**
 * Copyright (c) 2016, 2020, Oracle and/or its affiliates.  All rights reserved.
 * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
 */
package com.oracle.bmc.circuitbreaker;

import java.util.concurrent.Future;
import java.util.function.Function;
import java.util.function.Supplier;
import javax.ws.rs.client.Invocation;
import javax.ws.rs.core.Response;

/**
 * JaxRsCircuitBreaker is a specialized CircuitBreaker for JaxRs client
 */
public interface JaxRsCircuitBreaker {

    /**
     * Returns a supplier which is decorated by the JaxRsCircuitBreaker.
     *
     * @param supplier the original supplier
     * @return a supplier which is decorated by the JaxRsCircuitBreaker.
     */
    Supplier decorateSupplier(Supplier supplier);

    /**
     * Returns a function which is decorated by the JaxRsCircuitBreaker.
     *
     * @param function the original function
     * @return a function which is decorated by the JaxRsCircuitBreaker.
     */
    Function decorateFunction(Function function);

    /**
     * Returns a supplier of type Future which is decorated by the JaxRsCircuitBreaker. The elapsed time
     * includes {@link Future#get()} evaluation time even if the underlying call took less time to
     * return. Any delays in evaluating Future by caller will add towards total time.
     *
     * @param supplier the original supplier
     * @return a supplier which is decorated by the JaxRsCircuitBreaker.
     */
    Supplier> decorateFuture(Supplier> supplier);
}