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.spi.synccontext;
020
021import org.eclipse.aether.RepositorySystem;
022import org.eclipse.aether.RepositorySystemSession;
023import org.eclipse.aether.SyncContext;
024
025/**
026 * A factory to create synchronization contexts. A synchronization context is used to coordinate concurrent access to
027 * artifacts or metadata.
028 */
029public interface SyncContextFactory {
030
031    /**
032     * Creates a new synchronization context.
033     *
034     * @param session The repository session during which the context will be used, must not be {@code null}.
035     * @param shared A flag indicating whether access to the artifacts/metadata associated with the new context can be
036     *            shared among concurrent readers or whether access needs to be exclusive to the calling thread.
037     * @return The synchronization context, never {@code null}.
038     * @see RepositorySystem#newSyncContext(RepositorySystemSession, boolean)
039     */
040    SyncContext newInstance(RepositorySystemSession session, boolean shared);
041}