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 javax.management.openmbean.TabularData;
020
021import org.apache.camel.api.management.ManagedAttribute;
022import org.apache.camel.api.management.ManagedOperation;
023
024public interface ManagedErrorRegistryMBean extends ManagedServiceMBean {
025
026    @ManagedAttribute(description = "Whether the error registry is enabled")
027    boolean isEnabled();
028
029    @ManagedAttribute(description = "Whether the error registry is enabled")
030    void setEnabled(boolean enabled);
031
032    @ManagedAttribute(description = "Current number of error entries in the registry")
033    int getSize();
034
035    @ManagedAttribute(description = "Maximum number of error entries to keep")
036    int getMaximumEntries();
037
038    @ManagedAttribute(description = "Maximum number of error entries to keep")
039    void setMaximumEntries(int maximumEntries);
040
041    @ManagedAttribute(description = "Time-to-live in seconds for error entries")
042    long getTimeToLiveSeconds();
043
044    @ManagedAttribute(description = "Time-to-live in seconds for error entries")
045    void setTimeToLiveSeconds(long seconds);
046
047    @ManagedAttribute(description = "Maximum number of characters for the message body")
048    int getBodyMaxChars();
049
050    @ManagedAttribute(description = "Maximum number of characters for the message body")
051    void setBodyMaxChars(int bodyMaxChars);
052
053    @ManagedAttribute(description = "Whether to include stream-based message bodies")
054    boolean isBodyIncludeStreams();
055
056    @ManagedAttribute(description = "Whether to include stream-based message bodies")
057    void setBodyIncludeStreams(boolean bodyIncludeStreams);
058
059    @ManagedAttribute(description = "Whether to include file-based message bodies")
060    boolean isBodyIncludeFiles();
061
062    @ManagedAttribute(description = "Whether to include file-based message bodies")
063    void setBodyIncludeFiles(boolean bodyIncludeFiles);
064
065    @ManagedAttribute(description = "Whether to include exchange properties")
066    boolean isIncludeExchangeProperties();
067
068    @ManagedAttribute(description = "Whether to include exchange properties")
069    void setIncludeExchangeProperties(boolean includeExchangeProperties);
070
071    @ManagedAttribute(description = "Whether to include exchange variables")
072    boolean isIncludeExchangeVariables();
073
074    @ManagedAttribute(description = "Whether to include exchange variables")
075    void setIncludeExchangeVariables(boolean includeExchangeVariables);
076
077    @ManagedOperation(description = "Browse all error entries")
078    TabularData browse();
079
080    @ManagedOperation(description = "Browse error entries with a limit")
081    TabularData browse(int limit);
082
083    @ManagedOperation(description = "Browse error entries for a specific route")
084    TabularData browse(String routeId, int limit);
085
086    @ManagedOperation(description = "Clear all error entries")
087    void clear();
088}