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