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.activemq.maven;
018
019import org.apache.activemq.broker.BrokerService;
020import org.apache.maven.plugin.MojoExecutionException;
021
022/**
023 * Manager of the broker used by the maven plugin.
024 */
025public interface MavenBrokerManager {
026    /**
027     * Start the broker using the fork setting and configuration at the given URI.
028     *
029     * @param fork true => run the broker asynchronously; false => run the broker synchronously (this method does not
030     *             return until the broker shuts down)
031     * @param configUri URI of the broker configuration; prefix with "xbean:file" to read XML configuration from a file.
032     * @throws MojoExecutionException
033     */
034    void start(boolean fork, String configUri) throws MojoExecutionException;
035
036    /**
037     * Stop the broker.
038     *
039     * @throws MojoExecutionException
040     */
041    void stop() throws MojoExecutionException;
042
043    /**
044     * Return the broker service created.
045     */
046    BrokerService getBroker();
047
048    /**
049     * Set the broker service managed to the one given.
050     *
051     * @param broker activemq instance to manage.
052     */
053    void setBroker(BrokerService broker);
054}