001/*
002 * Licensed to DuraSpace under one or more contributor license agreements.
003 * See the NOTICE file distributed with this work for additional information
004 * regarding copyright ownership.
005 *
006 * DuraSpace licenses this file to you under the Apache License,
007 * Version 2.0 (the "License"); you may not use this file except in
008 * compliance with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018
019package org.fcrepo.kernel.api.lock;
020
021import org.fcrepo.kernel.api.exception.ConcurrentUpdateException;
022import org.fcrepo.kernel.api.identifiers.FedoraId;
023
024/**
025 * Responsible for managing write locks on Fedora resources
026 *
027 * @author pwinckles
028 */
029public interface ResourceLockManager {
030
031    /**
032     * Acquires a lock on the resource, associating it to the txId. If the lock is held by a different transaction,
033     * an exception is thrown. If the lock is already held by the same transaction, then it returns successfully.
034     *
035     * @param txId the transaction id to associate the lock to
036     * @param resourceId the resource to lock
037     * @throws ConcurrentUpdateException when lock cannot be acquired
038     */
039    void acquire(final String txId, final FedoraId resourceId);
040
041    /**
042     * Releases all of the locks held by the transaction
043     *
044     * @param txId the transaction id
045     */
046    void releaseAll(final String txId);
047
048}