nextflow.container.resolver.ContainerResolver.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nextflow Show documentation

A DSL modelled around the UNIX pipe concept, that simplifies writing parallel and scalable pipelines in a portable manner

There is a newer version: 24.11.0-edge

Show newest version

/*
 * Copyright 2013-2024, Seqera Labs
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package nextflow.container.resolver


import nextflow.processor.TaskRun
import org.pf4j.ExtensionPoint
/**
 * Given a container image name resolves it to target image name.
 *
 * The resolver takes care to prepend the target registry name defined
 * in the nextflow config or adapt the container image name depending
 * the configured container engine
 *
 * @author Paolo Di Tommaso 
 */
interface ContainerResolver extends ExtensionPoint {

    /**
     * Resolve a container name to the fully qualified name. This method
     * can extend the specified container name with engine specific
     * protocol prefixes and container registry specified in the
     * pipeline configuration file
     *
     * @param task
     *      The {@link TaskRun} requesting the container image
     * @param imageName
     *      The container image name associated to the task execution
     * @return
     *      The resolved container image name
     */
    ContainerInfo resolveImage(TaskRun task, String imageName)

    /**
     * Check the availability of the specified container reference
     *
     * @param key The container reference
     * @return {@code true} when the container is available for use, {@code false} otherwise
     */
    boolean isContainerReady(String key)

}