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.impl;
020
021import org.eclipse.aether.RepositorySystemSession;
022import org.eclipse.aether.artifact.Artifact;
023import org.eclipse.aether.metadata.Metadata;
024import org.eclipse.aether.transfer.ArtifactTransferException;
025import org.eclipse.aether.transfer.MetadataTransferException;
026
027/**
028 * Determines if updates of artifacts and metadata from remote repositories are needed.
029 *
030 * @noimplement This interface is not intended to be implemented by clients.
031 * @noextend This interface is not intended to be extended by clients.
032 * @provisional This type is provisional and can be changed, moved or removed without prior notice.
033 */
034public interface UpdateCheckManager {
035
036    /**
037     * Checks whether an artifact has to be updated from a remote repository.
038     *
039     * @param session The repository system session during which the request is made, must not be {@code null}.
040     * @param check The update check request, must not be {@code null}.
041     */
042    void checkArtifact(RepositorySystemSession session, UpdateCheck<Artifact, ArtifactTransferException> check);
043
044    /**
045     * Updates the timestamp for the artifact contained in the update check.
046     *
047     * @param session The repository system session during which the request is made, must not be {@code null}.
048     * @param check The update check request, must not be {@code null}.
049     */
050    void touchArtifact(RepositorySystemSession session, UpdateCheck<Artifact, ArtifactTransferException> check);
051
052    /**
053     * Checks whether metadata has to be updated from a remote repository.
054     *
055     * @param session The repository system session during which the request is made, must not be {@code null}.
056     * @param check The update check request, must not be {@code null}.
057     */
058    void checkMetadata(RepositorySystemSession session, UpdateCheck<Metadata, MetadataTransferException> check);
059
060    /**
061     * Updates the timestamp for the metadata contained in the update check.
062     *
063     * @param session The repository system session during which the request is made, must not be {@code null}.
064     * @param check The update check request, must not be {@code null}.
065     */
066    void touchMetadata(RepositorySystemSession session, UpdateCheck<Metadata, MetadataTransferException> check);
067}