io.fabric8.maven.generator.webapp.AppServerHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fabric8-maven-generator-webapp Show documentation

The newest version!

package io.fabric8.maven.generator.webapp;

import java.util.List;

/**
 * Interface encapsulating a certain application handler
 *
 * @author kameshs
 */
public interface AppServerHandler {

    /**
     * Return true it the handler thinks it should kick in. Typically
     * check for certain app server specific files and or plugins.
     * @return
     */
    boolean isApplicable();

    /**
     * Get the base image to use for this specifi app server
     * @return base image name in Docker format.
     */
    String getFrom();

    /**
     * Get the directory with in the base image where to put the applications
     * into.
     *
     * @return the deployment directory fitting the the from() image.
     */
    String getDeploymentDir();

    /**
     * Get the default command to put into the image, which should fit to the
     * image returned from from()
     *
     * @return the default command.
     */
    String getCommand();

    /**
     * Get the user to use. Return null if no specific user directive is required
     */
    String getUser();

    /**
     * A list of ports which are exposed by the base image
     *
     * @return list of ports to expos
     */
    List exposedPorts();
}