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     */
017    package org.apache.servicemix.jbi.audit;
018    
019    import javax.jbi.messaging.ExchangeStatus;
020    
021    /**
022     * Main interface for ServiceMix auditor query.
023     * This interface may be used to query upon exchanges.
024     * 
025     * @author George Gastaldi (gastaldi)
026     * @since 2.1
027     * @version $Revision: 34165 $
028     */
029    public interface AuditorQueryMBean extends AuditorMBean {
030        String[] findExchangesIDsByStatus(ExchangeStatus status) throws AuditorException;
031        String[] findExchangesIDsByMessageContent(String type, String content) throws AuditorException;
032        String[] findExchangesIDsByMessageProperty(String type, String property, String value) throws AuditorException;
033    
034        /**
035         * Searches for Exchanges IDs using the supplied key-field and the expected content of the field 
036         * @param field
037         * @param fieldValue
038         * @return exchange ids
039         * @throws AuditorException if an error occurs
040         */
041        String[] getExchangeIds(String field, String fieldValue) throws AuditorException;
042    }