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 ManagedProcessorMBean extends ManagedPerformanceCounterMBean {
025
026    @ManagedAttribute(description = "Processor State")
027    String getState();
028
029    @ManagedAttribute(description = "Camel ID")
030    String getCamelId();
031
032    @ManagedAttribute(description = "Camel ManagementName")
033    String getCamelManagementName();
034
035    @ManagedAttribute(description = "Route ID")
036    String getRouteId();
037
038    @ManagedAttribute(description = "Processor ID")
039    String getProcessorId();
040
041    @ManagedAttribute(description = "Processor Index")
042    Integer getIndex();
043
044    @ManagedAttribute(description = "Whether this processor supports extended JMX information")
045    Boolean getSupportExtendedInformation();
046
047    @ManagedOperation(description = "Start Processor")
048    void start() throws Exception;
049
050    @ManagedOperation(description = "Stop Processor")
051    void stop() throws Exception;
052
053    @ManagedOperation(description = "Processor information as JSon")
054    String informationJson();
055
056    @ManagedOperation(description = "Explain how this processor is configured")
057    TabularData explain(boolean allOptions);
058
059    @ManagedOperation(description = "Dumps the processor as XML")
060    String dumpProcessorAsXml() throws Exception;
061
062}