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 org.apache.camel.api.management.ManagedAttribute;
022
023public interface ManagedEndpointMBean {
024
025    @ManagedAttribute(description = "Camel ID")
026    String getCamelId();
027
028    @ManagedAttribute(description = "Camel ManagementName")
029    String getCamelManagementName();
030
031    @ManagedAttribute(description = "Endpoint URI", mask = true)
032    String getEndpointUri();
033
034    @ManagedAttribute(description = "Endpoint Base URI (no query parameters)", mask = true)
035    String getEndpointBaseUri();
036
037    @ManagedAttribute(description = "Singleton")
038    boolean isSingleton();
039
040    @ManagedAttribute(description = "Whether this endpoint connects to remote or local systems")
041    boolean isRemote();
042
043    @ManagedAttribute(description = "Endpoint State")
044    String getState();
045
046    @ManagedAttribute(description = "Url used for network connecting to service (only available for some components)")
047    String getServiceLocationUrl();
048
049    @ManagedAttribute(description = "Protocol used for service connecting (only available for some components)")
050    String getServiceLocationProtocol();
051
052    @ManagedAttribute(description = "Additional metadata this endpoint is used for connecting (only available for some components)")
053    Map<String, String> getServiceLocationMetadata();
054
055}