net.timewalker.ffmq4.local.destination.LocalTopic Maven / Gradle / Ivy
/*
* 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.ffmq4.local.destination;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.concurrent.atomic.AtomicLong;
import java.util.concurrent.locks.ReentrantReadWriteLock;
import javax.jms.DeliveryMode;
import javax.jms.JMSException;
import javax.jms.Topic;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import net.timewalker.ffmq4.FFMQException;
import net.timewalker.ffmq4.FFMQSubscriberPolicy;
import net.timewalker.ffmq4.common.message.AbstractMessage;
import net.timewalker.ffmq4.common.message.MessageSelector;
import net.timewalker.ffmq4.common.message.selector.SelectorIndexKey;
import net.timewalker.ffmq4.local.MessageLockSet;
import net.timewalker.ffmq4.local.destination.subscription.LocalTopicSubscription;
import net.timewalker.ffmq4.local.session.LocalMessageConsumer;
import net.timewalker.ffmq4.local.session.LocalSession;
import net.timewalker.ffmq4.management.destination.definition.TopicDefinition;
import net.timewalker.ffmq4.storage.data.DataStoreFullException;
import net.timewalker.ffmq4.storage.message.MessageSerializationLevel;
import net.timewalker.ffmq4.utils.Committable;
import net.timewalker.ffmq4.utils.ErrorTools;
import net.timewalker.ffmq4.utils.concurrent.SynchronizationBarrier;
/**
* Implementation for a local JMS {@link Topic}
*/
public final class LocalTopic extends AbstractLocalDestination implements Topic, LocalTopicMBean
{
private static final Log log = LogFactory.getLog(LocalTopic.class);
// Definition
private TopicDefinition topicDef;
// Subscribers map
private Map subscriptionMap = new HashMap<>();
private List flatSubscriptions = new ArrayList<>();
private Map>> indexedSubscriptionMap = new HashMap<>();
private ReentrantReadWriteLock subscriptionsLock = new ReentrantReadWriteLock(); // Protects subscriptions, subscriptionMap & indexedSubscriptionMap
// Stats
private AtomicLong sentToTopicCount = new AtomicLong();
private AtomicLong dispatchedFromTopicCount = new AtomicLong();
// Runtime
private Set committables = new HashSet<>();
private boolean pendingChanges;
/**
* Constructor
*/
public LocalTopic( TopicDefinition topicDef )
{
super(topicDef);
this.topicDef = topicDef;
}
/**
* Get the queue definition
*/
public TopicDefinition getDefinition()
{
return topicDef;
}
/*
* (non-Javadoc)
* @see javax.jms.Topic#getTopicName()
*/
@Override
public String getTopicName()
{
return getName();
}
/* (non-Javadoc)
* @see net.timewalker.ffmq4.local.destination.AbstractLocalDestination#registerConsumer(net.timewalker.ffmq4.local.session.LocalMessageConsumer)
*/
@Override
public void registerConsumer(LocalMessageConsumer consumer)
{
super.registerConsumer(consumer);
subscriptionsLock.writeLock().lock();
try
{
LocalTopicSubscription subscription = subscriptionMap.remove(consumer.getSubscriberId());
if (subscription == null)
{
// New subscription
storeNewSubscription(consumer);
}
else
{
// Remove old subscription
removeSubscription(subscription);
// Replace by new subscription
storeNewSubscription(consumer);
}
}
finally
{
subscriptionsLock.writeLock().unlock();
}
}
private void storeNewSubscription(LocalMessageConsumer consumer)
{
LocalTopicSubscription subscription = new LocalTopicSubscription(consumer);
String[] partitionKeys = topicDef.getPartitionsKeysToIndex();
if (partitionKeys != null && subscription.getMessageSelector() != null)
{
List indexableKeys = subscription.getMessageSelector().getIndexableKeys();
SelectorIndexKey key = findBestMatch(partitionKeys, indexableKeys);
if (key != null)
{
subscription.setIndexKey(key);
addToIndexMap(subscription);
}
}
if (!subscription.isIndexed())
flatSubscriptions.add(subscription);
subscriptionMap.put(consumer.getSubscriberId(),subscription);
}
private void addToIndexMap( LocalTopicSubscription subscription )
{
SelectorIndexKey key = subscription.getIndexKey();
Map> subscriptionsByValueMap = indexedSubscriptionMap.get(key.getHeaderName());
if (subscriptionsByValueMap == null)
{
subscriptionsByValueMap = new HashMap<>();
indexedSubscriptionMap.put(key.getHeaderName(),subscriptionsByValueMap);
}
Object[] values = key.getValues();
for(Object value : values)
{
List subscriptions = subscriptionsByValueMap.get(value);
if (subscriptions == null)
{
subscriptions = new ArrayList<>(4);
subscriptionsByValueMap.put(value,subscriptions);
}
subscriptions.add(subscription);
}
}
private boolean removeFromIndexMap( LocalTopicSubscription subscription )
{
SelectorIndexKey key = subscription.getIndexKey();
if (key == null)
return true;
Map> subscriptionsByValueMap = indexedSubscriptionMap.get(key.getHeaderName());
if (subscriptionsByValueMap == null)
return false;
Object[] values = key.getValues();
int found = 0;
for(Object value : values)
{
List subscriptions = subscriptionsByValueMap.get(value);
if (subscriptions == null)
continue;
if (!subscriptions.remove(subscription))
continue;
found++;
// Auto-cleanup
if (subscriptions.isEmpty())
{
subscriptionsByValueMap.remove(value);
if (subscriptionsByValueMap.isEmpty())
indexedSubscriptionMap.remove(key.getHeaderName());
}
}
return found == values.length;
}
private SelectorIndexKey findBestMatch( String[] partitionKeys , List indexableKeys )
{
for(String partitionKey : partitionKeys)
for(SelectorIndexKey indexableKey : indexableKeys)
if (indexableKey.getHeaderName().equals(partitionKey))
return indexableKey;
return null; // No match ...
}
/* (non-Javadoc)
* @see net.timewalker.ffmq4.local.destination.AbstractLocalDestination#unregisterConsumer(net.timewalker.ffmq4.local.session.LocalMessageConsumer)
*/
@Override
public void unregisterConsumer(LocalMessageConsumer consumer)
{
super.unregisterConsumer(consumer);
if (!consumer.isDurable())
{
log.debug("Removing non-durable subscription "+consumer.getSubscriberId());
subscriptionsLock.writeLock().lock();
try
{
LocalTopicSubscription subscription = subscriptionMap.remove(consumer.getSubscriberId());
if (subscription != null)
removeSubscription(subscription);
}
finally
{
subscriptionsLock.writeLock().unlock();
}
}
}
/**
* Unsubscribe all durable consumers for a given client ID and subscription name
*/
public void unsubscribe( String clientID , String subscriptionName ) throws JMSException
{
String subscriberID = clientID+"-"+subscriptionName;
subscriptionsLock.writeLock().lock();
try
{
LocalTopicSubscription subscription = subscriptionMap.get(subscriberID);
if (subscription == null)
return;
if (isConsumerRegistered(subscriberID))
throw new FFMQException("Subscription "+subscriptionName+" is still in use","SUBSCRIPTION_STILL_IN_USE");
subscriptionMap.remove(subscriberID);
removeSubscription(subscription);
}
finally
{
subscriptionsLock.writeLock().unlock();
}
}
private void removeSubscription( LocalTopicSubscription subscription )
{
if (subscription.isIndexed())
{
if (!removeFromIndexMap(subscription))
throw new IllegalStateException("Cannot find subscription in index map : "+subscription);
}
else
{
if (!flatSubscriptions.remove(subscription))
throw new IllegalStateException("Cannot find subscription in non-indexed list : "+subscription);
}
}
/*
* (non-Javadoc)
* @see net.timewalker.ffmq4.local.destination.AbstractLocalDestination#putLocked(net.timewalker.ffmq4.common.message.AbstractMessage, net.timewalker.ffmq4.local.session.LocalSession, net.timewalker.ffmq4.local.MessageLockSet)
*/
@Override
public boolean putLocked( AbstractMessage srcMessage, LocalSession session , MessageLockSet locks ) throws JMSException
{
checkNotClosed();
checkTransactionLock();
// Check delivery mode
if (!topicDef.supportDeliveryMode(srcMessage.getJMSDeliveryMode()))
throw new FFMQException("Topic does not support this delivery mode : "+
(srcMessage.getJMSDeliveryMode() == DeliveryMode.NON_PERSISTENT ?
"DeliveryMode.NON_PERSISTENT" : "DeliveryMode.PERSISTENT"),
"INVALID_DELIVERY_MODE");
sentToTopicCount.incrementAndGet();
boolean commitRequired = false;
subscriptionsLock.readLock().lock();
try
{
// Pass 1 - Indexed subscriptions
if (!indexedSubscriptionMap.isEmpty())
{
srcMessage.ensureDeserializationLevel(MessageSerializationLevel.ALL_HEADERS);
for(Entry>> entry : indexedSubscriptionMap.entrySet())
{
String headerName = entry.getKey();
Object value;
if (headerName.equals("JMSCorrelationID")) // Intercept special headers
value = srcMessage.getJMSCorrelationID();
else
value = srcMessage.getObjectProperty(headerName);
if (value != null)
{
value = normalizeLiteralValue(value);
List subscriptions = entry.getValue().get(value);
if (subscriptions != null)
{
if (pushToSubscriptions(srcMessage, session, locks, subscriptions))
commitRequired = true;
}
}
}
}
// Pass 2 - Non indexed subscriptions
if (!flatSubscriptions.isEmpty())
if (pushToSubscriptions(srcMessage, session, locks, flatSubscriptions))
commitRequired = true;
}
finally
{
subscriptionsLock.readLock().unlock();
}
return commitRequired;
}
private Object normalizeLiteralValue( Object value )
{
if (value instanceof Number)
{
if (value instanceof Long) return value; // No change
if (value instanceof Double) return value; // No change
if (value instanceof Byte ||
value instanceof Short ||
value instanceof Integer)
return Long.valueOf(((Number)value).longValue());
if (value instanceof Float) return Double.valueOf(((Number)value).doubleValue());
}
return value; // No change
}
private boolean pushToSubscriptions( AbstractMessage srcMessage , LocalSession session , MessageLockSet locks , List subscriptions ) throws JMSException
{
String connectionID = session.getConnection().getId();
boolean commitRequired = false;
for (int i = 0; i < subscriptions.size(); i++)
{
LocalTopicSubscription subscription = subscriptions.get(i);
// No-local filtering
if (subscription.getNoLocal() && subscription.getConnectionID().equals(connectionID))
continue;
try
{
// Message selector filtering
MessageSelector selector = subscription.getMessageSelector();
if (selector != null)
{
srcMessage.ensureDeserializationLevel(MessageSerializationLevel.ALL_HEADERS);
if (!selector.matches(srcMessage))
continue;
}
LocalQueue subscriberQueue = subscription.getLocalQueue();
// Only use transactional mode for fail-safe durable subscriptions
if (subscriberQueue.requiresTransactionalUpdate() && subscription.isDurable())
{
if (committables.add(subscriberQueue))
subscriberQueue.openTransaction();
if (!subscriberQueue.putLocked(srcMessage, session, locks))
if (srcMessage.getJMSDeliveryMode() == DeliveryMode.PERSISTENT)
throw new IllegalStateException("Should require a commit");
pendingChanges = true;
commitRequired = true;
}
else
{
if (subscriberQueue.putLocked(srcMessage, session, locks))
throw new IllegalStateException("Should not require a commit");
}
dispatchedFromTopicCount.incrementAndGet();
}
catch (DataStoreFullException e)
{
processPutError(subscription.getSubscriberId(), e, getDefinition().getSubscriberOverflowPolicy());
}
catch (JMSException e)
{
processPutError(subscription.getSubscriberId(), e, getDefinition().getSubscriberFailurePolicy());
}
}
return commitRequired;
}
private void processPutError( String subscriberId , JMSException e , int policy ) throws JMSException
{
if ((policy & FFMQSubscriberPolicy.SUBSCRIBER_POLICY_LOG) > 0)
ErrorTools.log("subscriber="+subscriberId, e, log);
if ((policy & FFMQSubscriberPolicy.SUBSCRIBER_POLICY_REPORT_TO_PRODUCER) > 0)
throw e;
}
/*
* (non-Javadoc)
* @see net.timewalker.ffmq4.local.destination.LocalDestinationMBean#getSize()
*/
@Override
public int getSize()
{
int size = 0;
subscriptionsLock.readLock().lock();
try
{
for(LocalTopicSubscription subscription : subscriptionMap.values())
{
size += subscription.getLocalQueue().getSize();
}
}
finally
{
subscriptionsLock.readLock().unlock();
}
return size;
}
/*
* (non-Javadoc)
* @see net.timewalker.ffmq4.local.destination.LocalDestinationMBean#resetStats()
*/
@Override
public void resetStats()
{
super.resetStats();
sentToTopicCount.set(0);
dispatchedFromTopicCount.set(0);
}
/*
* (non-Javadoc)
* @see net.timewalker.ffmq4.local.destination.LocalTopicMBean#getSentToTopicCount()
*/
@Override
public long getSentToTopicCount()
{
return sentToTopicCount.get();
}
/*
* (non-Javadoc)
* @see net.timewalker.ffmq4.local.destination.LocalTopicMBean#getDispatchedFromTopicCount()
*/
@Override
public long getDispatchedFromTopicCount()
{
return dispatchedFromTopicCount.get();
}
/*
* (non-Javadoc)
* @see net.timewalker.ffmq4.local.destination.LocalTopicMBean#getSubscriptionsCount()
*/
@Override
public int getSubscriptionsCount()
{
return subscriptionMap.size();
}
/* (non-Javadoc)
* @see net.timewalker.ffmq4.local.destination.LocalTopicMBean#getIndexedSubscriptionsCount()
*/
@Override
public int getIndexedSubscriptionsCount()
{
return indexedSubscriptionMap.size();
}
/*
* (non-Javadoc)
* @see java.lang.Object#toString()
*/
@Override
public String toString()
{
StringBuilder sb = new StringBuilder();
sb.append("Topic{");
sb.append(getName());
sb.append("}[size=");
sb.append(getSize());
sb.append(",consumers=");
sb.append(localConsumers.size());
sb.append(",in=");
sb.append(sentToTopicCount);
sb.append(",out=");
sb.append(dispatchedFromTopicCount);
sb.append("]");
return sb.toString();
}
public String getConsumersSummary()
{
StringBuilder sb = new StringBuilder();
subscriptionsLock.readLock().lock();
try
{
int pos = 0;
for(LocalTopicSubscription subscription : subscriptionMap.values())
{
if (pos++>0)
sb.append("\n");
sb.append(subscription);
}
}
finally
{
subscriptionsLock.readLock().unlock();
}
return sb.toString();
}
/* (non-Javadoc)
* @see net.timewalker.ffmq4.local.destination.AbstractLocalDestination#hasTransactionSupport()
*/
@Override
protected boolean requiresTransactionalUpdate()
{
return topicDef.hasPersistentStore();
}
/* (non-Javadoc)
* @see net.timewalker.ffmq4.local.destination.AbstractLocalDestination#hasPendingChanges()
*/
@Override
protected boolean hasPendingChanges()
{
return pendingChanges;
}
/*
* (non-Javadoc)
* @see net.timewalker.ffmq4.local.destination.AbstractLocalDestination#close()
*/
@Override
public final void close() throws JMSException
{
synchronized (closeLock)
{
if (closed)
return;
closed = true;
}
}
/* (non-Javadoc)
* @see net.timewalker.ffmq4.utils.Committable#commitChanges(net.timewalker.ffmq4.utils.concurrent.SynchronizationBarrier)
*/
@Override
public void commitChanges(SynchronizationBarrier barrier) throws JMSException
{
checkNotClosed();
checkTransactionLock();
if (!committables.isEmpty())
{
long start = System.currentTimeMillis();
Iterator allCommitables = committables.iterator();
while (allCommitables.hasNext())
{
Committable committable = allCommitables.next();
committable.commitChanges(barrier);
}
long end = System.currentTimeMillis();
notifyCommitTime(end-start);
pendingChanges = false;
}
}
/* (non-Javadoc)
* @see net.timewalker.ffmq4.local.destination.AbstractLocalDestination#closeTransaction()
*/
@Override
public void closeTransaction()
{
// Unlock subscriptions queues first
if (!committables.isEmpty())
{
Iterator allCommitables = committables.iterator();
while (allCommitables.hasNext())
{
Committable committable = allCommitables.next();
committable.closeTransaction();
}
committables.clear();
}
super.closeTransaction();
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy