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