1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.eclipse.aether.named;
20
21 /**
22 * A factory of {@link NamedLock}s.
23 */
24 public interface NamedLockFactory {
25 /**
26 * Creates or reuses existing {@link NamedLock}. Returns instance MUST BE treated as "resource", best in
27 * try-with-resource block.
28 *
29 * @param name the lock name, must not be {@code null}.
30 * @return named lock instance, never {@code null}.
31 */
32 NamedLock getLock(String name);
33
34 /**
35 * Performs a clean shut down of the factory.
36 */
37 void shutdown();
38
39 /**
40 * Method to notify factory about locking failure, to make it possible to provide more (factory specific)
41 * information about factory state when a locking operation failed. Factory may alter provided failure or
42 * provide information via some other side effect (for example via logging).
43 * <p>
44 * The default implementation merely does what happened before: adds no extra information.
45 *
46 * @since 1.9.11
47 */
48 default <E extends Throwable> E onFailure(E failure) {
49 return failure;
50 }
51 }