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.spi.connector.filter; 20 21 import org.eclipse.aether.artifact.Artifact; 22 import org.eclipse.aether.metadata.Metadata; 23 import org.eclipse.aether.repository.RemoteRepository; 24 25 /** 26 * Remote repository filter that decides should the given artifact or metadata be accepted (for further processing) 27 * from remote repository or not. 28 * 29 * @since 1.9.0 30 */ 31 public interface RemoteRepositoryFilter { 32 /** 33 * The check result, is immutable. 34 */ 35 interface Result { 36 /** 37 * Returns {@code true} if accepted. 38 */ 39 boolean isAccepted(); 40 41 /** 42 * Returns string "reasoning" for {@link #isAccepted()} result, meant for human consumption, never {@code null}. 43 */ 44 String reasoning(); 45 } 46 47 /** 48 * Decides should artifact be accepted from given remote repository. 49 * 50 * @param remoteRepository The remote repository, not {@code null}. 51 * @param artifact The artifact, not {@code null}. 52 * @return the result, never {@code null}. 53 */ 54 Result acceptArtifact(RemoteRepository remoteRepository, Artifact artifact); 55 56 /** 57 * Decides should metadata be accepted from given remote repository. 58 * 59 * @param remoteRepository The remote repository, not {@code null}. 60 * @param metadata The artifact, not {@code null}. 61 * @return the result, never {@code null}. 62 */ 63 Result acceptMetadata(RemoteRepository remoteRepository, Metadata metadata); 64 }