com.consol.citrus.dsl.builder.PurgeJmsQueuesBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of citrus-java-dsl Show documentation
There is a newer version: 3.4.1
/*
 * Copyright 2006-2015 the original author or authors.
 *
 * Licensed 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 com.consol.citrus.dsl.builder;

import com.consol.citrus.jms.actions.PurgeJmsQueuesAction;
import org.springframework.context.ApplicationContext;

import javax.jms.ConnectionFactory;
import javax.jms.Queue;
import java.util.Arrays;
import java.util.List;

/**
 * Action to purge JMS queue destinations by simply consuming 
 * all available messages. As queue purging is a broker implementation specific feature in
 * many cases this action clears all messages from a destination regardless of
 * JMS broker vendor implementations.
 *
 * Consumer will continue to receive messages until message receive timeout is reached,
 * so no messages are left.
 * 
 * @author Christoph Deppisch
 * @since 2.3
 */
public class PurgeJmsQueuesBuilder extends AbstractTestActionBuilder {

    /**
     * Constructor using action field.
     * @param action
     */
    public PurgeJmsQueuesBuilder(PurgeJmsQueuesAction action) {
        super(action);
    }

    /**
     * Default constructor.
     */
    public PurgeJmsQueuesBuilder() {
        super(new PurgeJmsQueuesAction());
    }

    /**
     * Sets the Connection factory.
     * @param connectionFactory the queueConnectionFactory to set
     */
    public PurgeJmsQueuesBuilder connectionFactory(ConnectionFactory connectionFactory) {
        action.setConnectionFactory(connectionFactory);
        return this;
    }

    /**
     * List of queues to purge in this action.
     * @param queues The queues which are to be purged.
     */
    public PurgeJmsQueuesBuilder queues(List queues) {
        action.getQueues().addAll(queues);
        return this;
    }

    /**
     * List of queues to purge in this action.
     * @param queues
     * @return
     */
    public PurgeJmsQueuesBuilder queues(Queue... queues) {
        return queues(Arrays.asList(queues));
    }

    /**
     * Adds a new queue to the list of queues to purge in this action.
     * @param queue
     * @return
     */
    public PurgeJmsQueuesBuilder queue(Queue queue) {
        action.getQueues().add(queue);
        return this;
    }

    /**
     * List of queue names to purge in this action. 
     * @param names the queueNames to set
     */
    public PurgeJmsQueuesBuilder queueNames(List names) {
        action.getQueueNames().addAll(names);
        return this;
    }

    /**
     * List of queue names to purge in this action.
     * @param names
     * @return
     */
    public PurgeJmsQueuesBuilder queueNames(String... names) {
        return queueNames(Arrays.asList(names));
    }

    /**
     * Adds a queue name to the list of queues to purge in this action.
     * @param name
     * @return
     */
    public PurgeJmsQueuesBuilder queue(String name) {
        action.getQueueNames().add(name);
        return this;
    }

    /**
     * Receive timeout for reading message from a destination.
     * @param receiveTimeout the receiveTimeout to set
     */
    public PurgeJmsQueuesBuilder timeout(long receiveTimeout) {
        action.setReceiveTimeout(receiveTimeout);
        return this;
    }

    /**
     * Sets the sleepTime.
     * @param millis the sleepTime to set
     */
    public PurgeJmsQueuesBuilder sleep(long millis) {
        action.setSleepTime(millis);
        return this;
    }

    /**
     * Checks if connection factory is set properly.
     * @return
     */
    public boolean hasConnectionFactory() {
        return action.getConnectionFactory() != null;
    }

    /**
     * Sets the Spring bean factory for using endpoint names.
     * @param applicationContext
     */
    public PurgeJmsQueuesBuilder withApplicationContext(ApplicationContext applicationContext) {
        if (applicationContext.containsBean("connectionFactory")) {
            connectionFactory(applicationContext.getBean("connectionFactory", ConnectionFactory.class));
        }

        return this;
    }
}