de.espirit.firstspirit.module

Interface WebServer

All Superinterfaces:

Component<WebServerDescriptor,ServerEnvironment>

public interface WebServer
extends Component<WebServerDescriptor,ServerEnvironment>

Since:

4.1

Method Summary

Methods

Modifier and Type	Method and Description
void	deploy(String webAppName, String contextName, String targetPath, String warFilePath) Deploys the specified war file to the configured web server
String	getURL() Returns the URL to this WebServer
String	getWebAppDir() Returns the path to the webapp directory of this WebServer
boolean	isDeployed(String webAppName, String contextName, String targetPath) Returns true if the contextName is deployed and false otherwise
boolean	isHidden() Returns if the Webserver is hidden (actually only the internal) if true, then its hidden in the web-server configuration...
boolean	supportsDeploy() Returns if the webserver supports deploy
boolean	supportsDeployState() Returns if the webserver supports deploy
boolean	supportsUndeploy() Returns if the webserver supports undeploy
void	undeploy(String webAppName, String contextName, String targetPath) Undeploys the specified context

Methods inherited from interface de.espirit.firstspirit.module.Component

init, installed, uninstalling, updated

Method Detail

deploy

void deploy(String webAppName,
          String contextName,
          String targetPath,
          @NotNull
          String warFilePath)

Deploys the specified war file to the configured web server

Parameters:

contextName - name of the target context

targetPath - relative target path to webapplication

webAppName - webapplication name

warFilePath - path to deployable war file

Since:

4.1

undeploy

void undeploy(String webAppName,
            String contextName,
            String targetPath)

Undeploys the specified context

Parameters:

contextName - name of the target context

targetPath - relative target path to webapplication

webAppName - webapplication name

Since:

4.1

isDeployed

boolean isDeployed(String webAppName,
                 String contextName,
                 String targetPath)

Returns true if the contextName is deployed and false otherwise

Parameters:

contextName - name of the target context

webAppName - webapplication name

targetPath - target path relative to web directory

Returns:

true if the contextName is deployed and false otherwise

Since:

4.1

supportsDeployState

boolean supportsDeployState()

Returns if the webserver supports deploy

Returns:

true, if deploy is supported, and false otherwise

Since:

4.1

supportsDeploy

boolean supportsDeploy()

Returns if the webserver supports deploy

Returns:

true, if deploy is supported, and false otherwise

Since:

4.1

supportsUndeploy

boolean supportsUndeploy()

Returns if the webserver supports undeploy

Returns:

true, if undeploy is supported, and false otherwise

Since:

4.1

isHidden

boolean isHidden()

Returns if the Webserver is hidden (actually only the internal) if true, then its hidden in the web-server configuration...

Returns:

Returns if the Webserver is hidden (actually only the internal)

Since:

4.1

getURL

String getURL()

Returns the URL to this WebServer

Returns:

URL to this WebServer

Since:

4.1

getWebAppDir

String getWebAppDir()

Returns the path to the webapp directory of this WebServer

Returns:

path to the webapp directory of this WebServer

Since:

4.1