de.hybris.platform.atddrunner.service

Class IntegrationServletContainer

java.lang.Object

de.hybris.platform.atddrunner.service.IntegrationServletContainer

public class IntegrationServletContainer
extends java.lang.Object

Configurable embedded servlet container.

Constructor Summary

Constructors

Constructor and Description
IntegrationServletContainer()

Method Summary

Modifier and Type	Method and Description
protected java.util.List<java.lang.String>	buildProperties()
protected void	createServer()
protected java.util.concurrent.CompletableFuture	createServletChecker(ServletDefinition servletDefinition)
protected java.lang.String	getAbsolutePath(java.lang.String path) The method constructs absolute path.
java.lang.String	getConnectionPath()
java.lang.String	getHeartbeat()
protected java.lang.String	getJavaPath()
java.lang.String	getLogFilePath()
java.util.Properties	getProperties()
java.lang.Process	getServerProcess()
java.lang.String	getWarPath()
java.lang.String	getWebappRunnerJarFile()
boolean	isRunning()
void	setConnectionPath(java.lang.String connectionPath)
void	setHeartbeat(java.lang.String path) Path to resource, which can indicate the servlet is alive.
void	setJettyConfigPath(java.lang.String jettyConfigPath) Path to jetty config file.
void	setLibPath(java.lang.String libPath) Path to jetty lib folder.
void	setLogFilePath(java.lang.String path) File where to store server console output.
void	setPort(java.lang.Integer port) Port to run jetty.
void	setProperties(java.util.Properties properties)
void	setServlets(java.util.List<ServletDefinition> servlets) Servlet configurations to run.
void	setWarPath(java.lang.String warPath) Path to servlet file.
void	setWebappRunnerJarFile(java.lang.String webappRunnerJarFile) Sets the webappRunner jar file.
void	start() Start servlet container with warPath deployed.
protected java.lang.Integer	startServletWithTimeout(ServletDefinition servletDefinition)
void	stop() Stop servlet container.
protected void	waitForServiceToStart()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IntegrationServletContainer

public IntegrationServletContainer()

Method Detail

start

public void start()

Start servlet container with warPath deployed.

stop

public void stop()

Stop servlet container.

isRunning

public boolean isRunning()

createServer

protected void createServer()
                     throws java.lang.Exception

Throws:

java.lang.Exception

waitForServiceToStart

protected void waitForServiceToStart()
                              throws java.io.IOException,
                                     java.lang.InterruptedException

Throws:

java.io.IOException

java.lang.InterruptedException

createServletChecker

protected java.util.concurrent.CompletableFuture createServletChecker(ServletDefinition servletDefinition)

startServletWithTimeout

protected java.lang.Integer startServletWithTimeout(ServletDefinition servletDefinition)

buildProperties

protected java.util.List<java.lang.String> buildProperties()

getJavaPath

protected java.lang.String getJavaPath()

getAbsolutePath

protected java.lang.String getAbsolutePath(java.lang.String path)
                                    throws java.lang.Exception

The method constructs absolute path. Default implementation takes path as a path, relative to location of the IntegrationServletContainer class itself.

Returns:

absolute path to file

Throws:

java.io.FileNotFoundException - if given file does not exist

java.lang.Exception

getConnectionPath

public java.lang.String getConnectionPath()

getWarPath

public java.lang.String getWarPath()

getProperties

public java.util.Properties getProperties()

getLogFilePath

public java.lang.String getLogFilePath()

getHeartbeat

public java.lang.String getHeartbeat()

getServerProcess

public java.lang.Process getServerProcess()

getWebappRunnerJarFile

public java.lang.String getWebappRunnerJarFile()

setWebappRunnerJarFile

public void setWebappRunnerJarFile(java.lang.String webappRunnerJarFile)

Sets the webappRunner jar file. For instance: bin/jetty-runner.jar

Parameters:

webappRunnerJarFile - The jar file name and location.

setProperties

public void setProperties(java.util.Properties properties)

Parameters:

properties - properties to pass to servlet

setLogFilePath

public void setLogFilePath(java.lang.String path)

File where to store server console output. Absolute or relative to platform path.

Directory provided must exist. If the file exists, log info will be appended. If there is no such file, it will be created. No log rotation.

Default value is ../../log/atddrunner.log

Parameters:

path - path to log file

setHeartbeat

public void setHeartbeat(java.lang.String path)

Path to resource, which can indicate the servlet is alive.

Parameters:

path - absolute path to heartbeat resource

setConnectionPath

public void setConnectionPath(java.lang.String connectionPath)

Parameters:

connectionPath - servlet end point URI

setWarPath

public void setWarPath(java.lang.String warPath)

Path to servlet file. Can be absolute or relative to directory that contains this class

Parameters:

warPath - path to servlet file

setJettyConfigPath

public void setJettyConfigPath(java.lang.String jettyConfigPath)

Path to jetty config file. Can be absolute or relative to directory that contains this class

Parameters:

jettyConfigPath - path to custom jetty config file

setLibPath

public void setLibPath(java.lang.String libPath)

Path to jetty lib folder. Can be absolute or relative to directory that contains this class

Parameters:

libPath - path to jetty lib folder

setPort

public void setPort(java.lang.Integer port)

Port to run jetty. Default value is 8080.

Parameters:

port - the port number of the jetty instance.

setServlets

public void setServlets(java.util.List<ServletDefinition> servlets)

Servlet configurations to run. If you have some servlets to run on jetty you can use this method to set list of them. If warPath was configured (optionally with connectionPath) it also would be added to jetty as an extra ServletDefinition together with the list.

Parameters:

servlets - list of servlet configurations