001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * 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,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.eclipse.aether.named;
020
021/**
022 * A factory of {@link NamedLock}s.
023 */
024public interface NamedLockFactory {
025    /**
026     * Creates or reuses existing {@link NamedLock}. Returns instance MUST BE treated as "resource", best in
027     * try-with-resource block.
028     *
029     * @param name the lock name, must not be {@code null}.
030     * @return named lock instance, never {@code null}.
031     */
032    NamedLock getLock(String name);
033
034    /**
035     * Performs a clean shut down of the factory.
036     */
037    void shutdown();
038
039    /**
040     * Method to notify factory about locking failure, to make it possible to provide more (factory specific)
041     * information about factory state when a locking operation failed. Factory may alter provided failure or
042     * provide information via some other side effect (for example via logging).
043     * <p>
044     * The default implementation merely does what happened before: adds no extra information.
045     *
046     * @since 1.9.11
047     */
048    default <E extends Throwable> E onFailure(E failure) {
049        return failure;
050    }
051}