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