/*
*
* 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.server.exchange;
import java.security.AccessControlException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.UUID;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicLong;
import org.apache.log4j.Logger;
import org.apache.qpid.exchange.ExchangeDefaults;
import org.apache.qpid.server.binding.BindingImpl;
import org.apache.qpid.server.logging.EventLogger;
import org.apache.qpid.server.logging.LogSubject;
import org.apache.qpid.server.logging.messages.ExchangeMessages;
import org.apache.qpid.server.logging.subjects.ExchangeLogSubject;
import org.apache.qpid.server.message.InstanceProperties;
import org.apache.qpid.server.message.MessageInstance;
import org.apache.qpid.server.message.MessageReference;
import org.apache.qpid.server.message.ServerMessage;
import org.apache.qpid.server.model.AbstractConfiguredObject;
import org.apache.qpid.server.model.Binding;
import org.apache.qpid.server.model.ConfiguredObject;
import org.apache.qpid.server.model.Exchange;
import org.apache.qpid.server.model.LifetimePolicy;
import org.apache.qpid.server.model.ManagedAttributeField;
import org.apache.qpid.server.model.Publisher;
import org.apache.qpid.server.model.Queue;
import org.apache.qpid.server.model.State;
import org.apache.qpid.server.model.StateTransition;
import org.apache.qpid.server.queue.AMQQueue;
import org.apache.qpid.server.queue.BaseQueue;
import org.apache.qpid.server.store.StorableMessageMetaData;
import org.apache.qpid.server.txn.ServerTransaction;
import org.apache.qpid.server.util.Action;
import org.apache.qpid.server.util.StateChangeListener;
import org.apache.qpid.server.virtualhost.ExchangeIsAlternateException;
import org.apache.qpid.server.virtualhost.RequiredExchangeException;
import org.apache.qpid.server.virtualhost.ReservedExchangeNameException;
import org.apache.qpid.server.virtualhost.VirtualHostImpl;
public abstract class AbstractExchange<T extends AbstractExchange<T>>
extends AbstractConfiguredObject<T>
implements ExchangeImpl<T>
{
private static final Logger _logger = Logger.getLogger(AbstractExchange.class);
private final AtomicBoolean _closed = new AtomicBoolean();
@ManagedAttributeField(beforeSet = "preSetAlternateExchange", afterSet = "postSetAlternateExchange" )
private Exchange<?> _alternateExchange;
private VirtualHostImpl _virtualHost;
private final List<Action<ExchangeImpl>> _closeTaskList = new CopyOnWriteArrayList<Action<ExchangeImpl>>();
/**
* Whether the exchange is automatically deleted once all queues have detached from it
*/
private boolean _autoDelete;
//The logSubject for ths exchange
private LogSubject _logSubject;
private Map<ExchangeReferrer,Object> _referrers = new ConcurrentHashMap<ExchangeReferrer,Object>();
private final CopyOnWriteArrayList<BindingImpl> _bindings = new CopyOnWriteArrayList<BindingImpl>();
private final AtomicInteger _bindingCountHigh = new AtomicInteger();
private final AtomicLong _receivedMessageCount = new AtomicLong();
private final AtomicLong _receivedMessageSize = new AtomicLong();
private final AtomicLong _routedMessageCount = new AtomicLong();
private final AtomicLong _routedMessageSize = new AtomicLong();
private final AtomicLong _droppedMessageCount = new AtomicLong();
private final AtomicLong _droppedMessageSize = new AtomicLong();
private final CopyOnWriteArrayList<ExchangeImpl.BindingListener> _listeners = new CopyOnWriteArrayList<ExchangeImpl.BindingListener>();
private final ConcurrentMap<BindingIdentifier, BindingImpl> _bindingsMap = new ConcurrentHashMap<BindingIdentifier, BindingImpl>();
private StateChangeListener<BindingImpl, State> _bindingListener;
private State _state = State.UNINITIALIZED;
public AbstractExchange(Map<String, Object> attributes, VirtualHostImpl vhost)
{
super(parentsMap(vhost), attributes);
Set<String> providedAttributeNames = new HashSet<>(attributes.keySet());
providedAttributeNames.removeAll(getAttributeNames());
if(!providedAttributeNames.isEmpty())
{
throw new IllegalArgumentException("Unknown attributes provided: " + providedAttributeNames);
}
_virtualHost = vhost;
// check ACL
try
{
_virtualHost.getSecurityManager().authoriseCreateExchange(this);
}
catch (AccessControlException e)
{
deleted();
throw e;
}
_logSubject = new ExchangeLogSubject(this, this.getVirtualHost());
_bindingListener = new StateChangeListener<BindingImpl, State>()
{
@Override
public void stateChanged(final BindingImpl binding, final State oldState, final State newState)
{
if(newState == State.DELETED)
{
removeBinding(binding);
}
}
};
}
@Override
public void onValidate()
{
super.onValidate();
if(!_virtualHost.getSecurityManager().isSystemProcess())
{
if (isReservedExchangeName(getName()))
{
deleted();
throw new ReservedExchangeNameException(getName());
}
}
}
private boolean isReservedExchangeName(String name)
{
if (name == null || ExchangeDefaults.DEFAULT_EXCHANGE_NAME.equals(name)
|| name.startsWith("amq.") || name.startsWith("qpid."))
{
return true;
}
return false;
}
@Override
protected void onOpen()
{
super.onOpen();
// Log Exchange creation
getEventLogger().message(ExchangeMessages.CREATED(getType(), getName(), isDurable()));
}
@Override
protected void onCreate()
{
super.onCreate();
if(isDurable())
{
getVirtualHost().getDurableConfigurationStore().create(asObjectRecord());
}
}
@Override
public EventLogger getEventLogger()
{
return _virtualHost.getEventLogger();
}
public boolean isAutoDelete()
{
return getLifetimePolicy() != LifetimePolicy.PERMANENT;
}
@Override
public void deleteWithChecks()
{
_virtualHost.getSecurityManager().authoriseDelete(this);
if(hasReferrers())
{
throw new ExchangeIsAlternateException(getName());
}
if(isReservedExchangeName(getName()))
{
throw new RequiredExchangeException(getName());
}
if (isDurable() && !isAutoDelete())
{
getVirtualHost().getDurableConfigurationStore().remove(asObjectRecord());
}
if(_closed.compareAndSet(false,true))
{
List<BindingImpl> bindings = new ArrayList<BindingImpl>(_bindings);
for(BindingImpl binding : bindings)
{
binding.removeStateChangeListener(_bindingListener);
removeBinding(binding);
}
if(_alternateExchange != null)
{
((ExchangeImpl)_alternateExchange).removeReference(this);
}
getEventLogger().message(_logSubject, ExchangeMessages.DELETED());
for(Action<ExchangeImpl> task : _closeTaskList)
{
task.performAction(this);
}
_closeTaskList.clear();
if (isDurable() && !isAutoDelete())
{
getVirtualHost().getDurableConfigurationStore().remove(asObjectRecord());
}
}
deleted();
}
public String toString()
{
return getClass().getSimpleName() + "[" + getName() +"]";
}
public VirtualHostImpl getVirtualHost()
{
return _virtualHost;
}
public final boolean isBound(String bindingKey, Map<String,Object> arguments, AMQQueue queue)
{
for(BindingImpl b : _bindings)
{
if(bindingKey.equals(b.getBindingKey()) && queue == b.getAMQQueue())
{
return (b.getArguments() == null || b.getArguments().isEmpty())
? (arguments == null || arguments.isEmpty())
: b.getArguments().equals(arguments);
}
}
return false;
}
public final boolean isBound(String bindingKey, AMQQueue queue)
{
for(BindingImpl b : _bindings)
{
if(bindingKey.equals(b.getBindingKey()) && queue == b.getAMQQueue())
{
return true;
}
}
return false;
}
public final boolean isBound(String bindingKey)
{
for(BindingImpl b : _bindings)
{
if(bindingKey.equals(b.getBindingKey()))
{
return true;
}
}
return false;
}
public final boolean isBound(AMQQueue queue)
{
for(BindingImpl b : _bindings)
{
if(queue == b.getAMQQueue())
{
return true;
}
}
return false;
}
@Override
public final boolean isBound(Map<String, Object> arguments, AMQQueue queue)
{
for(BindingImpl b : _bindings)
{
if(queue == b.getAMQQueue() &&
((b.getArguments() == null || b.getArguments().isEmpty())
? (arguments == null || arguments.isEmpty())
: b.getArguments().equals(arguments)))
{
return true;
}
}
return false;
}
public final boolean isBound(Map<String, Object> arguments)
{
for(BindingImpl b : _bindings)
{
if(((b.getArguments() == null || b.getArguments().isEmpty())
? (arguments == null || arguments.isEmpty())
: b.getArguments().equals(arguments)))
{
return true;
}
}
return false;
}
@Override
public final boolean isBound(String bindingKey, Map<String, Object> arguments)
{
for(BindingImpl b : _bindings)
{
if(b.getBindingKey().equals(bindingKey) &&
((b.getArguments() == null || b.getArguments().isEmpty())
? (arguments == null || arguments.isEmpty())
: b.getArguments().equals(arguments)))
{
return true;
}
}
return false;
}
public final boolean hasBindings()
{
return !_bindings.isEmpty();
}
public Exchange<?> getAlternateExchange()
{
return _alternateExchange;
}
private void preSetAlternateExchange()
{
if (_alternateExchange != null)
{
((ExchangeImpl) _alternateExchange).removeReference(this);
}
}
private void postSetAlternateExchange()
{
if(_alternateExchange != null)
{
((ExchangeImpl)_alternateExchange).addReference(this);
}
}
public void removeReference(ExchangeReferrer exchange)
{
_referrers.remove(exchange);
}
public void addReference(ExchangeReferrer exchange)
{
_referrers.put(exchange, Boolean.TRUE);
}
public boolean hasReferrers()
{
return !_referrers.isEmpty();
}
public void addCloseTask(final Action<ExchangeImpl> task)
{
_closeTaskList.add(task);
}
public void removeCloseTask(final Action<ExchangeImpl> task)
{
_closeTaskList.remove(task);
}
public final void doAddBinding(final BindingImpl binding)
{
_bindings.add(binding);
int bindingCountSize = _bindings.size();
int maxBindingsSize;
while((maxBindingsSize = _bindingCountHigh.get()) < bindingCountSize)
{
_bindingCountHigh.compareAndSet(maxBindingsSize, bindingCountSize);
}
for(BindingListener listener : _listeners)
{
listener.bindingAdded(this, binding);
}
onBind(binding);
}
public long getBindingCountHigh()
{
return _bindingCountHigh.get();
}
public final void doRemoveBinding(final BindingImpl binding)
{
onUnbind(binding);
for(BindingListener listener : _listeners)
{
listener.bindingRemoved(this, binding);
}
_bindings.remove(binding);
}
public final Collection<BindingImpl> getBindings()
{
return Collections.unmodifiableList(_bindings);
}
protected abstract void onBind(final BindingImpl binding);
protected abstract void onUnbind(final BindingImpl binding);
public Map<String, Object> getArguments()
{
return Collections.emptyMap();
}
public long getBindingCount()
{
return getBindings().size();
}
final List<? extends BaseQueue> route(final ServerMessage message,
final String routingAddress,
final InstanceProperties instanceProperties)
{
_receivedMessageCount.incrementAndGet();
_receivedMessageSize.addAndGet(message.getSize());
List<? extends BaseQueue> queues = doRoute(message, routingAddress, instanceProperties);
List<? extends BaseQueue> allQueues = queues;
boolean deletedQueues = false;
for(BaseQueue q : allQueues)
{
if(q.isDeleted())
{
if(!deletedQueues)
{
deletedQueues = true;
queues = new ArrayList<BaseQueue>(allQueues);
}
if(_logger.isDebugEnabled())
{
_logger.debug("Exchange: " + getName() + " - attempt to enqueue message onto deleted queue " + q.getName());
}
queues.remove(q);
}
}
if(!queues.isEmpty())
{
_routedMessageCount.incrementAndGet();
_routedMessageSize.addAndGet(message.getSize());
}
else
{
_droppedMessageCount.incrementAndGet();
_droppedMessageSize.addAndGet(message.getSize());
}
return queues;
}
public final <M extends ServerMessage<? extends StorableMessageMetaData>> int send(final M message,
final String routingAddress,
final InstanceProperties instanceProperties,
final ServerTransaction txn,
final Action<? super MessageInstance> postEnqueueAction)
{
List<? extends BaseQueue> queues = route(message, routingAddress, instanceProperties);
if(queues == null || queues.isEmpty())
{
Exchange altExchange = getAlternateExchange();
if(altExchange != null)
{
return altExchange.send(message, routingAddress, instanceProperties, txn, postEnqueueAction);
}
else
{
return 0;
}
}
else
{
final BaseQueue[] baseQueues;
if(message.isReferenced())
{
ArrayList<BaseQueue> uniqueQueues = new ArrayList<>(queues.size());
for(BaseQueue q : queues)
{
if(!message.isReferenced(q))
{
uniqueQueues.add(q);
}
}
baseQueues = uniqueQueues.toArray(new BaseQueue[uniqueQueues.size()]);
}
else
{
baseQueues = queues.toArray(new BaseQueue[queues.size()]);
}
txn.enqueue(queues,message, new ServerTransaction.Action()
{
MessageReference _reference = message.newReference();
public void postCommit()
{
try
{
for(int i = 0; i < baseQueues.length; i++)
{
baseQueues[i].enqueue(message, postEnqueueAction);
}
}
finally
{
_reference.release();
}
}
public void onRollback()
{
_reference.release();
}
});
return queues.size();
}
}
protected abstract List<? extends BaseQueue> doRoute(final ServerMessage message,
final String routingAddress,
final InstanceProperties instanceProperties);
@Override
public long getMessagesIn()
{
return _receivedMessageCount.get();
}
public long getMsgRoutes()
{
return _routedMessageCount.get();
}
@Override
public long getMessagesDropped()
{
return _droppedMessageCount.get();
}
@Override
public long getBytesIn()
{
return _receivedMessageSize.get();
}
public long getByteRoutes()
{
return _routedMessageSize.get();
}
@Override
public long getBytesDropped()
{
return _droppedMessageSize.get();
}
public void addBindingListener(final BindingListener listener)
{
_listeners.add(listener);
}
public void removeBindingListener(final BindingListener listener)
{
_listeners.remove(listener);
}
@Override
public boolean addBinding(String bindingKey, AMQQueue queue, Map<String, Object> arguments)
{
return makeBinding(null, bindingKey, queue, arguments, false);
}
@Override
public boolean replaceBinding(final String bindingKey,
final AMQQueue queue,
final Map<String, Object> arguments)
{
final BindingImpl existingBinding = getBinding(bindingKey, queue);
return makeBinding(existingBinding == null ? null : existingBinding.getId(),
bindingKey,
queue,
arguments,
true);
}
private void removeBinding(final BindingImpl binding)
{
String bindingKey = binding.getBindingKey();
AMQQueue queue = binding.getAMQQueue();
assert queue != null;
if (bindingKey == null)
{
bindingKey = "";
}
// Check access
_virtualHost.getSecurityManager().authoriseUnbind(binding);
BindingImpl b = _bindingsMap.remove(new BindingIdentifier(bindingKey,queue));
if (b != null)
{
doRemoveBinding(b);
queue.removeBinding(b);
if (b.isDurable())
{
_virtualHost.getDurableConfigurationStore().remove(b.asObjectRecord());
}
b.delete();
}
}
public BindingImpl getBinding(String bindingKey, AMQQueue queue)
{
assert queue != null;
if(bindingKey == null)
{
bindingKey = "";
}
return _bindingsMap.get(new BindingIdentifier(bindingKey,queue));
}
private boolean makeBinding(UUID id,
String bindingKey,
AMQQueue queue,
Map<String, Object> arguments,
boolean force)
{
if (bindingKey == null)
{
bindingKey = "";
}
if (arguments == null)
{
arguments = Collections.emptyMap();
}
if (id == null)
{
id = UUID.randomUUID();
}
BindingImpl existingMapping;
synchronized(this)
{
BindingIdentifier bindingIdentifier = new BindingIdentifier(bindingKey, queue);
existingMapping = _bindingsMap.get(bindingIdentifier);
if (existingMapping == null)
{
Map<String,Object> attributes = new HashMap<String, Object>();
attributes.put(Binding.NAME,bindingKey);
attributes.put(Binding.ID, id);
attributes.put(Binding.ARGUMENTS, arguments);
BindingImpl b = new BindingImpl(attributes, queue, this);
b.create(); // Must be called before addBinding as it resolves automated attributes.
addBinding(b);
return true;
}
else if(force)
{
Map<String,Object> oldArguments = existingMapping.getArguments();
existingMapping.setArguments(arguments);
onBindingUpdated(existingMapping, oldArguments);
return true;
}
else
{
return false;
}
}
}
@Override
public void addBinding(final BindingImpl b)
{
b.addStateChangeListener(_bindingListener);
BindingIdentifier identifier = new BindingIdentifier(b.getName(), b.getAMQQueue());
_bindingsMap.put(identifier, b);
b.getAMQQueue().addBinding(b);
childAdded(b);
}
protected abstract void onBindingUpdated(final BindingImpl binding,
final Map<String, Object> oldArguments);
@StateTransition(currentState = State.UNINITIALIZED, desiredState = State.ACTIVE)
private void activate()
{
_state = State.ACTIVE;
}
@StateTransition(currentState = State.UNINITIALIZED, desiredState = State.DELETED)
private void doDeleteBeforeInitialize()
{
preSetAlternateExchange();
_state = State.DELETED;
}
@StateTransition(currentState = State.ACTIVE, desiredState = State.DELETED)
private void doDelete()
{
try
{
_virtualHost.removeExchange(this,true);
preSetAlternateExchange();
_state = State.DELETED;
}
catch (ExchangeIsAlternateException | RequiredExchangeException e)
{
return;
}
}
@Override
public State getState()
{
return _state;
}
@Override
public <C extends ConfiguredObject> Collection<C> getChildren(final Class<C> clazz)
{
if(org.apache.qpid.server.model.Binding.class.isAssignableFrom(clazz))
{
return (Collection<C>) getBindings();
}
else
{
return Collections.EMPTY_SET;
}
}
private static final class BindingIdentifier
{
private final String _bindingKey;
private final AMQQueue _destination;
private BindingIdentifier(final String bindingKey, final AMQQueue destination)
{
_bindingKey = bindingKey;
_destination = destination;
}
public String getBindingKey()
{
return _bindingKey;
}
public AMQQueue getDestination()
{
return _destination;
}
@Override
public boolean equals(final Object o)
{
if (this == o)
{
return true;
}
if (o == null || getClass() != o.getClass())
{
return false;
}
final BindingIdentifier that = (BindingIdentifier) o;
if (!_bindingKey.equals(that._bindingKey))
{
return false;
}
if (!_destination.equals(that._destination))
{
return false;
}
return true;
}
@Override
public int hashCode()
{
int result = _bindingKey.hashCode();
result = 31 * result + _destination.hashCode();
return result;
}
}
@Override
public Collection<Publisher> getPublishers()
{
return Collections.emptySet();
}
@Override
public boolean deleteBinding(final String bindingKey, final AMQQueue queue)
{
final BindingImpl binding = getBinding(bindingKey, queue);
if(binding == null)
{
return false;
}
else
{
binding.delete();
return true;
}
}
@Override
public boolean hasBinding(final String bindingKey, final AMQQueue queue)
{
return getBinding(bindingKey,queue) != null;
}
@Override
public org.apache.qpid.server.model.Binding createBinding(final String bindingKey,
final Queue queue,
final Map<String, Object> bindingArguments,
final Map<String, Object> attributes)
{
addBinding(bindingKey, (AMQQueue) queue, bindingArguments);
final BindingImpl binding = getBinding(bindingKey, (AMQQueue) queue);
return binding;
}
@Override
public Object getAttribute(final String name)
{
if(ConfiguredObject.STATE.equals(name))
{
return getState();
}
return super.getAttribute(name);
}
@Override
protected void authoriseSetAttributes(ConfiguredObject<?> modified, Set<String> attributes) throws AccessControlException
{
_virtualHost.getSecurityManager().authoriseUpdate(this);
}
@Override
protected void changeAttributes(final Map<String, Object> attributes)
{
super.changeAttributes(attributes);
if (isDurable() && getState() != State.DELETED)
{
this.getVirtualHost().getDurableConfigurationStore().update(false, asObjectRecord());
}
}
}