systests/src/main/java/org/apache/qpid/systest/core/JmsTestBase.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.systest.core;

import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.CoreMatchers.notNullValue;
import static org.junit.Assume.assumeThat;

import java.util.Collections;
import java.util.Map;

import javax.jms.Connection;
import javax.jms.JMSException;
import javax.jms.QueueConnection;
import javax.jms.TopicConnection;
import javax.naming.NamingException;

import org.junit.Before;
import org.junit.Rule;
import org.junit.rules.TestName;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.apache.qpid.configuration.ClientProperties;


public abstract class JmsTestBase extends BrokerAdminUsingTestBase
{
    private static final Logger LOGGER = LoggerFactory.getLogger(JmsTestBase.class);

    @Rule
    public final TestName _testName = new TestName();

    @Before
    public void setUpTestBase()
    {
        LOGGER.debug("Test receive timeout is {} milliseconds", getReceiveTimeout());
    }

    protected Connection getConnection() throws JMSException, NamingException
    {
        return getBrokerAdmin().getConnection();
    }

    @Override
    public BrokerAdmin getBrokerAdmin()
    {
        BrokerAdmin admin = super.getBrokerAdmin();
        assumeThat(String.format("BrokerAdmin is not available. Skipping the test %s#%s",
                                 getClass().getName(),
                                 _testName.getMethodName()),
                   admin, is(notNullValue()));
        return admin;
    }

    protected Connection getConnection(final Map<String, String> options) throws JMSException
    {
        return getBrokerAdmin().getConnection(options);
    }

    protected static long getReceiveTimeout()
    {
        return Long.getLong("qpid.test_receive_timeout", 1000L);
    }

    protected String getTestName()
    {
        return _testName.getMethodName();
    }


    protected TopicConnection getTopicConnection() throws JMSException, NamingException
    {
        return (TopicConnection) getConnection();
    }

    protected QueueConnection getQueueConnection() throws JMSException, NamingException
    {
        return (QueueConnection) getConnection();
    }

    protected String getProtocol()
    {
        return System.getProperty(ClientProperties.AMQP_VERSION, "0-10");
    }

    protected String getTestQueueName()
    {
        return getTestName();
    }

    public Connection getBrokerManagementConnection() throws JMSException
    {
        return getBrokerAdmin().getConnection("$management", Collections.<String, String>emptyMap());
    }
}