Coverage Report - org.apache.camel.component.file.strategy.FileProcessStrategy
 
Classes in this File Line Coverage Branch Coverage Complexity
FileProcessStrategy
N/A 
N/A 
1
 
 1  
 /**
 2  
  * Licensed to the Apache Software Foundation (ASF) under one or more
 3  
  * contributor license agreements.  See the NOTICE file distributed with
 4  
  * this work for additional information regarding copyright ownership.
 5  
  * The ASF licenses this file to You under the Apache License, Version 2.0
 6  
  * (the "License"); you may not use this file except in compliance with
 7  
  * the License.  You may obtain a copy of the License at
 8  
  *
 9  
  *      http://www.apache.org/licenses/LICENSE-2.0
 10  
  *
 11  
  * Unless required by applicable law or agreed to in writing, software
 12  
  * distributed under the License is distributed on an "AS IS" BASIS,
 13  
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 14  
  * See the License for the specific language governing permissions and
 15  
  * limitations under the License.
 16  
  */
 17  
 package org.apache.camel.component.file.strategy;
 18  
 
 19  
 import java.io.File;
 20  
 
 21  
 import org.apache.camel.component.file.FileEndpoint;
 22  
 import org.apache.camel.component.file.FileExchange;
 23  
 
 24  
 /**
 25  
  * Represents a strategy for marking that a file is processed.
 26  
  *
 27  
  * @version $Revision: 1.1 $
 28  
  */
 29  
 public interface FileProcessStrategy {
 30  
     /**
 31  
      * Called when work is about to begin on this file. This method may attempt to acquire some file lock before
 32  
      * returning true; returning false if the file lock could not be obtained so that the file should be ignored.
 33  
      *
 34  
      * @return true if the file can be processed (such as if a file lock could be obtained)
 35  
      */
 36  
     boolean begin(FileEndpoint endpoint, FileExchange exchange, File file) throws Exception;
 37  
 
 38  
     /**
 39  
      * Releases any file locks and possibly deletes or moves the file
 40  
      */
 41  
     void commit(FileEndpoint endpoint, FileExchange exchange, File file) throws Exception;
 42  
 }