001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.camel.api.management.mbean;
018
019import org.apache.camel.api.management.ManagedAttribute;
020import org.apache.camel.api.management.ManagedOperation;
021
022public interface ManagedThrottlingExceptionRoutePolicyMBean extends ManagedServiceMBean {
023
024    @ManagedAttribute(description = "The class of the exception to throttle")
025    String[] getExceptionTypes();
026
027    @ManagedAttribute(description = "How long to wait before moving open circuit to half open")
028    Long getHalfOpenAfter();
029
030    @ManagedAttribute(description = "How long to wait before moving open circuit to half open")
031    void setHalfOpenAfter(Long milliseconds);
032
033    @ManagedAttribute(description = "The range of time that failures should occur within")
034    Long getFailureWindow();
035
036    @ManagedAttribute(description = "The range of time that failures should occur within")
037    void setFailureWindow(Long milliseconds);
038
039    @ManagedAttribute(description = "Number of failures before opening circuit")
040    Integer getFailureThreshold();
041
042    @ManagedAttribute(description = "Number of failures before opening circuit")
043    void setFailureThreshold(Integer numberOfFailures);
044
045    @ManagedAttribute(description = "Whether to keep the circuit breaker open (never closes)")
046    boolean getKeepOpen();
047
048    @ManagedAttribute(description = "Whether to keep the circuit breaker open (never closes)")
049    void setKeepOpen(boolean keepOpen);
050
051    @ManagedAttribute(description = "Logging level to use for logging state changes")
052    String getStateLoggingLevel();
053
054    @ManagedAttribute(description = "Logging level to use for logging state changes")
055    void setStateLoggingLevel(String stateLoggingLevel);
056
057    @ManagedOperation(description = "The current state of the circuit")
058    String currentState();
059
060    @ManagedAttribute(description = "The half open handler registered (if any)")
061    String getHalfOpenHandlerName();
062
063    @ManagedAttribute(description = "The number of failures caught")
064    Integer getCurrentFailures();
065
066    @ManagedAttribute(description = "Number of ms since the last failure was recorded")
067    Long getLastFailure();
068
069    @ManagedAttribute(description = "Number ms since the circuit was opened")
070    Long getOpenAt();
071
072}