1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.eclipse.aether.impl;
20
21 import org.eclipse.aether.RepositorySystemSession;
22 import org.eclipse.aether.repository.RemoteRepository;
23 import org.eclipse.aether.transfer.RepositoryOfflineException;
24
25 /**
26 * Determines whether a remote repository is accessible in offline mode.
27 *
28 * @noimplement This interface is not intended to be implemented by clients.
29 * @noextend This interface is not intended to be extended by clients.
30 * @provisional This type is provisional and can be changed, moved or removed without prior notice.
31 */
32 public interface OfflineController {
33
34 /**
35 * Determines whether the specified repository is accessible if the system was in offline mode. A simple
36 * implementation might unconditionally throw {@link RepositoryOfflineException} to block all remote repository
37 * access when in offline mode. More sophisticated implementations might inspect
38 * {@link RepositorySystemSession#getConfigProperties() configuration properties} of the session to check for some
39 * kind of whitelist that allows certain remote repositories even when offline. At any rate, the session's current
40 * {@link RepositorySystemSession#isOffline() offline state} is irrelevant to the outcome of the check.
41 *
42 * @param session The repository session during which the check is made, must not be {@code null}.
43 * @param repository The remote repository to check for offline access, must not be {@code null}.
44 * @throws RepositoryOfflineException If the repository is not accessible in offline mode. If the method returns
45 * normally, the repository is considered accessible even in offline mode.
46 * @see RepositorySystemSession#isOffline()
47 */
48 void checkOffline(RepositorySystemSession session, RemoteRepository repository) throws RepositoryOfflineException;
49 }