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