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.camel.component.file.strategy;
018    
019    import java.io.File;
020    
021    import org.apache.camel.component.file.FileEndpoint;
022    import org.apache.camel.component.file.FileExchange;
023    
024    /**
025     * Represents a strategy for marking that a file is processed.
026     *
027     * @version $Revision: 1.1 $
028     */
029    public interface FileProcessStrategy {
030        /**
031         * Called when work is about to begin on this file. This method may attempt to acquire some file lock before
032         * returning true; returning false if the file lock could not be obtained so that the file should be ignored.
033         *
034         * @return true if the file can be processed (such as if a file lock could be obtained)
035         */
036        boolean begin(FileEndpoint endpoint, FileExchange exchange, File file) throws Exception;
037    
038        /**
039         * Releases any file locks and possibly deletes or moves the file
040         */
041        void commit(FileEndpoint endpoint, FileExchange exchange, File file) throws Exception;
042    }