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;
018
019 import java.io.File;
020
021 /**
022 * Represents a strategy for marking that a file is processed.
023 *
024 * @version $Revision: 686094 $
025 */
026 public interface FileProcessStrategy {
027
028 /**
029 * Called when work is about to begin on this file. This method may attempt to acquire some file lock before
030 * returning true; returning false if the file lock could not be obtained so that the file should be ignored.
031 *
032 * @param endpoint the endpoint
033 * @param exchange the exchange
034 * @param file the file
035 * @return true if the file can be processed (such as if a file lock could be obtained)
036 * @throws Exception can be thrown in case of errors
037 */
038 boolean begin(FileEndpoint endpoint, FileExchange exchange, File file) throws Exception;
039
040 /**
041 * Releases any file locks and possibly deletes or moves the file after successful processing
042 *
043 * @param endpoint the endpoint
044 * @param exchange the exchange
045 * @param file the file
046 * @throws Exception can be thrown in case of errors
047 */
048 void commit(FileEndpoint endpoint, FileExchange exchange, File file) throws Exception;
049
050 /**
051 * Releases any file locks and possibly deletes or moves the file after unsuccessful processing
052 *
053 * @param endpoint the endpoint
054 * @param exchange the exchange
055 * @param file the file
056 */
057 void rollback(FileEndpoint endpoint, FileExchange exchange, File file);
058
059 }