systests/src/main/java/org/apache/qpid/test/utils/BrokerHolder.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.qpid.test.utils;

import java.nio.file.Path;

public interface BrokerHolder
{
    void start() throws Exception;
    void start(boolean managementMode) throws Exception;
    void restart() throws Exception;
    void shutdown();
    void kill();
    void cleanUp();
    String dumpThreads();
    void createVirtualHostNode(String virtualHostNodeName, String storeType, String storeDir, String blueprint);
    TestBrokerConfiguration getConfiguration();
    String getConfigurationPath();
    Path getWorkDir();
    int getBrokerIndex();
    int getAmqpPort();
    int getHttpPort();
    int getHttpsPort();
    int getAmqpTlsPort();

    enum BrokerType
    {
        EXTERNAL /** Test case relies on a Broker started independently of the test-suite */,
        INTERNAL /** Test case starts an embedded broker within this JVM */,
        SPAWNED /** Test case spawns a new broker as a separate process */
    }
}