001package org.eclipse.aether.impl;
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;
023import org.eclipse.aether.deployment.DeployRequest;
024import org.eclipse.aether.installation.InstallRequest;
025
026/**
027 * A factory to create metadata generators. Metadata generators can contribute additional metadata during the
028 * installation/deployment of artifacts.
029 * 
030 * @provisional This type is provisional and can be changed, moved or removed without prior notice.
031 */
032public interface MetadataGeneratorFactory
033{
034
035    /**
036     * Creates a new metadata generator for the specified install request.
037     * 
038     * @param session The repository system session from which to configure the generator, must not be {@code null}.
039     * @param request The install request the metadata generator is used for, must not be {@code null}.
040     * @return The metadata generator for the request or {@code null} if none.
041     */
042    MetadataGenerator newInstance( RepositorySystemSession session, InstallRequest request );
043
044    /**
045     * Creates a new metadata generator for the specified deploy request.
046     * 
047     * @param session The repository system session from which to configure the generator, must not be {@code null}.
048     * @param request The deploy request the metadata generator is used for, must not be {@code null}.
049     * @return The metadata generator for the request or {@code null} if none.
050     */
051    MetadataGenerator newInstance( RepositorySystemSession session, DeployRequest request );
052
053    /**
054     * The priority of this factory. Factories with higher priority are invoked before those with lower priority.
055     * 
056     * @return The priority of this factory.
057     */
058    float getPriority();
059
060}