View Javadoc
1   package org.eclipse.aether.impl;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   * 
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   * 
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.eclipse.aether.RepositorySystemSession;
23  import org.eclipse.aether.artifact.Artifact;
24  import org.eclipse.aether.metadata.Metadata;
25  import org.eclipse.aether.transfer.ArtifactTransferException;
26  import org.eclipse.aether.transfer.MetadataTransferException;
27  
28  /**
29   * Determines if updates of artifacts and metadata from remote repositories are needed.
30   * 
31   * @noimplement This interface is not intended to be implemented by clients.
32   * @noextend This interface is not intended to be extended by clients.
33   * @provisional This type is provisional and can be changed, moved or removed without prior notice.
34   */
35  public interface UpdateCheckManager
36  {
37  
38      /**
39       * Checks whether an artifact has to be updated from a remote repository.
40       * 
41       * @param session The repository system session during which the request is made, must not be {@code null}.
42       * @param check The update check request, must not be {@code null}.
43       */
44      void checkArtifact( RepositorySystemSession session, UpdateCheck<Artifact, ArtifactTransferException> check );
45  
46      /**
47       * Updates the timestamp for the artifact contained in the update check.
48       * 
49       * @param session The repository system session during which the request is made, must not be {@code null}.
50       * @param check The update check request, must not be {@code null}.
51       */
52      void touchArtifact( RepositorySystemSession session, UpdateCheck<Artifact, ArtifactTransferException> check );
53  
54      /**
55       * Checks whether metadata has to be updated from a remote repository.
56       * 
57       * @param session The repository system session during which the request is made, must not be {@code null}.
58       * @param check The update check request, must not be {@code null}.
59       */
60      void checkMetadata( RepositorySystemSession session, UpdateCheck<Metadata, MetadataTransferException> check );
61  
62      /**
63       * Updates the timestamp for the metadata contained in the update check.
64       * 
65       * @param session The repository system session during which the request is made, must not be {@code null}.
66       * @param check The update check request, must not be {@code null}.
67       */
68      void touchMetadata( RepositorySystemSession session, UpdateCheck<Metadata, MetadataTransferException> check );
69  
70  }