Support for multiple archetypes repositories

[jagame]

New feature, improvement proposal

Given current settings.xml:

<?xml version="1.0" encoding="UTF-8"?>
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 https://maven.apache.org/xsd/settings-1.0.0.xsd">
    <profiles>
        <profile>
            <id>ibm</id>
            <repositories>
                <repository>
                    <id>was-archetype</id>
                    <url>https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/wasdev/maven/repository/</url>
                </repository>
            </repositories>
        </profile>
    </profiles>
    <activeProfiles>
        <activeProfile>ibm</activeProfile>
    </activeProfiles>
</settings>

when run

mvn archetype:generate -Dfilter="com.ibm:"

the archetypes resolution respond with:

Choose archetype:
1: remote -> com.ibm.cics:cics-bundle-deploy-reactor-archetype (An archetype demonstrating how to use the cics-bundle-maven-plugin to build and deploy a CICS bundle using a build with a Maven reactor.)
2: remote -> com.ibm.cics:cics-bundle-reactor-archetype (An archetype demonstrating how to use the cics-bundle-maven-plugin to build a CICS bundle using a build with a Maven reactor.)
3: remote -> com.ibm.mfp:adapter-maven-archetype-http (IBM MFP Adapter archetype for JavaScript adapter as a maven project. BuildNumber is : 8.0.2024082809)
4: remote -> com.ibm.mfp:adapter-maven-archetype-java (IBM MFP Adapter archetype for Java adapter as a maven project. BuildNumber is : dummyBuildNumber)
5: remote -> com.ibm.mfp:adapter-maven-archetype-sql (IBM MFP Adapter archetype for sql adapter as a maven project. BuildNumber is : dummyBuildNumber)
6: remote -> com.ibm.sbt:sbt.sso.webapp-archetype (-)
Choose a number or apply filter (format: [groupId:]artifactId, case sensitive contains): :

Not resolving the added repository ones.

When you use a repository with id "archetype", this works... but it stops searching in central. ¿Why is the archetypes search done in only one repository? In my opinion, at least an "id pattern" should be used instead of a static and single one.

[jagame]

A possible "solution" should be as simple as modifying RemoteCatalogArchetypeDataSource:

@Named("remote-catalog")
@Singleton
public class RemoteCatalogArchetypeDataSource extends CatalogArchetypeDataSource implements ArchetypeDataSource {
    private static final Logger LOGGER = LoggerFactory.getLogger(RemoteCatalogArchetypeDataSource.class);

    @Inject
    private RepositorySystem repositorySystem;

    /**
     * Id of the repository used to download catalog file. Proxy or authentication info can
     * be setup in settings.xml.
     */
    public static final String ARCHETYPE_REPOSITORY_ID = "archetype";

    public static final String CENTRAL_REPOSITORY_ID = "central";

    @Override
    public ArchetypeCatalog getArchetypeCatalog(
            RepositorySystemSession repositorySession, List<RemoteRepository> remoteRepositories)
            throws ArchetypeDataSourceException {
        ArchetypeCatalog mergedArchetypeCatalogs = new ArchetypeCatalog();
        for(RemoteRepository repository : remoteRepositories) {
            ArchetypeCatalog catalog = getArchetypeCatalog(repositorySession, repository);
            mergedArchetypeCatalogs.getArchetypes().addAll(catalog.getArchetypes());
        }
        return mergedArchetypeCatalogs;
    }

    private ArchetypeCatalog getArchetypeCatalog(
            RepositorySystemSession repositorySession, RemoteRepository repository)
            throws ArchetypeDataSourceException {
        Optional<MetadataResult> optMetadataResult = requestMetadata(repositorySession, repository);
        if(!optMetadataResult.isPresent()) {
            return new ArchetypeCatalog();
        }

        try {
            return readCatalog(
                    new XmlStreamReader(optMetadataResult.get().getMetadata().getFile())
            );
        } catch (IOException e) {
            throw new ArchetypeDataSourceException(e);
        }
    }

    private Optional<MetadataResult> requestMetadata(RepositorySystemSession repositorySession, RemoteRepository remoteRepository) {
        if(!isArchetypeCatalogRepository(remoteRepository)) {
            return Optional.empty();
        }

        MetadataRequest request = new MetadataRequest();
        request.setRepository(remoteRepository);
        request.setMetadata(new DefaultMetadata(ARCHETYPE_CATALOG_FILENAME, Metadata.Nature.RELEASE));

        MetadataResult metadataResult = repositorySystem
                .resolveMetadata(repositorySession, Collections.singletonList(request))
                .get(0);

        if (metadataResult.isResolved()) {
            return Optional.of(metadataResult);
        } else {
            LOGGER.error("No {} had been resolved for repository {}",
                    ARCHETYPE_CATALOG_FILENAME, remoteRepository.getId(), metadataResult.getException()
            );
            return Optional.empty();
        }
    }

    private boolean isArchetypeCatalogRepository(RemoteRepository remoteRepository) {
        if (remoteRepository == null || remoteRepository.getId() == null) {
            return false;
        }

        return ARCHETYPE_REPOSITORY_ID.equals(remoteRepository.getId())
                || remoteRepository.getId().endsWith('-' + ARCHETYPE_REPOSITORY_ID)
                || CENTRAL_REPOSITORY_ID.equals(remoteRepository.getId());
    }

    @Override
    public File updateCatalog(RepositorySystemSession repositorySession, Archetype archetype)
            throws ArchetypeDataSourceException {
        throw new ArchetypeDataSourceException("Not supported yet.");
    }
}

[slawekjaranowski]

PR is welcome