001package org.eclipse.aether.spi.connector.filter;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *  http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.eclipse.aether.artifact.Artifact;
023import org.eclipse.aether.metadata.Metadata;
024import org.eclipse.aether.repository.RemoteRepository;
025
026/**
027 * Remote repository filter that decides should the given artifact or metadata be accepted (for further processing)
028 * from remote repository or not.
029 *
030 * @since 1.9.0
031 */
032public interface RemoteRepositoryFilter
033{
034    /**
035     * The check result, is immutable.
036     */
037    interface Result
038    {
039        /**
040         * Returns {@code true} if accepted.
041         */
042        boolean isAccepted();
043
044        /**
045         * Returns string "reasoning" for {@link #isAccepted()} result, meant for human consumption, never {@code null}.
046         */
047        String reasoning();
048    }
049
050    /**
051     * Decides should artifact be accepted from given remote repository.
052     *
053     * @param remoteRepository The remote repository, not {@code null}.
054     * @param artifact         The artifact, not {@code null}.
055     * @return the result, never {@code null}.
056     */
057    Result acceptArtifact( RemoteRepository remoteRepository, Artifact artifact );
058
059    /**
060     * Decides should metadata be accepted from given remote repository.
061     *
062     * @param remoteRepository The remote repository, not {@code null}.
063     * @param metadata         The artifact, not {@code null}.
064     * @return the result, never {@code null}.
065     */
066    Result acceptMetadata( RemoteRepository remoteRepository, Metadata metadata );
067}