001package org.eclipse.aether.named;
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
022/**
023 * A factory of {@link NamedLock}s.
024 */
025public interface NamedLockFactory
026{
027    /**
028     * Creates or reuses existing {@link NamedLock}. Returns instance MUST BE treated as "resource", best in
029     * try-with-resource block.
030     *
031     * @param name the lock name, must not be {@code null}.
032     * @return named lock instance, never {@code null}.
033     */
034    NamedLock getLock( String name );
035
036    /**
037     * Performs a clean shut down of the factory.
038     */
039    void shutdown();
040}