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