1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.index.fs;
20
21 import java.io.File;
22 import java.io.IOException;
23
24 /**
25 * Filesystem locker. Can be used to synchronize access to filesystem directories from different operating system
26 * processes.
27 *
28 * @author igor
29 */
30 public interface Locker {
31 String LOCK_FILE = ".lock";
32
33 /**
34 * Acquires exclusive lock on specified directory. Most implementation will use marker file and will only work if
35 * all processes that require access to the directory use the same filename.
36 */
37 Lock lock(File directory) throws IOException;
38 }