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 ManagedDumpRoutesStrategyMBean {
023
024    @ManagedOperation(description = "Dump routes in YAML or XML format.")
025    void dumpRoutes(String format);
026
027    @ManagedAttribute(description = "Camel ID")
028    String getCamelId();
029
030    @ManagedAttribute(description = "Camel ManagementName")
031    String getCamelManagementName();
032
033    @ManagedAttribute(description = "Controls what to include in output. Possible values: routes, rests, routeTemplates. Multiple values can be separated by comma. Default is routes.")
034    String getInclude();
035
036    @ManagedAttribute(description = "Controls what to include in output. Possible values: routes, rests, routeTemplates. Multiple values can be separated by comma. Default is routes.")
037    void setInclude(String include);
038
039    @ManagedAttribute(description = "Whether to log route dumps to Logger")
040    boolean isLog();
041
042    @ManagedAttribute(description = "Whether to log route dumps to Logger")
043    void setLog(boolean log);
044
045    @ManagedAttribute(description = "Whether to save route dumps to file(s)")
046    String getOutput();
047
048    @ManagedAttribute(description = "Whether to save route dumps to file(s)")
049    void setOutput(String output);
050
051    @ManagedAttribute(description = "When dumping to YAML format, then this option controls whether endpoint URIs should be expanded into a key/value parameters")
052    boolean isUriAsParameters();
053
054    @ManagedAttribute(description = "When dumping to YAML format, then this option controls whether endpoint URIs should be expanded into a key/value parameters")
055    void setUriAsParameters(boolean uriAsParameters);
056
057    @ManagedAttribute(description = "")
058    boolean isResolvePlaceholders();
059
060    @ManagedAttribute(description = "Whether to resolve property placeholders in the dumped output. Default is true.")
061    void setResolvePlaceholders(boolean resolvePlaceholders);
062
063}