Source code

001package org.apache.archiva.common.filelock;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *  http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import java.io.FileNotFoundException;
023import java.nio.file.Path;
024
025/**
026 * @author Olivier Lamy
027 * @since 2.0.0
028 */
029public interface FileLockManager
030{
031    /**
032     *
033     * @param file
034     * @return
035     * @throws FileLockException
036     * @throws FileLockTimeoutException
037     */
038    Lock writeFileLock( Path file )
039        throws FileLockException, FileLockTimeoutException;
040
041    /**
042     *
043     * @param file
044     * @return
045     * @throws FileLockException
046     * @throws FileLockTimeoutException
047     */
048    Lock readFileLock( Path file )
049        throws FileLockException, FileLockTimeoutException;
050
051    void release( Lock lock )
052        throws FileLockException, FileNotFoundException;
053
054    void clearLockFiles();
055
056    int getTimeout();
057
058    void setTimeout( int timeout );
059
060    boolean isSkipLocking();
061
062    void setSkipLocking( boolean skipLocking);
063}