View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.eclipse.aether.impl;
20  
21  import org.eclipse.aether.RepositorySystemSession;
22  
23  /**
24   * Evaluates update policies.
25   *
26   * @noimplement This interface is not intended to be implemented by clients.
27   * @noextend This interface is not intended to be extended by clients.
28   * @provisional This type is provisional and can be changed, moved or removed without prior notice.
29   */
30  public interface UpdatePolicyAnalyzer {
31  
32      /**
33       * Returns the policy with the shorter update interval.
34       *
35       * @param session The repository system session during which the request is made, must not be {@code null}.
36       * @param policy1 A policy to compare, may be {@code null}.
37       * @param policy2 A policy to compare, may be {@code null}.
38       * @return The policy with the shorter update interval.
39       */
40      String getEffectiveUpdatePolicy(RepositorySystemSession session, String policy1, String policy2);
41  
42      /**
43       * Determines whether the specified modification timestamp satisfies the freshness constraint expressed by the given
44       * update policy.
45       *
46       * @param session The repository system session during which the check is made, must not be {@code null}.
47       * @param lastModified The timestamp to check against the update policy.
48       * @param policy The update policy, may be {@code null}.
49       * @return {@code true} if the specified timestamp is older than acceptable by the update policy, {@code false}
50       *         otherwise.
51       */
52      boolean isUpdatedRequired(RepositorySystemSession session, long lastModified, String policy);
53  }