1 package org.apache.maven.index.fs;
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.File;
23 import java.io.IOException;
24
25 /**
26 * Filesystem locker. Can be used to synchronize access to filesystem directories from different operating system
27 * processes.
28 *
29 * @author igor
30 */
31 public interface Locker
32 {
33 String LOCK_FILE = ".lock";
34
35 /**
36 * Acquires exclusive lock on specified directory. Most implementation will use marker file and will only work if
37 * all processes that require access to the directory use the same filename.
38 */
39 Lock lock( File directory )
40 throws IOException;
41 }