001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.camel.spi;
018
019import org.apache.camel.Exchange;
020import org.apache.camel.NamedNode;
021import org.apache.camel.Processor;
022import org.apache.camel.spi.CamelEvent.ExchangeEvent;
023
024/**
025 * A condition to define when a given {@link Exchange} matches when is being routed.
026 * <p/>
027 * Is used by the {@link org.apache.camel.spi.Debugger} to apply {@link Condition}s
028 * to {@link org.apache.camel.spi.Breakpoint}s to define rules when the breakpoints should match.
029 */
030public interface Condition {
031
032    /**
033     * Does the condition match
034     *
035     * @param exchange the exchange
036     * @param processor  the {@link Processor}
037     * @param definition the present location in the route where the {@link Exchange} is located at
038     * @return <tt>true</tt> to match, <tt>false</tt> otherwise
039     */
040    boolean matchProcess(Exchange exchange, Processor processor, NamedNode definition);
041
042    /**
043     * Does the condition match
044     *
045     * @param exchange the exchange
046     * @param event    the event (instance of {@link ExchangeEvent}
047     * @return <tt>true</tt> to match, <tt>false</tt> otherwise
048     * @see ExchangeEvent
049     */
050    boolean matchEvent(Exchange exchange, ExchangeEvent event);
051
052}