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 ManagedProcessorMBean extends ManagedPerformanceCounterMBean {
023
024    @ManagedAttribute(description = "Processor State")
025    String getState();
026
027    @ManagedAttribute(description = "Camel ID")
028    String getCamelId();
029
030    @ManagedAttribute(description = "Camel ManagementName")
031    String getCamelManagementName();
032
033    @ManagedAttribute(description = "Route ID")
034    String getRouteId();
035
036    @ManagedAttribute(description = "Step ID")
037    String getStepId();
038
039    @ManagedAttribute(description = "Processor ID")
040    String getProcessorId();
041
042    @ManagedAttribute(description = "Processor Name (Short)")
043    String getProcessorName();
044
045    @ManagedAttribute(description = "Processor Index")
046    Integer getIndex();
047
048    @ManagedAttribute(description = "Processor Level in the route tree")
049    int getLevel();
050
051    @ManagedAttribute(description = "Source file Location")
052    String getSourceLocation();
053
054    @ManagedAttribute(description = "Line number of this node in the source file (when loaded from a line number aware parser)")
055    Integer getSourceLineNumber();
056
057    @ManagedAttribute(description = "Whether this processor supports extended JMX information")
058    Boolean getSupportExtendedInformation();
059
060    @ManagedOperation(description = "Start Processor")
061    void start() throws Exception;
062
063    @ManagedOperation(description = "Stop Processor")
064    void stop() throws Exception;
065
066    @ManagedOperation(description = "Dumps the processor as XML")
067    String dumpProcessorAsXml() throws Exception;
068
069}