public interface WebServer extends Component<WebServerDescriptor,ServerEnvironment>
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 |
getContextPath(String contextName,
String targetPath)
Returns the path to the directory of the specified web application relative to
getWebAppDir() . |
String |
getInternalURL()
Returns the internal URL to this web server
|
String |
getURL()
Returns the URL to this web server
|
String |
getWebAppDir()
Returns the path to the web application directory of this web server
|
boolean |
isDeployed(String webAppName,
String contextName,
String targetPath)
Returns true if the contextName is deployed and false otherwise.
|
boolean |
isHidden()
Returns if the web server is hidden (actually only the internal)
if true, then its hidden in the web-server configuration...
|
boolean |
supportsDeploy()
Returns if the web server supports deployment of web applications.
|
boolean |
supportsDeployState()
Returns if the web server supports querying the deployment state of web applications.
|
boolean |
supportsUndeploy()
Returns if the web server supports undeployment of web applications.
|
void |
undeploy(String webAppName,
String contextName,
String targetPath)
Undeploys the specified context
|
init, installed, uninstalling, updated
void deploy(@NotNull String webAppName, @NotNull String contextName, @NotNull String targetPath, @NotNull String warFilePath)
contextName
- name of the target context, e.g. "/fs5root"targetPath
- relative target path to the deployment directory in the file system, may be used as fallbackwebAppName
- unique name of the web application, e.g. "fs5root_global"warFilePath
- path to deployable war filevoid undeploy(@NotNull String webAppName, @NotNull String contextName, @NotNull String targetPath)
contextName
- name of the target context, e.g. "/fs5root"targetPath
- relative target path to the deployment directory in the file system, may be used as fallbackwebAppName
- unique name of the web application, e.g. "fs5root_global"boolean isDeployed(@NotNull String webAppName, @NotNull String contextName, @NotNull String targetPath)
supportsDeployState()
is false
), this method
returns always false
.contextName
- name of the target context, e.g. "/fs5root"webAppName
- unique name of the web application, e.g. "fs5root_global"targetPath
- relative target path to the deployment directory in the file system, may be used as fallbackboolean supportsDeployState()
boolean supportsDeploy()
boolean supportsUndeploy()
boolean isHidden()
String getURL()
@Nullable String getInternalURL()
null
if not configured.@NotNull String getWebAppDir()
null
.@NotNull String getContextPath(String contextName, String targetPath)
getWebAppDir()
.
The returned path might differ from the specified target path.
For contextName "/"
the return value may be "ROOT"
instead of targetPath
contextName
- name of the target context, e.g. "/fs5root"targetPath
- relative target path to the deployment directory in the file system, may be used as fallbackCopyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210