nl.nn.adapterframework.jms.JmsTransactionalStorage.java Source code

Introduction

Here is the source code for nl.nn.adapterframework.jms.JmsTransactionalStorage.java

Source

/*
   Copyright 2013 Nationale-Nederlanden
    
   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 nl.nn.adapterframework.jms;

import java.io.Serializable;
import java.util.Date;

import javax.jms.JMSException;
import javax.jms.ObjectMessage;
import javax.jms.Session;

import org.apache.commons.lang.StringUtils;

import nl.nn.adapterframework.configuration.ConfigurationException;
import nl.nn.adapterframework.core.ITransactionalStorage;
import nl.nn.adapterframework.core.ListenerException;
import nl.nn.adapterframework.core.SenderException;

/**
 * JMS implementation of <code>ITransactionalStorage</code>.
 * 
 * <p><b>Configuration:</b>
 * <table border="1">
 * <tr><th>attributes</th><th>description</th><th>default</th></tr>
 * <tr><td>classname</td><td>nl.nn.adapterframework.jms.JmsTransactionalStorage</td><td>&nbsp;</td></tr>
 * <tr><td>{@link #setSlotId(String) slotId}</td><td>optional identifier for this storage, to be able to share the physical storage between a number of receivers</td><td>&nbsp;</td></tr>
 * <tr><td>{@link #setTimeOut(long) timeOut}</td><td>timeout for receiving messages from queue</td><td>3000 [ms]</td></tr>
 * <tr><td>{@link #setDestinationName(String) destinationName}</td><td>JNDI name of the queue to store messages on</td><td>&nbsp;</td></tr>
 * <tr><td>{@link #setJmsRealm(String) jmsRealm}</td><td>&nbsp;</td><td>&nbsp;</td></tr>
 * </table>
 * </p>
 * @author  Gerrit van Brakel
 * @since   4.1
 */
public class JmsTransactionalStorage extends JmsMessageBrowser implements ITransactionalStorage {

    public static final String FIELD_TYPE = "type";
    public static final String FIELD_ORIGINAL_ID = "originalId";
    public static final String FIELD_RECEIVED_DATE = "receivedDate";
    public static final String FIELD_COMMENTS = "comments";
    public static final String FIELD_SLOTID = "SlotId";
    public static final String FIELD_HOST = "host";
    public static final String FIELD_LABEL = "label";

    private String slotId = null;
    private String type = null;
    private boolean active = true;

    public JmsTransactionalStorage() {
        super();
        setTransacted(true);
        setPersistent(true);
        setDestinationType("QUEUE");
    }

    public void configure() throws ConfigurationException {
    }

    public String storeMessage(String messageId, String correlationId, Date receivedDate, String comments,
            String label, Serializable message) throws SenderException {
        Session session = null;
        try {
            session = createSession();
            ObjectMessage msg = session.createObjectMessage(message);
            msg.setStringProperty(FIELD_TYPE, getType());
            msg.setStringProperty(FIELD_ORIGINAL_ID, messageId);
            msg.setJMSCorrelationID(correlationId);
            msg.setLongProperty(FIELD_RECEIVED_DATE, receivedDate.getTime());
            msg.setStringProperty(FIELD_COMMENTS, comments);
            if (StringUtils.isNotEmpty(getSlotId())) {
                msg.setStringProperty(FIELD_SLOTID, getSlotId());
            }
            msg.setStringProperty(FIELD_LABEL, label);
            return send(session, getDestination(), msg);
        } catch (Exception e) {
            throw new SenderException(e);
        } finally {
            closeSession(session);
        }
    }

    public boolean containsMessageId(String originalMessageId) throws ListenerException {
        Object msg = doBrowse(FIELD_ORIGINAL_ID, originalMessageId);
        return msg != null;
    }

    public boolean containsCorrelationId(String correlationId) throws ListenerException {
        log.warn("could not determine correct presence of a message with correlationId [" + correlationId
                + "], assuming it doesnot exist");
        //TODO: check presence of a message with correlationId 
        return false;
    }

    public Object browseMessage(String messageId) throws ListenerException {
        try {
            ObjectMessage msg = (ObjectMessage) super.browseMessage(messageId);
            return msg.getObject();
        } catch (JMSException e) {
            throw new ListenerException(e);
        }
    }

    public Object getMessage(String messageId) throws ListenerException {
        try {
            ObjectMessage msg = (ObjectMessage) super.getMessage(messageId);
            return msg.getObject();
        } catch (JMSException e) {
            throw new ListenerException(e);
        }
    }

    public String getSelector() {
        if (StringUtils.isEmpty(getSlotId())) {
            return null;
        }
        return FIELD_SLOTID + "='" + getSlotId() + "'";
    }

    public void setSlotId(String string) {
        slotId = string;
    }

    public String getSlotId() {
        return slotId;
    }

    public void setType(String string) {
        type = string;
    }

    public String getType() {
        return type;
    }

    public void setActive(boolean b) {
        active = b;
    }

    public boolean isActive() {
        return active;
    }

}