/*
*
* 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.client;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.apache.qpid.AMQException;
import org.apache.qpid.client.failover.FailoverException;
import org.apache.qpid.client.failover.FailoverProtectedOperation;
import org.apache.qpid.client.transport.ClientConnectionDelegate;
import org.apache.qpid.common.ServerPropertyNames;
import org.apache.qpid.configuration.ClientProperties;
import org.apache.qpid.framing.ProtocolVersion;
import org.apache.qpid.jms.BrokerDetails;
import org.apache.qpid.jms.ChannelLimitReachedException;
import org.apache.qpid.jms.Session;
import org.apache.qpid.properties.ConnectionStartProperties;
import org.apache.qpid.protocol.AMQConstant;
import org.apache.qpid.transport.Connection;
import org.apache.qpid.transport.ConnectionClose;
import org.apache.qpid.transport.ConnectionCloseCode;
import org.apache.qpid.transport.ConnectionException;
import org.apache.qpid.transport.ConnectionListener;
import org.apache.qpid.transport.ConnectionSettings;
import org.apache.qpid.transport.ProtocolVersionException;
import org.apache.qpid.transport.SessionDetachCode;
import org.apache.qpid.transport.SessionException;
import org.apache.qpid.transport.TransportException;
import javax.jms.ExceptionListener;
import javax.jms.JMSException;
import javax.jms.XASession;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.CountDownLatch;
public class AMQConnectionDelegate_0_10 implements AMQConnectionDelegate, ConnectionListener
{
/**
* This class logger.
*/
private static final Logger _logger = LoggerFactory.getLogger(AMQConnectionDelegate_0_10.class);
/**
* The AMQ Connection.
*/
private final AMQConnection _conn;
/**
* The QpidConeection instance that is mapped with this JMS connection.
*/
private org.apache.qpid.transport.Connection _qpidConnection;
private ConnectionException exception = null;
//--- constructor
public AMQConnectionDelegate_0_10(AMQConnection conn)
{
_conn = conn;
_qpidConnection = new Connection();
_qpidConnection.addConnectionListener(this);
}
/**
* create a Session and start it if required.
*/
public Session createSession(boolean transacted, int acknowledgeMode, int prefetchHigh, int prefetchLow)
throws JMSException
{
return createSession(transacted,acknowledgeMode,prefetchHigh,prefetchLow,null);
}
public Session createSession(boolean transacted, int acknowledgeMode, int prefetchHigh, int prefetchLow, String name)
throws JMSException
{
_conn.checkNotClosed();
if (_conn.channelLimitReached())
{
throw new ChannelLimitReachedException(_conn.getMaximumChannelCount());
}
int channelId = _conn.getNextChannelID();
AMQSession session;
try
{
session = new AMQSession_0_10(_qpidConnection, _conn, channelId, transacted, acknowledgeMode, prefetchHigh,
prefetchLow,name);
_conn.registerSession(channelId, session);
if (_conn.started())
{
session.start();
}
}
catch (Exception e)
{
_logger.error("exception creating session:", e);
throw new JMSAMQException("cannot create session", e);
}
return session;
}
/**
* Create an XASession with default prefetch values of:
* High = MaxPrefetch
* Low = MaxPrefetch / 2
* @return XASession
* @throws JMSException
*/
public XASession createXASession() throws JMSException
{
return createXASession((int) _conn.getMaxPrefetch(), (int) _conn.getMaxPrefetch() / 2);
}
/**
* create an XA Session and start it if required.
*/
public XASession createXASession(int prefetchHigh, int prefetchLow) throws JMSException
{
_conn.checkNotClosed();
if (_conn.channelLimitReached())
{
throw new ChannelLimitReachedException(_conn.getMaximumChannelCount());
}
int channelId = _conn.getNextChannelID();
XASessionImpl session;
try
{
session = new XASessionImpl(_qpidConnection, _conn, channelId, prefetchHigh, prefetchLow);
_conn.registerSession(channelId, session);
if (_conn.started())
{
session.start();
}
}
catch (Exception e)
{
throw new JMSAMQException("cannot create session", e);
}
return session;
}
public XASession createXASession(int ackMode)
throws JMSException
{
_conn.checkNotClosed();
if (_conn.channelLimitReached())
{
throw new ChannelLimitReachedException(_conn.getMaximumChannelCount());
}
int channelId = _conn.getNextChannelID();
XASessionImpl session;
try
{
session = new XASessionImpl(_qpidConnection, _conn, channelId, ackMode, (int)_conn.getMaxPrefetch(), (int)_conn.getMaxPrefetch() / 2);
_conn.registerSession(channelId, session);
if (_conn.started())
{
session.start();
}
}
catch (Exception e)
{
throw new JMSAMQException("cannot create session", e);
}
return session;
}
/**
* Make a connection with the broker
*
* @param brokerDetail The detail of the broker to connect to.
* @throws IOException
* @throws AMQException
*/
public ProtocolVersion makeBrokerConnection(BrokerDetails brokerDetail) throws IOException, AMQException
{
try
{
if (_logger.isDebugEnabled())
{
_logger.debug("connecting to host: " + brokerDetail.getHost()
+ " port: " + brokerDetail.getPort() + " vhost: "
+ _conn.getVirtualHost() + " username: "
+ _conn.getUsername() + " password: "
+ "********");
}
ConnectionSettings conSettings = retriveConnectionSettings(brokerDetail);
_qpidConnection.setConnectionDelegate(new ClientConnectionDelegate(conSettings, _conn.getConnectionURL()));
_qpidConnection.connect(conSettings);
_conn.setConnected(true);
_conn.setUsername(_qpidConnection.getUserID());
_conn.setMaximumChannelCount(_qpidConnection.getChannelMax());
_conn.getFailoverPolicy().attainedConnection();
_conn.logConnected(_qpidConnection.getLocalAddress(), _qpidConnection.getRemoteAddress());
}
catch (ProtocolVersionException pe)
{
return new ProtocolVersion(pe.getMajor(), pe.getMinor());
}
catch (ConnectionException ce)
{
AMQConstant code = AMQConstant.REPLY_SUCCESS;
if (ce.getClose() != null && ce.getClose().getReplyCode() != null)
{
code = AMQConstant.getConstant(ce.getClose().getReplyCode().getValue());
}
String msg = "Cannot connect to broker: " + ce.getMessage();
throw new AMQException(code, msg, ce);
}
return null;
}
public void failoverPrep()
{
List<AMQSession> sessions = new ArrayList<AMQSession>(_conn.getSessions().values());
for (AMQSession s : sessions)
{
s.failoverPrep();
}
}
public void resubscribeSessions() throws JMSException, AMQException, FailoverException
{
_logger.info("Resuming connection");
getQpidConnection().resume();
List<AMQSession> sessions = new ArrayList<AMQSession>(_conn.getSessions().values());
_logger.info(String.format("Resubscribing sessions = %s sessions.size=%d", sessions, sessions.size()));
for (AMQSession s : sessions)
{
s.resubscribe();
}
}
public void closeConnection(long timeout) throws JMSException, AMQException
{
try
{
_qpidConnection.close();
}
catch (TransportException e)
{
throw new AMQException(e.getMessage(), e);
}
}
public void opened(Connection conn) {}
public void exception(Connection conn, ConnectionException exc)
{
if (exception != null)
{
_logger.error("previous exception", exception);
}
exception = exc;
}
public void closed(Connection conn)
{
ConnectionException exc = exception;
exception = null;
if (exc == null)
{
return;
}
ConnectionClose close = exc.getClose();
if (close == null || close.getReplyCode() == ConnectionCloseCode.CONNECTION_FORCED)
{
_conn.getProtocolHandler().setFailoverLatch(new CountDownLatch(1));
_qpidConnection.notifyFailoverRequired();
synchronized (_conn.getFailoverMutex())
{
try
{
if (_conn.firePreFailover(false) && _conn.attemptReconnection())
{
_conn.failoverPrep();
_conn.resubscribeSessions();
_conn.fireFailoverComplete();
return;
}
}
catch (Exception e)
{
_logger.error("error during failover", e);
}
finally
{
_conn.getProtocolHandler().getFailoverLatch().countDown();
_conn.getProtocolHandler().setFailoverLatch(null);
}
}
}
_conn.setClosed();
ExceptionListener listener = _conn.getExceptionListenerNoCheck();
if (listener == null)
{
_logger.error("connection exception: " + conn, exc);
}
else
{
String code = null;
if (close != null)
{
code = close.getReplyCode().toString();
}
JMSException ex = new JMSException(exc.getMessage(), code);
ex.setLinkedException(exc);
ex.initCause(exc);
listener.onException(ex);
}
}
public <T, E extends Exception> T executeRetrySupport(FailoverProtectedOperation<T,E> operation) throws E
{
if (_conn.isFailingOver())
{
try
{
_conn.blockUntilNotFailingOver();
}
catch (InterruptedException e)
{
//ignore
}
}
try
{
return operation.execute();
}
catch (FailoverException e)
{
throw new RuntimeException(e);
}
}
public int getMaxChannelID()
{
//For a negotiated channelMax N, there are channels 0 to N-1 available.
return _qpidConnection.getChannelMax() - 1;
}
public int getMinChannelID()
{
return Connection.MIN_USABLE_CHANNEL_NUM;
}
public ProtocolVersion getProtocolVersion()
{
return ProtocolVersion.v0_10;
}
public String getUUID()
{
return (String)_qpidConnection.getServerProperties().get(ServerPropertyNames.FEDERATION_TAG);
}
/*
* @see org.apache.qpid.client.AMQConnectionDelegate#isSupportedServerFeature(java.lang.String)
*/
public boolean isSupportedServerFeature(final String featureName)
{
if (featureName == null)
{
throw new IllegalArgumentException("featureName cannot be null");
}
final Map<String, Object> serverProperties = _qpidConnection.getServerProperties();
boolean featureSupported = false;
if (serverProperties != null && serverProperties.containsKey(ServerPropertyNames.QPID_FEATURES))
{
final Object supportServerFeatures = serverProperties.get(ServerPropertyNames.QPID_FEATURES);
featureSupported = supportServerFeatures instanceof List && ((List<String>)supportServerFeatures).contains(featureName);
}
if (_logger.isDebugEnabled())
{
_logger.debug("Server support for feature '" + featureName + "' : " + featureSupported);
}
return featureSupported;
}
private ConnectionSettings retriveConnectionSettings(BrokerDetails brokerDetail)
{
ConnectionSettings conSettings = brokerDetail.buildConnectionSettings();
conSettings.setVhost(_conn.getVirtualHost());
conSettings.setUsername(_conn.getUsername());
conSettings.setPassword(_conn.getPassword());
// Pass client name from connection URL
Map<String, Object> clientProps = new HashMap<String, Object>();
try
{
clientProps.put(ConnectionStartProperties.CLIENT_ID_0_10, _conn.getClientID());
conSettings.setClientProperties(clientProps);
}
catch (JMSException e)
{
// Ignore
}
conSettings.setHeartbeatInterval(getHeartbeatInterval(brokerDetail));
return conSettings;
}
// The idle_timeout prop is in milisecs while
// the new heartbeat prop is in secs
private int getHeartbeatInterval(BrokerDetails brokerDetail)
{
int heartbeat = 0;
if (brokerDetail.getProperty(BrokerDetails.OPTIONS_IDLE_TIMEOUT) != null)
{
_logger.warn("Broker property idle_timeout=<mili_secs> is deprecated, please use heartbeat=<secs>");
heartbeat = Integer.parseInt(brokerDetail.getProperty(BrokerDetails.OPTIONS_IDLE_TIMEOUT))/1000;
}
else if (brokerDetail.getProperty(BrokerDetails.OPTIONS_HEARTBEAT) != null)
{
heartbeat = Integer.parseInt(brokerDetail.getProperty(BrokerDetails.OPTIONS_HEARTBEAT));
}
else if (Integer.getInteger(ClientProperties.IDLE_TIMEOUT_PROP_NAME) != null)
{
heartbeat = Integer.getInteger(ClientProperties.IDLE_TIMEOUT_PROP_NAME)/1000;
_logger.warn("JVM arg -Didle_timeout=<mili_secs> is deprecated, please use -Dqpid.heartbeat=<secs>");
}
else
{
heartbeat = Integer.getInteger(ClientProperties.HEARTBEAT,ClientProperties.HEARTBEAT_DEFAULT);
}
return heartbeat;
}
protected org.apache.qpid.transport.Connection getQpidConnection()
{
return _qpidConnection;
}
public boolean verifyClientID() throws JMSException, AMQException
{
int prefetch = (int)_conn.getMaxPrefetch();
AMQSession_0_10 ssn = (AMQSession_0_10)createSession(false, 1,prefetch,prefetch,_conn.getClientID());
org.apache.qpid.transport.Session ssn_0_10 = ssn.getQpidSession();
try
{
ssn_0_10.awaitOpen();
}
catch(SessionException se)
{
//if due to non unique client id for user return false, otherwise wrap and re-throw.
if (ssn_0_10.getDetachCode() != null &&
ssn_0_10.getDetachCode() == SessionDetachCode.SESSION_BUSY)
{
return false;
}
else
{
throw new AMQException(AMQConstant.INTERNAL_ERROR, "Unexpected SessionException thrown while awaiting session opening", se);
}
}
return true;
}
}