Java tutorial
/** * 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.karaf.jms.pool.internal; import org.apache.commons.pool2.KeyedPooledObjectFactory; import org.apache.commons.pool2.PooledObject; import org.apache.commons.pool2.impl.DefaultPooledObject; import org.apache.commons.pool2.impl.GenericKeyedObjectPool; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import javax.jms.Connection; import javax.jms.ConnectionFactory; import javax.jms.JMSException; import javax.jms.QueueConnection; import javax.jms.QueueConnectionFactory; import javax.jms.TopicConnection; import javax.jms.TopicConnectionFactory; import java.util.Objects; import java.util.concurrent.atomic.AtomicBoolean; /** * A JMS provider which pools Connection, Session and MessageProducer instances * so it can be used with tools like <a href="http://camel.apache.org/activemq.html">Camel</a> and Spring's * <a href="http://activemq.apache.org/spring-support.html">JmsTemplate and MessagListenerContainer</a>. * Connections, sessions and producers are returned to a pool after use so that they can be reused later * without having to undergo the cost of creating them again. * * b>NOTE:</b> while this implementation does allow the creation of a collection of active consumers, * it does not 'pool' consumers. Pooling makes sense for connections, sessions and producers, which * are expensive to create and can remain idle a minimal cost. Consumers, on the other hand, are usually * just created at startup and left active, handling incoming messages as they come. When a consumer is * complete, it is best to close it rather than return it to a pool for later reuse: this is because, * even if a consumer is idle, ActiveMQ will keep delivering messages to the consumer's prefetch buffer, * where they'll get held until the consumer is active again. * * If you are creating a collection of consumers (for example, for multi-threaded message consumption), you * might want to consider using a lower prefetch value for each consumer (e.g. 10 or 20), to ensure that * all messages don't end up going to just one of the consumers. See this FAQ entry for more detail: * http://activemq.apache.org/i-do-not-receive-messages-in-my-second-consumer.html * * Optionally, one may configure the pool to examine and possibly evict objects as they sit idle in the * pool. This is performed by an "idle object eviction" thread, which runs asynchronously. Caution should * be used when configuring this optional feature. Eviction runs contend with client threads for access * to objects in the pool, so if they run too frequently performance issues may result. The idle object * eviction thread may be configured using the {@link PooledConnectionFactory#setTimeBetweenExpirationCheckMillis} method. By * default the value is -1 which means no eviction thread will be run. Set to a non-negative value to * configure the idle eviction thread to run. */ public class PooledConnectionFactory implements ConnectionFactory, QueueConnectionFactory, TopicConnectionFactory { private static final transient Logger LOG = LoggerFactory.getLogger(PooledConnectionFactory.class); private final AtomicBoolean stopped = new AtomicBoolean(false); private GenericKeyedObjectPool<ConnectionKey, ConnectionPool> connectionsPool; private final ConnectionFactory connectionFactory; private int maximumActiveSessionPerConnection = 500; private int idleTimeout = 30 * 1000; private boolean blockIfSessionPoolIsFull = true; private long blockIfSessionPoolIsFullTimeout = -1L; private long expiryTimeout = 0L; private boolean createConnectionOnStartup = true; private boolean useAnonymousProducers = true; public PooledConnectionFactory(ConnectionFactory connectionFactory) { this.connectionFactory = Objects.requireNonNull(connectionFactory, "connectionFactory must be set"); } public void initConnectionsPool() { if (this.connectionsPool == null) { this.connectionsPool = new GenericKeyedObjectPool<>( new KeyedPooledObjectFactory<ConnectionKey, ConnectionPool>() { @Override public void activateObject(ConnectionKey key, PooledObject<ConnectionPool> connection) throws Exception { } @Override public void destroyObject(ConnectionKey key, PooledObject<ConnectionPool> connection) throws Exception { try { if (LOG.isTraceEnabled()) { LOG.trace("Destroying connection: {}", connection); } connection.getObject().close(); } catch (Exception e) { LOG.warn("Close connection failed for connection: " + connection + ". This exception will be ignored.", e); } } @Override public PooledObject<ConnectionPool> makeObject(ConnectionKey key) throws Exception { Connection delegate = createConnection(key); ConnectionPool connection = createConnectionPool(delegate); connection.setIdleTimeout(getIdleTimeout()); connection.setExpiryTimeout(getExpiryTimeout()); connection.setMaximumActiveSessionPerConnection(getMaximumActiveSessionPerConnection()); connection.setBlockIfSessionPoolIsFull(isBlockIfSessionPoolIsFull()); if (isBlockIfSessionPoolIsFull() && getBlockIfSessionPoolIsFullTimeout() > 0) { connection.setBlockIfSessionPoolIsFullTimeout(getBlockIfSessionPoolIsFullTimeout()); } connection.setUseAnonymousProducers(isUseAnonymousProducers()); if (LOG.isTraceEnabled()) { LOG.trace("Created new connection: {}", connection); } return new DefaultPooledObject<>(connection); } @Override public void passivateObject(ConnectionKey key, PooledObject<ConnectionPool> connection) throws Exception { } @Override public boolean validateObject(ConnectionKey key, PooledObject<ConnectionPool> connection) { if (connection != null && connection.getObject() != null && connection.getObject().expiredCheck()) { if (LOG.isTraceEnabled()) { LOG.trace("Connection has expired: {} and will be destroyed", connection); } return false; } return true; } }); // Set max idle (not max active) since our connections always idle in the pool. this.connectionsPool.setMaxIdlePerKey(1); // We always want our validate method to control when idle objects are evicted. this.connectionsPool.setTestOnBorrow(true); this.connectionsPool.setTestWhileIdle(true); } } /** * @return the currently configured ConnectionFactory used to create the pooled Connections. */ public ConnectionFactory getConnectionFactory() { return connectionFactory; } @Override public Connection createConnection() throws JMSException { return createConnection(null, null); } @Override public synchronized Connection createConnection(String userName, String password) throws JMSException { if (stopped.get()) { LOG.debug("PooledConnectionFactory is stopped, skip create new connection."); return null; } ConnectionPool connection = null; ConnectionKey key = new ConnectionKey(userName, password); // This will either return an existing non-expired ConnectionPool or it // will create a new one to meet the demand. if (getConnectionsPool().getNumIdle(key) < getMaxConnections()) { try { // we want borrowObject to return the one we added. connectionsPool.setLifo(true); connectionsPool.addObject(key); } catch (Exception e) { throw createJmsException("Error while attempting to add new Connection to the pool", e); } } else { // now we want the oldest one in the pool. connectionsPool.setLifo(false); } try { // We can race against other threads returning the connection when there is an // expiration or idle timeout. We keep pulling out ConnectionPool instances until // we win and get a non-closed instance and then increment the reference count // under lock to prevent another thread from triggering an expiration check and // pulling the rug out from under us. while (true) { ConnectionPool cp = connectionsPool.borrowObject(key); synchronized (cp) { if (cp.getConnection() != null) { cp.incrementReferenceCount(); connection = cp; break; } // Return the bad one to the pool and let if get destroyed as normal. connectionsPool.returnObject(key, cp); } } } catch (Exception e) { throw createJmsException("Error while attempting to retrieve a connection from the pool", e); } try { connectionsPool.returnObject(key, connection); } catch (Exception e) { throw createJmsException("Error when returning connection to the pool", e); } return newPooledConnection(connection); } protected Connection newPooledConnection(ConnectionPool connection) { return new PooledConnection(connection); } private JMSException createJmsException(String msg, Exception cause) { JMSException exception = new JMSException(msg); exception.setLinkedException(cause); exception.initCause(cause); return exception; } protected Connection createConnection(ConnectionKey key) throws JMSException { if (key.getUserName() == null && key.getPassword() == null) { return connectionFactory.createConnection(); } else { return connectionFactory.createConnection(key.getUserName(), key.getPassword()); } } public void start() { LOG.debug("Starting the PooledConnectionFactory: create on start = {}", isCreateConnectionOnStartup()); stopped.set(false); if (isCreateConnectionOnStartup()) { try { // warm the pool by creating a connection during startup createConnection(); } catch (JMSException e) { LOG.warn("Create pooled connection during start failed. This exception will be ignored.", e); } } } public void stop() { if (stopped.compareAndSet(false, true)) { LOG.debug("Stopping the PooledConnectionFactory, number of connections in cache: {}", connectionsPool != null ? connectionsPool.getNumActive() : 0); try { if (connectionsPool != null) { connectionsPool.close(); } } catch (Exception e) { } } } /** * Clears all connections from the pool. Each connection that is currently in the pool is * closed and removed from the pool. A new connection will be created on the next call to * {@link #createConnection()}. Care should be taken when using this method as Connections that * are in use be client's will be closed. */ public void clear() { if (stopped.get()) { return; } getConnectionsPool().clear(); } /** * Returns the currently configured maximum number of sessions a pooled Connection will * create before it either blocks or throws an exception when a new session is requested, * depending on configuration. * * @return the number of session instances that can be taken from a pooled connection. */ public int getMaximumActiveSessionPerConnection() { return maximumActiveSessionPerConnection; } /** * Sets the maximum number of active sessions per connection * * @param maximumActiveSessionPerConnection * The maximum number of active session per connection in the pool. */ public void setMaximumActiveSessionPerConnection(int maximumActiveSessionPerConnection) { this.maximumActiveSessionPerConnection = maximumActiveSessionPerConnection; } /** * Controls the behavior of the internal session pool. By default the call to * Connection.getSession() will block if the session pool is full. If the * argument false is given, it will change the default behavior and instead the * call to getSession() will throw a JMSException. * * The size of the session pool is controlled by the @see #maximumActive * property. * * @param block - if true, the call to getSession() blocks if the pool is full * until a session object is available. defaults to true. */ public void setBlockIfSessionPoolIsFull(boolean block) { this.blockIfSessionPoolIsFull = block; } /** * Returns whether a pooled Connection will enter a blocked state or will throw an Exception * once the maximum number of sessions has been borrowed from the the Session Pool. * * @return true if the pooled Connection createSession method will block when the limit is hit. * @see #setBlockIfSessionPoolIsFull(boolean) */ public boolean isBlockIfSessionPoolIsFull() { return this.blockIfSessionPoolIsFull; } /** * Returns the maximum number to pooled Connections that this factory will allow before it * begins to return connections from the pool on calls to ({@link #createConnection()}. * * @return the maxConnections that will be created for this pool. */ public int getMaxConnections() { return getConnectionsPool().getMaxIdlePerKey(); } /** * Sets the maximum number of pooled Connections (defaults to one). Each call to * {@link #createConnection()} will result in a new Connection being create up to the max * connections value. * * @param maxConnections the maxConnections to set */ public void setMaxConnections(int maxConnections) { getConnectionsPool().setMaxIdlePerKey(maxConnections); } /** * Gets the Idle timeout value applied to new Connection's that are created by this pool. * <p/> * The idle timeout is used determine if a Connection instance has sat to long in the pool unused * and if so is closed and removed from the pool. The default value is 30 seconds. * * @return idle timeout value (milliseconds) */ public int getIdleTimeout() { return idleTimeout; } /** * Sets the idle timeout value for Connection's that are created by this pool in Milliseconds, * defaults to 30 seconds. * <p/> * For a Connection that is in the pool but has no current users the idle timeout determines how * long the Connection can live before it is eligible for removal from the pool. Normally the * connections are tested when an attempt to check one out occurs so a Connection instance can sit * in the pool much longer than its idle timeout if connections are used infrequently. * * @param idleTimeout * The maximum time a pooled Connection can sit unused before it is eligible for removal. */ public void setIdleTimeout(int idleTimeout) { this.idleTimeout = idleTimeout; } /** * allow connections to expire, irrespective of load or idle time. This is useful with failover * to force a reconnect from the pool, to reestablish load balancing or use of the master post recovery * * @param expiryTimeout non zero in milliseconds */ public void setExpiryTimeout(long expiryTimeout) { this.expiryTimeout = expiryTimeout; } /** * @return the configured expiration timeout for connections in the pool. */ public long getExpiryTimeout() { return expiryTimeout; } /** * @return true if a Connection is created immediately on a call to {@link #start()}. */ public boolean isCreateConnectionOnStartup() { return createConnectionOnStartup; } /** * Whether to create a connection on starting this {@link PooledConnectionFactory}. * <p/> * This can be used to warm-up the pool on startup. Notice that any kind of exception * happens during startup is logged at WARN level and ignored. * * @param createConnectionOnStartup <tt>true</tt> to create a connection on startup */ public void setCreateConnectionOnStartup(boolean createConnectionOnStartup) { this.createConnectionOnStartup = createConnectionOnStartup; } /** * Should Sessions use one anonymous producer for all producer requests or should a new * MessageProducer be created for each request to create a producer object, default is true. * * When enabled the session only needs to allocate one MessageProducer for all requests and * the MessageProducer#send(destination, message) method can be used. Normally this is the * right thing to do however it does result in the Broker not showing the producers per * destination. * * @return true if a PooledSession will use only a single anonymous message producer instance. */ public boolean isUseAnonymousProducers() { return this.useAnonymousProducers; } /** * Sets whether a PooledSession uses only one anonymous MessageProducer instance or creates * a new MessageProducer for each call the create a MessageProducer. * * @param value * Boolean value that configures whether anonymous producers are used. */ public void setUseAnonymousProducers(boolean value) { this.useAnonymousProducers = value; } /** * Gets the Pool of ConnectionPool instances which are keyed by different ConnectionKeys. * * @return this factories pool of ConnectionPool instances. */ protected GenericKeyedObjectPool<ConnectionKey, ConnectionPool> getConnectionsPool() { initConnectionsPool(); return this.connectionsPool; } /** * Sets the number of milliseconds to sleep between runs of the idle Connection eviction thread. * When non-positive, no idle object eviction thread will be run, and Connections will only be * checked on borrow to determine if they have sat idle for too long or have failed for some * other reason. * <p/> * By default this value is set to -1 and no expiration thread ever runs. * * @param timeBetweenExpirationCheckMillis * The time to wait between runs of the idle Connection eviction thread. */ public void setTimeBetweenExpirationCheckMillis(long timeBetweenExpirationCheckMillis) { getConnectionsPool().setTimeBetweenEvictionRunsMillis(timeBetweenExpirationCheckMillis); } /** * @return the number of milliseconds to sleep between runs of the idle connection eviction thread. */ public long getTimeBetweenExpirationCheckMillis() { return getConnectionsPool().getTimeBetweenEvictionRunsMillis(); } /** * @return the number of Connections currently in the Pool */ public int getNumConnections() { return getConnectionsPool().getNumIdle(); } /** * Delegate that creates each instance of an ConnectionPool object. Subclasses can override * this method to customize the type of connection pool returned. * * @param connection * * @return instance of a new ConnectionPool. */ protected ConnectionPool createConnectionPool(Connection connection) { return new ConnectionPool(connection); } /** * Returns the timeout to use for blocking creating new sessions * * @return true if the pooled Connection createSession method will block when the limit is hit. * @see #setBlockIfSessionPoolIsFull(boolean) */ public long getBlockIfSessionPoolIsFullTimeout() { return blockIfSessionPoolIsFullTimeout; } /** * Controls the behavior of the internal session pool. By default the call to * Connection.getSession() will block if the session pool is full. This setting * will affect how long it blocks and throws an exception after the timeout. * * The size of the session pool is controlled by the @see #maximumActive * property. * * Whether or not the call to create session blocks is controlled by the @see #blockIfSessionPoolIsFull * property * * @param blockIfSessionPoolIsFullTimeout - if blockIfSessionPoolIsFullTimeout is true, * then use this setting to configure how long to block before retry */ public void setBlockIfSessionPoolIsFullTimeout(long blockIfSessionPoolIsFullTimeout) { this.blockIfSessionPoolIsFullTimeout = blockIfSessionPoolIsFullTimeout; } @Override public QueueConnection createQueueConnection() throws JMSException { return (QueueConnection) createConnection(); } @Override public QueueConnection createQueueConnection(String userName, String password) throws JMSException { return (QueueConnection) createConnection(userName, password); } @Override public TopicConnection createTopicConnection() throws JMSException { return (TopicConnection) createConnection(); } @Override public TopicConnection createTopicConnection(String userName, String password) throws JMSException { return (TopicConnection) createConnection(userName, password); } }