This project has retired. For details please refer to its Attic page.
FileLockManager xref
View Javadoc
1   package org.apache.archiva.common.filelock;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.io.FileNotFoundException;
23  import java.nio.file.Path;
24  
25  /**
26   * @author Olivier Lamy
27   * @since 2.0.0
28   */
29  public interface FileLockManager
30  {
31      /**
32       *
33       * @param file
34       * @return
35       * @throws FileLockException
36       * @throws FileLockTimeoutException
37       */
38      Lock writeFileLock( Path file )
39          throws FileLockException, FileLockTimeoutException;
40  
41      /**
42       *
43       * @param file
44       * @return
45       * @throws FileLockException
46       * @throws FileLockTimeoutException
47       */
48      Lock readFileLock( Path file )
49          throws FileLockException, FileLockTimeoutException;
50  
51      void release( Lock lock )
52          throws FileLockException, FileNotFoundException;
53  
54      void clearLockFiles();
55  
56      int getTimeout();
57  
58      void setTimeout( int timeout );
59  
60      boolean isSkipLocking();
61  
62      void setSkipLocking( boolean skipLocking);
63  }