dev.galasa.docker.IDockerContainerConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dev.galasa.docker.manager Show documentation

A Galasa project

The newest version!

/*
 * Copyright contributors to the Galasa project
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package dev.galasa.docker;

import java.util.HashMap;
import java.util.List;

/**
 * An interface for the annotation object that represents the configurations for a container.
 * 
 *   
 */
public interface IDockerContainerConfig {

    /**
     * Allows for enivironment variables to be set on the container at startup
     * 
     * @param envs
     */
    public void setEnvs(HashMap envs);

    /**
     * Returns the list of specified Keys and Values for the envs desired to be set
     * 
     * @return envs
     */
    public HashMap getEnvs();

    /**
     * Lists all the provisioned/binded volumes for this configuration.
     * @return
     */
    public List getVolumes();

    /**
     * Get the volume by the tag it is known as.
     * @param volumeTag
     * @return a volume from the configuration of a specfic tag. 
     */
    public IDockerVolume getVolumeByTag(String volumeTag);
    

    /**
     * Allows a set of ports to be exposed inside the container before startup. Ports are to be expressed for the
     * conatiner and not the host (I.e. "8080/tcp"), as a random port will be exposed on the host, which can be
     * obtained on the container object
     * 
     * @param ports
     */
    public void setExposedPorts(List ports);

    /**
     * Retruns a list of exposed ports
     * 
     * @return
     */
    public List getExposedPorts();
}