001package org.eclipse.aether.resolution;
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;
023
024/**
025 * Controls the handling of errors related to reading an artifact descriptor.
026 * 
027 * @see RepositorySystemSession#getArtifactDescriptorPolicy()
028 */
029public interface ArtifactDescriptorPolicy
030{
031
032    /**
033     * Bit mask indicating that errors while reading the artifact descriptor should not be tolerated.
034     */
035    int STRICT = 0x00;
036
037    /**
038     * Bit flag indicating that missing artifact descriptors should be silently ignored.
039     */
040    int IGNORE_MISSING = 0x01;
041
042    /**
043     * Bit flag indicating that existent but invalid artifact descriptors should be silently ignored.
044     */
045    int IGNORE_INVALID = 0x02;
046
047    /**
048     * Bit mask indicating that all errors should be silently ignored.
049     */
050    int IGNORE_ERRORS = IGNORE_MISSING | IGNORE_INVALID;
051
052    /**
053     * Gets the error policy for an artifact's descriptor.
054     * 
055     * @param session The repository session during which the policy is determined, must not be {@code null}.
056     * @param request The policy request holding further details, must not be {@code null}.
057     * @return The bit mask describing the desired error policy.
058     */
059    int getPolicy( RepositorySystemSession session, ArtifactDescriptorPolicyRequest request );
060
061}