1 package org.eclipse.aether.impl;
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 import org.eclipse.aether.deployment.DeployRequest;
24 import org.eclipse.aether.installation.InstallRequest;
25
26 /**
27 * A factory to create metadata generators. Metadata generators can contribute additional metadata during the
28 * installation/deployment of artifacts.
29 *
30 * @provisional This type is provisional and can be changed, moved or removed without prior notice.
31 */
32 public interface MetadataGeneratorFactory
33 {
34
35 /**
36 * Creates a new metadata generator for the specified install request.
37 *
38 * @param session The repository system session from which to configure the generator, must not be {@code null}.
39 * @param request The install request the metadata generator is used for, must not be {@code null}.
40 * @return The metadata generator for the request or {@code null} if none.
41 */
42 MetadataGenerator newInstance( RepositorySystemSession session, InstallRequest request );
43
44 /**
45 * Creates a new metadata generator for the specified deploy request.
46 *
47 * @param session The repository system session from which to configure the generator, must not be {@code null}.
48 * @param request The deploy request the metadata generator is used for, must not be {@code null}.
49 * @return The metadata generator for the request or {@code null} if none.
50 */
51 MetadataGenerator newInstance( RepositorySystemSession session, DeployRequest request );
52
53 /**
54 * The priority of this factory. Factories with higher priority are invoked before those with lower priority.
55 *
56 * @return The priority of this factory.
57 */
58 float getPriority();
59
60 }