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 java.util.List;
020
021import javax.management.openmbean.TabularData;
022
023import org.apache.camel.api.management.ManagedAttribute;
024import org.apache.camel.api.management.ManagedOperation;
025
026public interface ManagedRuntimeEndpointRegistryMBean extends ManagedServiceMBean {
027
028    @ManagedOperation(description = "Clears the registry")
029    void clear();
030
031    @ManagedOperation(description = "Reset the statistic counters")
032    void reset();
033
034    @ManagedAttribute(description = "Whether gathering runtime usage is enabled or not")
035    boolean isEnabled();
036
037    @ManagedAttribute(description = "Whether gathering runtime usage is enabled or not")
038    void setEnabled(boolean enabled);
039
040    @ManagedAttribute(description = "Maximum number of endpoints to keep in the cache per route")
041    int getLimit();
042
043    @ManagedAttribute(description = "Number of endpoints currently in the registry")
044    int getSize();
045
046    @ManagedOperation(description = "Gets all the endpoint urls captured during runtime that are in-use")
047    List<String> getAllEndpoints(boolean includeInputs);
048
049    @ManagedOperation(description = "Gets all the endpoint urls captured during runtime that are in-use for the given route")
050    List<String> getEndpointsPerRoute(String routeId, boolean includeInputs);
051
052    @ManagedOperation(description = "Lists statistics about all the endpoints in the registry")
053    TabularData endpointStatistics();
054
055}