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.spi.synccontext;
20
21 import org.eclipse.aether.RepositorySystem;
22 import org.eclipse.aether.RepositorySystemSession;
23 import org.eclipse.aether.SyncContext;
24
25 /**
26 * A factory to create synchronization contexts. A synchronization context is used to coordinate concurrent access to
27 * artifacts or metadata.
28 */
29 public interface SyncContextFactory {
30
31 /**
32 * Creates a new synchronization context.
33 *
34 * @param session The repository session during which the context will be used, must not be {@code null}.
35 * @param shared A flag indicating whether access to the artifacts/metadata associated with the new context can be
36 * shared among concurrent readers or whether access needs to be exclusive to the calling thread.
37 * @return The synchronization context, never {@code null}.
38 * @see RepositorySystem#newSyncContext(RepositorySystemSession, boolean)
39 */
40 SyncContext newInstance(RepositorySystemSession session, boolean shared);
41 }