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 ManagedAggregateProcessorMBean extends ManagedProcessorMBean {
023
024    @ManagedAttribute(description = "The language for the expression")
025    String getCorrelationExpressionLanguage();
026
027    @ManagedAttribute(description = "Correlation Expression")
028    String getCorrelationExpression();
029
030    @ManagedAttribute(description = "Completion timeout in millis")
031    long getCompletionTimeout();
032
033    @ManagedAttribute(description = "The language for the expression")
034    String getCompletionTimeoutLanguage();
035
036    @ManagedAttribute(description = "Completion timeout expression")
037    String getCompletionTimeoutExpression();
038
039    @ManagedAttribute(description = "Completion interval in millis")
040    long getCompletionInterval();
041
042    @ManagedAttribute(description = "Completion timeout checker interval in millis")
043    long getCompletionTimeoutCheckerInterval();
044
045    @ManagedAttribute(description = "Completion size")
046    int getCompletionSize();
047
048    @ManagedAttribute(description = "The language for the expression")
049    String getCompletionSizeExpressionLanguage();
050
051    @ManagedAttribute(description = "Completion size expression")
052    String getCompletionSizeExpression();
053
054    @ManagedAttribute(description = "Complete from batch consumers")
055    boolean isCompletionFromBatchConsumer();
056
057    @ManagedAttribute(description = "Complete all previous groups on new incoming correlation group")
058    boolean isCompletionOnNewCorrelationGroup();
059
060    @ManagedAttribute(description = "Ignore invalid correlation keys")
061    boolean isIgnoreInvalidCorrelationKeys();
062
063    @ManagedAttribute(description = "Whether to close the correlation group on completion if this value is > 0.")
064    Integer getCloseCorrelationKeyOnCompletion();
065
066    @ManagedAttribute(description = "Parallel mode")
067    boolean isParallelProcessing();
068
069    @ManagedAttribute(description = "Optimistic locking")
070    boolean isOptimisticLocking();
071
072    @ManagedAttribute(description = "Whether or not to eager check for completion when a new incoming Exchange has been received")
073    boolean isEagerCheckCompletion();
074
075    @ManagedAttribute(description = "The language for the predicate")
076    String getCompletionPredicateLanguage();
077
078    @ManagedAttribute(description = "A Predicate to indicate when an aggregated exchange is complete")
079    String getCompletionPredicate();
080
081    @ManagedAttribute(description = "Whether or not exchanges which complete due to a timeout should be discarded")
082    boolean isDiscardOnCompletionTimeout();
083
084    @ManagedAttribute(description = "Indicates to complete all current aggregated exchanges when the context is stopped")
085    boolean isForceCompletionOnStop();
086
087    @ManagedAttribute(description = "Indicates to wait to complete all current and partial (pending) aggregated exchanges when the context is stopped")
088    boolean isCompleteAllOnStop();
089
090    @ManagedAttribute(description = "Number of completed exchanges which are currently in-flight")
091    int getInProgressCompleteExchanges();
092
093    @ManagedOperation(description = "Number of groups currently in the aggregation repository")
094    int aggregationRepositoryGroups();
095
096    @ManagedOperation(description = "To force completing a specific group by its key")
097    int forceCompletionOfGroup(String key);
098
099    @ManagedOperation(description = "To force complete of all groups")
100    int forceCompletionOfAllGroups();
101
102    @ManagedOperation(description = "To force discarding a specific group by its key")
103    int forceDiscardingOfGroup(String key);
104
105    @ManagedOperation(description = "To force discarding of all groups")
106    int forceDiscardingOfAllGroups();
107
108    @ManagedAttribute(description = "Current number of closed correlation keys in the memory cache")
109    int getClosedCorrelationKeysCacheSize();
110
111    @ManagedOperation(description = "Clear all the closed correlation keys stored in the cache")
112    void clearClosedCorrelationKeysCache();
113
114    @ManagedAttribute(description = "Total number of exchanges arrived into the aggregator")
115    long getTotalIn();
116
117    @ManagedAttribute(description = "Total number of exchanges completed and outgoing from the aggregator")
118    long getTotalCompleted();
119
120    @ManagedAttribute(description = "Total number of exchanged completed by completion size trigger")
121    long getCompletedBySize();
122
123    @ManagedAttribute(description = "Total number of exchanged completed by completion aggregation strategy trigger")
124    long getCompletedByStrategy();
125
126    @ManagedAttribute(description = "Total number of exchanged completed by completion interval (timeout) trigger")
127    long getCompletedByInterval();
128
129    @ManagedAttribute(description = "Total number of exchanged completed by completion timeout trigger")
130    long getCompletedByTimeout();
131
132    @ManagedAttribute(description = "Total number of exchanged completed by completion predicate trigger")
133    long getCompletedByPredicate();
134
135    @ManagedAttribute(description = "Total number of exchanged completed by completion batch consumer trigger")
136    long getCompletedByBatchConsumer();
137
138    @ManagedAttribute(description = "Total number of exchanged completed by completion force trigger")
139    long getCompletedByForce();
140
141    @ManagedAttribute(description = "Total number of exchanged discarded")
142    long getDiscarded();
143
144    @ManagedOperation(description = " Reset the statistics counters")
145    void resetStatistics();
146
147    @Override
148    @ManagedAttribute(description = "Sets whether statistics is enabled")
149    boolean isStatisticsEnabled();
150
151    @Override
152    @ManagedAttribute(description = "Sets whether statistics is enabled")
153    void setStatisticsEnabled(boolean statisticsEnabled);
154
155}