CircuitBreaker.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.cxf.clustering.circuitbreaker;

/**
 * Basic abstract interface for circuit breaker implementation.
 */
public interface CircuitBreaker {
    /**
     * Is request is allowed to go through (is circuit breaker closed or opened).
     * @return "false" if circuit breaker is open, "true" otherwise
     */
    boolean allowRequest();

    /**
     * Reports about failure conditions to circuit breaker.
     * @param cause exception happened (could be null in case the error is deducted
     * from response status/code).
     */
    void markFailure(Throwable cause);

    /**
     * Reports about successful invocation to circuit breaker.
     */
    void markSuccess();
}