org.apache.camel.api.management.ManagedCamelContext Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.camel.api.management;

import org.apache.camel.api.management.mbean.ManagedCamelContextMBean;
import org.apache.camel.api.management.mbean.ManagedProcessorMBean;
import org.apache.camel.api.management.mbean.ManagedRouteMBean;
import org.apache.camel.api.management.mbean.ManagedStepMBean;

public interface ManagedCamelContext {

    /**
     * Gets the managed Camel CamelContext client api
     */
    ManagedCamelContextMBean getManagedCamelContext();

    /**
     * Gets the managed processor client api from any of the routes which with the given id
     *
     * @param  id id of the processor
     * @return    the processor or null if not found
     */
    default ManagedProcessorMBean getManagedProcessor(String id) {
        return getManagedProcessor(id, ManagedProcessorMBean.class);
    }

    /**
     * Gets the managed processor client api from any of the routes which with the given id
     *
     * @param  id                       id of the processor
     * @param  type                     the managed processor type from the
     *                                  {@link org.apache.camel.api.management.mbean} package.
     * @return                          the processor or null if not found
     * @throws IllegalArgumentException if the type is not compliant
     */
     T getManagedProcessor(String id, Class type);

    /**
     * Gets the managed step client api from any of the routes which with the given id
     *
     * @param  id id of the step
     * @return    the step or null if not found
     */
    ManagedStepMBean getManagedStep(String id);

    /**
     * Gets the managed route client api with the given route id
     *
     * @param  routeId id of the route
     * @return         the route or null if not found
     */
    default ManagedRouteMBean getManagedRoute(String routeId) {
        return getManagedRoute(routeId, ManagedRouteMBean.class);
    }

    /**
     * Gets the managed route client api with the given route id
     *
     * @param  routeId                  id of the route
     * @param  type                     the managed route type from the {@link org.apache.camel.api.management.mbean}
     *                                  package.
     * @return                          the route or null if not found
     * @throws IllegalArgumentException if the type is not compliant
     */
     T getManagedRoute(String routeId, Class type);

}