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 = "Node Prefix ID")
037    String getNodePrefixId();
038
039    @ManagedAttribute(description = "Step ID")
040    String getStepId();
041
042    @ManagedAttribute(description = "Processor ID")
043    String getProcessorId();
044
045    @ManagedAttribute(description = "Processor Name (Short)")
046    String getProcessorName();
047
048    @ManagedAttribute(description = "Processor Description")
049    String getDescription();
050
051    @ManagedAttribute(description = "Processor Model Label")
052    String getModelLabel();
053
054    @ManagedAttribute(description = "Processor Note")
055    String getNote();
056
057    @ManagedAttribute(description = "Processor Index")
058    Integer getIndex();
059
060    @ManagedAttribute(description = "Processor Level in the route tree")
061    int getLevel();
062
063    @ManagedAttribute(description = "Source file Location")
064    String getSourceLocation();
065
066    @ManagedAttribute(description = "Source file location (Short)")
067    String getSourceLocationShort();
068
069    @ManagedAttribute(description = "Line number of this node in the source file (when loaded from a line number aware parser)")
070    Integer getSourceLineNumber();
071
072    @ManagedAttribute(description = "Whether this processor supports extended JMX information")
073    Boolean getSupportExtendedInformation();
074
075    @ManagedAttribute(description = "Whether this processor is disabled")
076    Boolean getDisabled();
077
078    @ManagedOperation(description = "To enable this processor")
079    void enable();
080
081    @ManagedOperation(description = "To disable this processor")
082    void disable();
083
084    @ManagedOperation(description = "Start Processor")
085    void start() throws Exception;
086
087    @ManagedOperation(description = "Stop Processor")
088    void stop() throws Exception;
089
090    @ManagedOperation(description = "Dumps the processor as XML")
091    String dumpProcessorAsXml() throws Exception;
092
093}