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.resolution;
20
21 import org.eclipse.aether.RepositorySystemSession;
22
23 /**
24 * Controls the handling of errors related to reading an artifact descriptor.
25 *
26 * @see RepositorySystemSession#getArtifactDescriptorPolicy()
27 */
28 public interface ArtifactDescriptorPolicy {
29
30 /**
31 * Bit mask indicating that errors while reading the artifact descriptor should not be tolerated.
32 */
33 int STRICT = 0x00;
34
35 /**
36 * Bit flag indicating that missing artifact descriptors should be silently ignored.
37 */
38 int IGNORE_MISSING = 0x01;
39
40 /**
41 * Bit flag indicating that existent but invalid artifact descriptors should be silently ignored.
42 */
43 int IGNORE_INVALID = 0x02;
44
45 /**
46 * Bit mask indicating that all errors should be silently ignored.
47 */
48 int IGNORE_ERRORS = IGNORE_MISSING | IGNORE_INVALID;
49
50 /**
51 * Gets the error policy for an artifact's descriptor.
52 *
53 * @param session The repository session during which the policy is determined, must not be {@code null}.
54 * @param request The policy request holding further details, must not be {@code null}.
55 * @return The bit mask describing the desired error policy.
56 */
57 int getPolicy(RepositorySystemSession session, ArtifactDescriptorPolicyRequest request);
58 }