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.Map;
020import javax.management.openmbean.TabularData;
021
022import org.apache.camel.ComponentVerifier;
023import org.apache.camel.api.management.ManagedAttribute;
024import org.apache.camel.api.management.ManagedOperation;
025
026public interface ManagedComponentMBean {
027
028    @ManagedAttribute(description = "Component Name")
029    String getComponentName();
030
031    @ManagedAttribute(description = "Component State")
032    String getState();
033
034    @ManagedAttribute(description = "Camel ID")
035    String getCamelId();
036
037    @ManagedAttribute(description = "Camel ManagementName")
038    String getCamelManagementName();
039
040    @ManagedOperation(description = "Component information as JSon")
041    String informationJson();
042
043    @ManagedOperation(description = "Explain how this component is configured")
044    TabularData explain(boolean allOptions);
045
046    @ManagedAttribute(description = "Whether this component support verification (parameters or connectivity)")
047    boolean isVerifySupported();
048
049    @ManagedOperation(description = "Verify options against a given scope")
050    ComponentVerifier.Result verify(String scope, Map<String, String> options);
051}