1 package org.eclipse.aether.impl;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import org.eclipse.aether.RepositorySystem;
23 import org.eclipse.aether.RepositorySystemSession;
24 import org.eclipse.aether.SyncContext;
25
26 /**
27 * A factory to create synchronization contexts. A synchronization context is used to coordinate concurrent access to
28 * artifacts or metadata.
29 *
30 * @provisional This type is provisional and can be changed, moved or removed without prior notice.
31 */
32 public interface SyncContextFactory
33 {
34
35 /**
36 * Creates a new synchronization context.
37 *
38 * @param session The repository session during which the context will be used, must not be {@code null}.
39 * @param shared A flag indicating whether access to the artifacts/metadata associated with the new context can be
40 * shared among concurrent readers or whether access needs to be exclusive to the calling thread.
41 * @return The synchronization context, never {@code null}.
42 * @see RepositorySystem#newSyncContext(RepositorySystemSession, boolean)
43 */
44 SyncContext newInstance( RepositorySystemSession session, boolean shared );
45
46 }