Package org.xwiki.test.docker.junit5.servletengine

Enum ServletEngine

    • Enum Constant Detail

      • TOMCAT

        public static final ServletEngine TOMCAT
        Represents the Tomcat Servlet engine.

      • JETTY

        public static final ServletEngine JETTY
        Represents the Jetty Servlet engine (running inside Docker).

      • JETTY_STANDALONE

        public static final ServletEngine JETTY_STANDALONE
        Represents the Jetty Servlet engine but running outside of Docker.

      • WILDFLY

        public static final ServletEngine WILDFLY
        Represents the JBoss Wildfly engine.

      • EXTERNAL

        public static final ServletEngine EXTERNAL
        Represents an external Servlet Engine already configured and running (we won't start or stop it).

    • Method Detail

      • values

        public static ServletEngine[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (ServletEngine c : ServletEngine.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ServletEngine valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • isOutsideDocker

        public boolean isOutsideDocker()
        Returns:
        true if the Servlet engine is meant to be running on the host and not in a Docker container

      • setIP

        public void setIP​(String ip)
        Parameters:
        ip - see getIP()
        Since:
        10.11RC1

      • getIP

        public String getIP()
        Returns:
        the IP address to use to connect to the Servlet Engine from the outside (it is different if it runs locally or in a Docker container).
        Since:
        10.11RC1

      • setPort

        public void setPort​(int port)
        Parameters:
        port - see getPort()
        Since:
        10.11RC1

      • getPort

        public int getPort()
        Returns:
        the port to use to connect to the Servlet Engine from the outside (it is different if it runs locally or in a Docker container)
        Since:
        10.11RC1

      • getHostIP

        public String getHostIP()
        Returns:
        the IP to the host from inside the Servlet Engine
        Since:
        10.11RC1

      • getInternalIP

        public String getInternalIP()
        Returns:
        the IP of the container from inside itself (it is different if it runs locally or in a Docker container)
        Since:
        10.11RC1

      • getInternalPort

        public int getInternalPort()
        Returns:
        the port of the container from inside itself (it is different if it runs locally or in a Docker container)
        Since:
        10.11RC1

      • getPermanentDirectory

        public String getPermanentDirectory()
        Returns:
        the location of the XWiki permanent directory inside the Docker container for the Servlet Engine.
        Since:
        10.11RC1

      • getDockerImageName

        public String getDockerImageName()
        Returns:
        the Docker image name for this Servlet Engine. This image must be available on DockerHub.
        Since:
        10.11RC1