/*
*
* 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 org.apache.log4j.Logger;
import org.apache.qpid.AMQInvalidArgumentException;
import org.apache.qpid.framing.AMQTypedValue;
import org.apache.qpid.framing.FieldTable;
import org.apache.qpid.server.binding.Binding;
import org.apache.qpid.server.filter.MessageFilter;
import org.apache.qpid.server.message.AMQMessageHeader;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import org.apache.qpid.server.message.InboundMessage;
import org.apache.qpid.server.queue.Filterable;
/**
* Defines binding and matching based on a set of headers.
*/
class HeadersBinding
{
private static final Logger _logger = Logger.getLogger(HeadersBinding.class);
private final Map<String,Object> _mappings;
private final Binding _binding;
private final Set<String> required = new HashSet<String>();
private final Map<String,Object> matches = new HashMap<String,Object>();
private boolean matchAny;
private MessageFilter _filter;
/**
* Creates a header binding for a set of mappings. Those mappings whose value is
* null or the empty string are assumed only to be required headers, with
* no constraint on the value. Those with a non-null value are assumed to
* define a required match of value.
*
* @param binding the binding to create a header binding using
*/
public HeadersBinding(Binding binding)
{
_binding = binding;
if(_binding !=null)
{
_mappings = _binding.getArguments();
initMappings();
}
else
{
_mappings = null;
}
}
private void initMappings()
{
if(FilterSupport.argumentsContainFilter(_mappings))
{
try
{
_filter = FilterSupport.createMessageFilter(_mappings,_binding.getQueue());
}
catch (AMQInvalidArgumentException e)
{
_logger.warn("Invalid filter in binding queue '"+_binding.getQueue().getName()
+"' to exchange '"+_binding.getExchange().getName()
+"' with arguments: " + _binding.getArguments());
_filter = new MessageFilter()
{
@Override
public boolean matches(Filterable message)
{
return false;
}
};
}
}
for(Map.Entry<String, Object> entry : _mappings.entrySet())
{
String propertyName = entry.getKey();
Object value = entry.getValue();
if (isSpecial(propertyName))
{
processSpecial(propertyName, value);
}
else if (value == null || value.equals(""))
{
required.add(propertyName);
}
else
{
matches.put(propertyName,value);
}
}
}
public Binding getBinding()
{
return _binding;
}
/**
* Checks whether the supplied headers match the requirements of this binding
* @param headers the headers to check
* @return true if the headers define any required keys and match any required
* values
*/
public boolean matches(AMQMessageHeader headers)
{
if(headers == null)
{
return required.isEmpty() && matches.isEmpty();
}
else
{
return matchAny ? or(headers) : and(headers);
}
}
public boolean matches(InboundMessage message)
{
return matches(message.getMessageHeader()) && (_filter == null || _filter.matches(message));
}
private boolean and(AMQMessageHeader headers)
{
if(headers.containsHeaders(required))
{
for(Map.Entry<String, Object> e : matches.entrySet())
{
if(!e.getValue().equals(headers.getHeader(e.getKey())))
{
return false;
}
}
return true;
}
else
{
return false;
}
}
private boolean or(final AMQMessageHeader headers)
{
if(required.isEmpty())
{
return matches.isEmpty() || passesMatchesOr(headers);
}
else
{
if(!passesRequiredOr(headers))
{
return !matches.isEmpty() && passesMatchesOr(headers);
}
else
{
return true;
}
}
}
private boolean passesMatchesOr(AMQMessageHeader headers)
{
for(Map.Entry<String,Object> entry : matches.entrySet())
{
if(headers.containsHeader(entry.getKey())
&& ((entry.getValue() == null && headers.getHeader(entry.getKey()) == null)
|| (entry.getValue().equals(headers.getHeader(entry.getKey())))))
{
return true;
}
}
return false;
}
private boolean passesRequiredOr(AMQMessageHeader headers)
{
for(String name : required)
{
if(headers.containsHeader(name))
{
return true;
}
}
return false;
}
private void processSpecial(String key, Object value)
{
if("X-match".equalsIgnoreCase(key))
{
matchAny = isAny(value);
}
else
{
_logger.warn("Ignoring special header: " + key);
}
}
private boolean isAny(Object value)
{
if(value instanceof String)
{
if("any".equalsIgnoreCase((String) value))
{
return true;
}
if("all".equalsIgnoreCase((String) value))
{
return false;
}
}
_logger.warn("Ignoring unrecognised match type: " + value);
return false;//default to all
}
static boolean isSpecial(Object key)
{
return key instanceof String && isSpecial((String) key);
}
static boolean isSpecial(String key)
{
return key.startsWith("X-") || key.startsWith("x-");
}
@Override
public boolean equals(final Object o)
{
if (this == o)
{
return true;
}
if (o == null)
{
return false;
}
if (!(o instanceof HeadersBinding))
{
return false;
}
final HeadersBinding hb = (HeadersBinding) o;
if(_binding == null)
{
if(hb.getBinding() != null)
{
return false;
}
}
else if (!_binding.equals(hb.getBinding()))
{
return false;
}
return true;
}
}