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 ManagedStreamCachingStrategyMBean extends ManagedServiceMBean {
023
024    /**
025     * Used for selecting if the memory limit is <tt>committed</tt> or <tt>maximum</tt> heap memory setting.
026     */
027    enum SpoolUsedHeapMemoryLimit {
028        Committed, Max
029    }
030
031    @ManagedAttribute(description = "Whether stream caching is enabled")
032    boolean isEnabled();
033
034    @ManagedAttribute(description = "Directory used when overflow and spooling to disk")
035    String getSpoolDirectory();
036
037    @ManagedAttribute(description = "Chiper used if writing with encryption")
038    String getSpoolChiper();
039
040    @ManagedAttribute(description = "Threshold in bytes when overflow and spooling to disk instead of keeping in memory")
041    void setSpoolThreshold(long threshold);
042
043    @ManagedAttribute(description = "Threshold in bytes when overflow and spooling to disk instead of keeping in memory")
044    long getSpoolThreshold();
045
046    @ManagedAttribute(description = "Percentage (1-99) of used heap memory threshold to activate spooling to disk")
047    void setSpoolUsedHeapMemoryThreshold(int percentage);
048
049    @ManagedAttribute(description = "Percentage (1-99) of used heap memory threshold to activate spooling to disk")
050    int getSpoolUsedHeapMemoryThreshold();
051
052    @ManagedAttribute(description = "Whether used heap memory limit is committed or maximum")
053    void setSpoolUsedHeapMemoryLimit(SpoolUsedHeapMemoryLimit limit);
054
055    @ManagedAttribute(description = "Whether used heap memory limit is committed or maximum")
056    SpoolUsedHeapMemoryLimit getSpoolUsedHeapMemoryLimit();
057
058    @ManagedAttribute(description = "Buffer size in bytes to use when coping between buffers")
059    void setBufferSize(int bufferSize);
060
061    @ManagedAttribute(description = "Buffer size in bytes to use when coping between buffers")
062    int getBufferSize();
063
064    @ManagedAttribute(description = "Whether to remove spool directory when stopping")
065    void setRemoveSpoolDirectoryWhenStopping(boolean remove);
066
067    @ManagedAttribute(description = "Whether to remove spool directory when stopping")
068    boolean isRemoveSpoolDirectoryWhenStopping();
069
070    @ManagedAttribute(description = "Whether any or all spool rules determines whether to spool")
071    void setAnySpoolRules(boolean any);
072
073    @ManagedAttribute(description = "Whether any or all spool rules determines whether to spool")
074    boolean isAnySpoolRules();
075
076    @ManagedAttribute(description = "Number of in-memory StreamCache created")
077    long getCacheMemoryCounter();
078
079    @ManagedAttribute(description = "Total accumulated number of bytes which has been stream cached for in-memory StreamCache")
080    long getCacheMemorySize();
081
082    @ManagedAttribute(description = "Average number of bytes per cached stream for in-memory stream caches.")
083    long getCacheMemoryAverageSize();
084
085    @ManagedAttribute(description = "Number of spooled (not in-memory) StreamCache created")
086    long getCacheSpoolCounter();
087
088    @ManagedAttribute(description = "Total accumulated number of bytes which has been stream cached for spooled StreamCache")
089    long getCacheSpoolSize();
090
091    @ManagedAttribute(description = "Average number of bytes per cached stream for spooled (not in-memory) stream caches.")
092    long getCacheSpoolAverageSize();
093
094    @ManagedAttribute(description = "Whether utilization statistics is enabled")
095    boolean isStatisticsEnabled();
096
097    @ManagedAttribute(description = "Whether utilization statistics is enabled")
098    void setStatisticsEnabled(boolean enabled);
099
100    @ManagedOperation(description = "Reset the utilization statistics")
101    void resetStatistics();
102
103}