001package org.eclipse.aether.impl;
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.RepositorySystemSession;
023import org.eclipse.aether.repository.RemoteRepository;
024import org.eclipse.aether.transfer.RepositoryOfflineException;
025
026/**
027 * Determines whether a remote repository is accessible in offline mode.
028 * 
029 * @noimplement This interface is not intended to be implemented by clients.
030 * @noextend This interface is not intended to be extended by clients.
031 * @provisional This type is provisional and can be changed, moved or removed without prior notice.
032 */
033public interface OfflineController
034{
035
036    /**
037     * Determines whether the specified repository is accessible if the system was in offline mode. A simple
038     * implementation might unconditionally throw {@link RepositoryOfflineException} to block all remote repository
039     * access when in offline mode. More sophisticated implementations might inspect
040     * {@link RepositorySystemSession#getConfigProperties() configuration properties} of the session to check for some
041     * kind of whitelist that allows certain remote repositories even when offline. At any rate, the session's current
042     * {@link RepositorySystemSession#isOffline() offline state} is irrelevant to the outcome of the check.
043     * 
044     * @param session The repository session during which the check is made, must not be {@code null}.
045     * @param repository The remote repository to check for offline access, must not be {@code null}.
046     * @throws RepositoryOfflineException If the repository is not accessible in offline mode. If the method returns
047     *             normally, the repository is considered accessible even in offline mode.
048     * @see RepositorySystemSession#isOffline()
049     */
050    void checkOffline( RepositorySystemSession session, RemoteRepository repository )
051        throws RepositoryOfflineException;
052
053}