ManagementStrategy.java

/**
 * 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.spi;

import java.util.EventObject;
import java.util.List;

import org.apache.camel.ManagementStatisticsLevel;
import org.apache.camel.Service;
import org.apache.camel.model.ProcessorDefinition;

/**
 * Strategy for management.
 * <p/>
 * This is totally pluggable allowing to use a custom or 3rd party management implementation with Camel.
 *
 * @see org.apache.camel.spi.EventNotifier
 * @see org.apache.camel.spi.EventFactory
 * @see org.apache.camel.spi.ManagementNamingStrategy
 * @see org.apache.camel.spi.ManagementAgent
 * @version 
 */
public interface ManagementStrategy extends Service {

    /**
     * Adds a managed object allowing the ManagementStrategy implementation to record or expose
     * the object as it sees fit.
     *
     * @param managedObject the managed object
     * @throws Exception can be thrown if the object could not be added
     */
    void manageObject(Object managedObject) throws Exception;

    /**
     * Adds a managed object allowing the ManagementStrategy implementation
     * to record or expose the object as it sees fit.
     *
     * @param managedObject the managed object
     * @param preferredName representing the preferred name, maybe a String, or a JMX ObjectName
     * @throws Exception can be thrown if the object could not be added
     */
    void manageNamedObject(Object managedObject, Object preferredName) throws Exception;

    /**
     * Construct an object name, where either the object to be managed and/or
     * a custom name component are provided
     *
     * @param managedObject the object to be managed
     * @param customName a custom name component
     * @param nameType the name type required
     * @return an object name of the required type if supported, otherwise <tt>null</tt>
     * @throws Exception can be thrown if the object name could not be created
     */
    <T> T getManagedObjectName(Object managedObject, String customName, Class<T> nameType) throws Exception;

    /**
     * Removes the managed object.
     *
     * @param managedObject the managed object
     * @throws Exception can be thrown if the object could not be removed
     */
    void unmanageObject(Object managedObject) throws Exception;

    /**
     * Removes a managed object by name.
     *
     * @param name an object name previously created by this strategy.
     * @throws Exception can be thrown if the object could not be removed
     */
    void unmanageNamedObject(Object name) throws Exception;

    /**
     * Determines if an object or name is managed.
     *
     * @param managedObject the object to consider
     * @param name the name to consider
     * @return <tt>true</tt> if the given object or name is managed
     */
    boolean isManaged(Object managedObject, Object name);

    /**
     * Management events provide a single model for capturing information about execution points in the
     * application code. Management strategy implementations decide if and where to record these events.
     * Applications communicate events to management strategy implementations via the notify(EventObject)
     * method.
     *
     * @param event the event
     * @throws Exception can be thrown if the notification failed
     */
    void notify(EventObject event) throws Exception;

    /**
     * Gets the event notifiers.
     *
     * @return event notifiers
     */
    List<EventNotifier> getEventNotifiers();

    /**
     * Sets the list of event notifier to use.
     *
     * @param eventNotifier list of event notifiers
     */
    void setEventNotifiers(List<EventNotifier> eventNotifier);

    /**
     * Adds the event notifier to use.
     * <p/>
     * Ensure the event notifier has been started if its a {@link Service}, as otherwise
     * it would not be used.
     *
     * @param eventNotifier event notifier
     */
    void addEventNotifier(EventNotifier eventNotifier);

    /**
     * Removes the event notifier
     *
     * @param eventNotifier event notifier to remove
     * @return <tt>true</tt> if removed, <tt>false</tt> if already removed
     */
    boolean removeEventNotifier(EventNotifier eventNotifier);

    /**
     * Gets the event factory
     *
     * @return event factory
     */
    EventFactory getEventFactory();

    /**
     * Sets the event factory to use
     *
     * @param eventFactory event factory
     */
    void setEventFactory(EventFactory eventFactory);

    /**
     * Gets the naming strategy to use
     *
     * @return naming strategy
     */
    ManagementNamingStrategy getManagementNamingStrategy();

    /**
     * Sets the naming strategy to use
     *
     * @param strategy naming strategy
     */
    void setManagementNamingStrategy(ManagementNamingStrategy strategy);

    /**
     * Gets the object strategy to use
     *
     * @return object strategy
     */
    ManagementObjectStrategy getManagementObjectStrategy();

    /**
     * Sets the object strategy to use
     *
     * @param strategy object strategy
     */
    void setManagementObjectStrategy(ManagementObjectStrategy strategy);

    /**
     * Gets the management agent
     *
     * @return management agent
     */
    ManagementAgent getManagementAgent();

    /**
     * Sets the management agent to use
     *
     * @param managementAgent management agent
     */
    void setManagementAgent(ManagementAgent managementAgent);

    /**
     * Filter whether the processor should be managed or not.
     * <p/>
     * Is used to filter out unwanted processors to avoid managing at too fine grained level.
     *
     * @param definition definition of the processor
     * @return <tt>true</tt> to manage it
     */
    boolean manageProcessor(ProcessorDefinition<?> definition);

    /**
     * Sets the whether only manage processors if they have been configured with a custom id
     * <p/>
     * Default is false.
     *
     * @param flag <tt>true</tt> will only manage if custom id was set.
     * @deprecated use {@link org.apache.camel.spi.ManagementAgent}
     */
    @Deprecated
    void onlyManageProcessorWithCustomId(boolean flag);

    /**
     * Checks whether only to manage processors if they have been configured with a custom id
     *
     * @return true or false
     * @deprecated use {@link org.apache.camel.spi.ManagementAgent}
     */
    @Deprecated
    boolean isOnlyManageProcessorWithCustomId();

    /**
     * Sets whether load statistics is enabled.
     *
     * @param flag <tt>true</tt> to enable load statistics
     * @deprecated use {@link org.apache.camel.spi.ManagementAgent}
     */
    @Deprecated
    void setLoadStatisticsEnabled(boolean flag);

    /**
     * Gets whether load statistics is enabled
     *
     * @return <tt>true</tt> if enabled
     * @deprecated use {@link org.apache.camel.spi.ManagementAgent}
     */
    @Deprecated
    boolean isLoadStatisticsEnabled();

    /**
     * Sets the statistics level
     * <p/>
     * Default is {@link org.apache.camel.ManagementStatisticsLevel#Default}
     *
     * @param level the new level
     * @deprecated use {@link org.apache.camel.spi.ManagementAgent}
     */
    @Deprecated
    void setStatisticsLevel(ManagementStatisticsLevel level);

    /**
     * Gets the statistics level
     *
     * @return the level
     * @deprecated use {@link org.apache.camel.spi.ManagementAgent}
     */
    @Deprecated
    ManagementStatisticsLevel getStatisticsLevel();

}