FileLockManager.java

package org.apache.archiva.common.filelock;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import java.io.File;
import java.io.FileNotFoundException;

/**
 * @author Olivier Lamy
 * @since 2.0.0
 */
public interface FileLockManager
{
    /**
     *
     * @param file
     * @return
     * @throws FileLockException
     * @throws FileLockTimeoutException
     */
    Lock writeFileLock( File file )
        throws FileLockException, FileLockTimeoutException;

    /**
     *
     * @param file
     * @return
     * @throws FileLockException
     * @throws FileLockTimeoutException
     */
    Lock readFileLock( File file )
        throws FileLockException, FileLockTimeoutException;

    void release( Lock lock )
        throws FileLockException, FileNotFoundException;

    void clearLockFiles();

    int getTimeout();

    void setTimeout( int timeout );

    boolean isSkipLocking();

    void setSkipLocking( boolean skipLocking);
}