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