/*
* This file is part of FFMQ.
*
* FFMQ is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* FFMQ is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFMQ; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
package net.timewalker.ffmq3.remote.connection;
import java.net.URI;
import javax.jms.JMSException;
import javax.jms.Session;
import net.timewalker.ffmq3.FFMQConstants;
import net.timewalker.ffmq3.FFMQException;
import net.timewalker.ffmq3.client.ClientEnvironment;
import net.timewalker.ffmq3.common.connection.AbstractConnection;
import net.timewalker.ffmq3.common.message.AbstractMessage;
import net.timewalker.ffmq3.common.session.AbstractSession;
import net.timewalker.ffmq3.remote.session.RemoteMessageConsumer;
import net.timewalker.ffmq3.remote.session.RemoteSession;
import net.timewalker.ffmq3.transport.PacketTransport;
import net.timewalker.ffmq3.transport.PacketTransportEndpoint;
import net.timewalker.ffmq3.transport.PacketTransportException;
import net.timewalker.ffmq3.transport.PacketTransportFactory;
import net.timewalker.ffmq3.transport.PacketTransportHub;
import net.timewalker.ffmq3.transport.PacketTransportListener;
import net.timewalker.ffmq3.transport.packet.AbstractPacket;
import net.timewalker.ffmq3.transport.packet.AbstractResponsePacket;
import net.timewalker.ffmq3.transport.packet.NotificationPacket;
import net.timewalker.ffmq3.transport.packet.query.DeleteTemporaryQueueQuery;
import net.timewalker.ffmq3.transport.packet.query.DeleteTemporaryTopicQuery;
import net.timewalker.ffmq3.transport.packet.query.OpenConnectionQuery;
import net.timewalker.ffmq3.transport.packet.query.RollbackMessageQuery;
import net.timewalker.ffmq3.transport.packet.query.SetClientIDQuery;
import net.timewalker.ffmq3.transport.packet.query.StartConnectionQuery;
import net.timewalker.ffmq3.transport.packet.query.StopConnectionQuery;
import net.timewalker.ffmq3.transport.packet.response.OpenConnectionResponse;
import net.timewalker.ffmq3.transport.packet.response.PingResponse;
import net.timewalker.ffmq3.utils.ErrorTools;
import net.timewalker.ffmq3.utils.async.AsyncTask;
import net.timewalker.ffmq3.utils.id.IntegerID;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* RemoteConnection
*/
public class RemoteConnection extends AbstractConnection implements PacketTransportListener
{
protected static final Log log = LogFactory.getLog(RemoteConnection.class);
// Attributes
private URI transportURI;
// Runtime
private PacketTransport transport;
protected PacketTransportHub transportHub;
protected PacketTransportEndpoint transportEndpoint;
/**
* Constructor
*/
public RemoteConnection( URI transportURI , String userName, String password , String clientID ) throws JMSException
{
super(clientID);
this.transportURI = transportURI;
try
{
connect(userName,password);
}
catch (JMSException e)
{
close();
throw e;
}
}
private void connect( String userName, String password ) throws JMSException
{
log.debug("#"+id+" Creating transport");
try
{
this.transport = PacketTransportFactory.getInstance().createPacketTransport(id,transportURI,ClientEnvironment.getSettings());
this.transport.setListener(this);
this.transport.start();
}
catch (PacketTransportException e)
{
throw new FFMQException("Could not establish transport","TRANSPORT_ERROR",e);
}
this.transportHub = new PacketTransportHub(transport);
this.transportEndpoint = transportHub.createEndpoint();
log.debug("#"+id+" Opening connection context");
OpenConnectionQuery query = new OpenConnectionQuery();
query.setUserName(userName);
query.setPassword(password);
query.setClientID(clientID);
OpenConnectionResponse response = (OpenConnectionResponse)transportEndpoint.blockingRequest(query);
// Check protocol version
if (response.getProtocolVersion() != FFMQConstants.TRANSPORT_PROTOCOL_VERSION)
throw new FFMQException("Transport protocol version mismatch (client is "+FFMQConstants.TRANSPORT_PROTOCOL_VERSION+", server is "+response.getProtocolVersion()+")","PROTOCOL_MISMATCH");
}
/* (non-Javadoc)
* @see net.timewalker.ffmq3.common.connection.AbstractConnection#setClientID(java.lang.String)
*/
public final void setClientID(String clientID) throws JMSException
{
super.setClientID(clientID);
SetClientIDQuery query = new SetClientIDQuery();
query.setClientID(clientID);
transportEndpoint.blockingRequest(query);
}
/* (non-Javadoc)
* @see net.timewalker.ffmq3.common.connection.AbstractConnection#onConnectionClose()
*/
protected void onConnectionClose()
{
super.onConnectionClose();
try
{
if (transport != null && !transport.isClosed())
{
log.debug("#"+id+" Closing transport");
this.transport.close();
}
}
catch (Exception e)
{
log.error("Could not close transport",e);
}
}
/*
* (non-Javadoc)
* @see net.timewalker.ffmq3.common.connection.AbstractConnection#onConnectionClosed()
*/
protected void onConnectionClosed()
{
super.onConnectionClosed();
if (transportHub != null)
transportHub.close();
}
/* (non-Javadoc)
* @see net.timewalker.ffmq3.common.connection.AbstractConnection#deleteTemporaryQueue(java.lang.String)
*/
public final void deleteTemporaryQueue(String queueName) throws JMSException
{
DeleteTemporaryQueueQuery query = new DeleteTemporaryQueueQuery();
query.setQueueName(queueName);
transportEndpoint.blockingRequest(query);
}
/* (non-Javadoc)
* @see net.timewalker.ffmq3.common.connection.AbstractConnection#deleteTemporaryTopic(java.lang.String)
*/
public final void deleteTemporaryTopic(String topicName) throws JMSException
{
DeleteTemporaryTopicQuery query = new DeleteTemporaryTopicQuery();
query.setTopicName(topicName);
transportEndpoint.blockingRequest(query);
}
/* (non-Javadoc)
* @see javax.jms.Connection#createSession(boolean, int)
*/
public final Session createSession(boolean transacted, int acknowledgeMode) throws JMSException
{
if (!transacted && acknowledgeMode == Session.SESSION_TRANSACTED)
throw new FFMQException("Acknowledge mode SESSION_TRANSACTED cannot be used for an non-transacted session","INVALID_ACK_MODE");
synchronized (externalAccessLock)
{
checkNotClosed();
RemoteSession session = new RemoteSession(idProvider.createID(),
this,
transportHub.createEndpoint(),
transacted,
acknowledgeMode);
registerSession(session);
session.remoteInit();
return session;
}
}
/* (non-Javadoc)
* @see javax.jms.Connection#start()
*/
public final void start() throws JMSException
{
synchronized (externalAccessLock)
{
checkNotClosed();
if (started)
return;
started = true;
}
transportEndpoint.blockingRequest(new StartConnectionQuery());
}
/* (non-Javadoc)
* @see javax.jms.Connection#stop()
*/
public final void stop() throws JMSException
{
synchronized (externalAccessLock)
{
checkNotClosed();
if (!started)
return;
started = false;
}
transportEndpoint.blockingRequest(new StopConnectionQuery());
}
/*
* (non-Javadoc)
* @see net.timewalker.ffmq3.remote.transport.PacketTransportListener#packetReceived(net.timewalker.ffmq3.remote.transport.packet.AbstractPacket)
*/
public final boolean packetReceived(AbstractPacket packet)
{
if (packet instanceof PingResponse)
return true;
if (packet instanceof NotificationPacket)
{
final NotificationPacket notifPacket = (NotificationPacket)packet;
final AbstractMessage prefetchedMessage = notifPacket.getMessage();
boolean acceptedByConsumer = false;
AbstractSession session = lookupRegisteredSession(notifPacket.getSessionId());
if (session != null)
{
RemoteMessageConsumer consumer = (RemoteMessageConsumer)session.lookupRegisteredConsumer(notifPacket.getConsumerId());
if (consumer != null)
acceptedByConsumer = consumer.addToPrefetchQueue(prefetchedMessage,notifPacket.getPrefetchCapacity());
else
log.debug("#"+id+" No such consumer : #"+notifPacket.getSessionId()+":"+notifPacket.getConsumerId()); // Consumer was concurrently closed or not yet registered
}
else
log.debug("#"+id+" No such session : #"+notifPacket.getSessionId()); // Session was concurrently closed
// If the consumer was already gone, we need to rollback the prefetched message on the server side
if (!acceptedByConsumer)
scheduleRollback(notifPacket.getSessionId(),
notifPacket.getConsumerId(),
prefetchedMessage);
return true;
}
// Standard response, route to target endpoint
transportHub.routeResponse((AbstractResponsePacket)packet);
return true;
}
private void scheduleRollback( final IntegerID sessionId , final IntegerID consumerId , AbstractMessage message )
{
try
{
final String messageId = message.getJMSMessageID();
// Schedule an async rollback
ClientEnvironment.getAsyncTaskManager().execute(new AsyncTask()
{
/*
* (non-Javadoc)
* @see net.timewalker.ffmq3.utils.async.AsyncTask#isMergeable()
*/
public boolean isMergeable() { return false; }
/*
* (non-Javadoc)
* @see net.timewalker.ffmq3.utils.async.AsyncTask#execute()
*/
public void execute()
{
RollbackMessageQuery query = new RollbackMessageQuery();
query.setSessionId(sessionId);
query.setConsumerId(consumerId);
query.setMessageId(messageId);
try
{
transportEndpoint.blockingRequest(query);
}
catch (JMSException e)
{
ErrorTools.log(e, log);
}
}
});
}
catch (JMSException e)
{
ErrorTools.log(e, log);
}
}
/*
* (non-Javadoc)
* @see net.timewalker.ffmq3.remote.transport.PacketTransportListener#packetSent(net.timewalker.ffmq3.remote.transport.packet.AbstractPacket)
*/
public final void packetSent(AbstractPacket packet)
{
// Nothing
}
/* (non-Javadoc)
* @see net.timewalker.ffmq3.remote.transport.PacketTransportListener#transportClosed(boolean)
*/
public final void transportClosed(boolean linkFailed)
{
if (linkFailed)
{
close();
exceptionOccured(new FFMQException("Server connection lost","NETWORK_FAILURE"));
}
}
}