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;
022
023/**
024 * Evaluates update policies.
025 *
026 * @noimplement This interface is not intended to be implemented by clients.
027 * @noextend This interface is not intended to be extended by clients.
028 * @provisional This type is provisional and can be changed, moved or removed without prior notice.
029 */
030public interface UpdatePolicyAnalyzer {
031
032    /**
033     * Returns the policy with the shorter update interval.
034     *
035     * @param session The repository system session during which the request is made, must not be {@code null}.
036     * @param policy1 A policy to compare, may be {@code null}.
037     * @param policy2 A policy to compare, may be {@code null}.
038     * @return The policy with the shorter update interval.
039     */
040    String getEffectiveUpdatePolicy(RepositorySystemSession session, String policy1, String policy2);
041
042    /**
043     * Determines whether the specified modification timestamp satisfies the freshness constraint expressed by the given
044     * update policy.
045     *
046     * @param session The repository system session during which the check is made, must not be {@code null}.
047     * @param lastModified The timestamp to check against the update policy.
048     * @param policy The update policy, may be {@code null}.
049     * @return {@code true} if the specified timestamp is older than acceptable by the update policy, {@code false}
050     *         otherwise.
051     */
052    boolean isUpdatedRequired(RepositorySystemSession session, long lastModified, String policy);
053}