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.spi.connector.filter; 020 021import org.eclipse.aether.artifact.Artifact; 022import org.eclipse.aether.metadata.Metadata; 023import org.eclipse.aether.repository.RemoteRepository; 024 025/** 026 * Remote repository filter that decides should the given artifact or metadata be accepted (for further processing) 027 * from remote repository or not. 028 * 029 * @since 1.9.0 030 */ 031public interface RemoteRepositoryFilter { 032 /** 033 * The check result, is immutable. 034 */ 035 interface Result { 036 /** 037 * Returns {@code true} if accepted. 038 */ 039 boolean isAccepted(); 040 041 /** 042 * Returns string "reasoning" for {@link #isAccepted()} result, meant for human consumption, never {@code null}. 043 */ 044 String reasoning(); 045 } 046 047 /** 048 * Decides should artifact be accepted from given remote repository. 049 * 050 * @param remoteRepository The remote repository, not {@code null}. 051 * @param artifact The artifact, not {@code null}. 052 * @return the result, never {@code null}. 053 */ 054 Result acceptArtifact(RemoteRepository remoteRepository, Artifact artifact); 055 056 /** 057 * Decides should metadata be accepted from given remote repository. 058 * 059 * @param remoteRepository The remote repository, not {@code null}. 060 * @param metadata The artifact, not {@code null}. 061 * @return the result, never {@code null}. 062 */ 063 Result acceptMetadata(RemoteRepository remoteRepository, Metadata metadata); 064}