JmsPublishingService.java

/*
* Copyright 2015 herd contributors
*
* 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 org.finra.herd.service;

import org.finra.herd.model.dto.JmsMessage;

/**
 * The JMS publishing service.
 */
public interface JmsPublishingService
{
    /**
     * Adds a JMS message to the database queue.
     *
     * @param jmsQueueName the JMS queue name
     * @param messageText the message text
     *
     * @return the JMS message added to the queue
     */
    public JmsMessage addJmsMessageToDatabaseQueue(String jmsQueueName, String messageText);

    /**
     * Publishes and removes from the database queue the oldest JMS message.
     *
     * @return true if a message was sent or false if no message was sent (i.e. no message needed to be sent).
     */
    public boolean publishOldestJmsMessageFromDatabaseQueue();
}