Webserver Plugin Reference 22.0.x
The XL Deploy Web Server plugin supports the deployment of web content and web server configuration to a web server.
This document provides information that is specific to this version of the Web Server plugin. For general information about the plugin, refer to Introduction to the XL Deploy Web Server plugin.
Requirements
The Web Server plugin requires user credentials for accessing the web server executables on the host that runs the web.
Using the deployables and deployeds
Deployable vs. container table
The following table describes which deployable/container combinations are possible.
Deployable | Container | Generated deployed |
---|---|---|
www.WebContent | www.ApacheHttpdServer | www.PublishedWebContent |
www.ApacheVirtualHostSpec | www.ApacheHttpdServer | www.ApacheVirtualHost |
www.ApacheConfFragmentSpec | www.ApacheHttpdServer | www.ApacheConfFragment |
Deployed actions table
The following table describes the effect a deployed has on its container.
Deployed | Actions performed for operations | ||
---|---|---|---|
Create | Destroy | Modify | |
www.PublishedWebContent |
|
|
|
www.ApacheVirtualHost |
|
|
|
www.ApacheConfFragment |
|
|
|
CI Reference
Configuration Item Overview
Deployables
CI | Description |
---|---|
www.ApacheConfFile | Apache configuration file |
www.ApacheConfFragmentSpec | Specification for an Apache configuration fragment. |
www.ApacheProxyPassSpec | Description unavailable (deployable) |
www.ApacheVirtualHostSpec | Specification for an Apache virtual host |
www.WebContent | Folder containing web content (HTML pages, images, etc) |
Deployeds
CI | Description |
---|---|
www.ApacheConfFragment | Deployed generated Apache configuration file |
www.ApacheProxyPass | Description unavailable |
www.ApacheVirtualHost | Apache virtual host |
www.DeployedApacheConfFile | Deployed Apache configuration file |
www.PublishedWebContent | Web content on the webserver |
Containers
CI | Description |
---|---|
www.ApacheHttpdServer | Apache HTTPD web server |
Configuration Item Details
www.ApacheConfFile
Type Hierarchy | generic.File >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable |
Apache configuration file
Public properties | ||
---|---|---|
|
|
checksum: STRING
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
credentials:
CI<credentials.Credentials>
|
Credentials of the URI.
|
||
|
|
excludeFileNamesRegex: STRING
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
|
A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
|
||
|
|
fileUri: STRING
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
isRescanned: BOOLEAN
|
Indicates if the artifact has been rescanned
|
||
|
|
placeholders: SET_OF_STRING
|
Placeholders detected in this artifact
|
||
|
|
preScannedPlaceholders: BOOLEAN
|
Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
|
||
|
|
proxySettings:
CI<credentials.ProxySettings>
|
Proxy Settings for artifact location
|
||
|
|
scanPlaceholders: BOOLEAN = true
|
Whether to scan this artifact to replace placeholders when it is imported
|
||
|
|
tags: SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
Hidden properties | ||
---|---|---|
|
|
textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|
Regular expression that matches file names of text files
|
||
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
The set of CI templates.
|
||
|
|
delimiters: STRING = {{ }}
|
The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|
www.ApacheConfFragment
Type Hierarchy | generic.ProcessedTemplate >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployed, udm.EmbeddedDeployedContainer |
Deployed generated Apache configuration file
Parent | ||
---|---|---|
|
|
container:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public properties | ||
---|---|---|
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
Hidden properties | ||
---|---|---|
|
|
createOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
createOrder: INTEGER = 50
|
The order of the step in the step list for the create operation.
|
||
|
|
createVerb: STRING = Deploy
|
Create Verb
|
||
|
|
destroyOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
destroyOrder: INTEGER = 40
|
The order of the step in the step list for the destroy operation.
|
||
|
|
destroyVerb: STRING = Remove
|
Destroy Verb
|
||
|
|
modifyOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
modifyOrder: INTEGER = 50
|
The order of the step in the step list for the modify operation.
|
||
|
|
modifyVerb: STRING = Modify
|
Modify Verb
|
||
|
|
noopOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
noopOrder: INTEGER = 50
|
The order of the step in the step list for the noop operation.
|
||
|
|
noopVerb: STRING = Modify
|
Noop Verb
|
||
|
|
targetDirectory: STRING = ${deployed.container.configurationFragmentDirectory}
|
Target directory name
|
||
|
|
targetFile: STRING = ${deployed.name}.conf
|
Target file name
|
||
|
|
template: STRING = www/apache/${deployed.type}.conf.ftl
|
Configuration fragment template file name.
|
||
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
||
|
|
createTargetDirectory: BOOLEAN
|
Create the target directory on the generic server if it does not exist.
|
||
|
|
inspectClasspathResources: SET_OF_STRING
|
Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
|
||
|
|
inspectScript: STRING
|
Classpath to the script used to inspect the generic container.
|
||
|
|
inspectTemplateClasspathResources: SET_OF_STRING
|
Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
|
||
|
|
restartRequired: BOOLEAN = true
|
The generic container requires a restart for the action performed by this deployed.
|
||
|
|
restartRequiredForNoop: BOOLEAN
|
The generic container requires a restart for the NOOP action performed by this deployed.
|
||
|
|
targetDirectoryShared: BOOLEAN = true
|
Is the target directory shared by others on the generic server. When true, the target directory is not deleted during a destroy operation; only the artifacts copied to it.
|
www.ApacheConfFragmentSpec
Type Hierarchy | generic.Resource >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployable, udm.Taggable |
Specification for an Apache configuration fragment.
Public properties | ||
---|---|---|
|
|
tags: SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
Hidden properties | ||
---|---|---|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
The set of CI templates.
|
www.ApacheHttpdServer
Type Hierarchy | generic.Container >> generic.BaseGenericContainer >> udm.BaseContainer >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Container, generic.GenericContainer, overthere.HostContainer, udm.Taggable |
Apache HTTPD web server
Parent | ||
---|---|---|
|
|
host:
CI<overthere.Host>
|
Host upon which the container resides
|
Public properties | ||
---|---|---|
|
|
configurationFragmentDirectory: STRING
|
The directory into which Apache configuration files (for virtual host definitions) should be written
|
||
|
|
defaultDocumentRoot: STRING
|
The directory in which document roots for virtual hosts should be created. Web content deployed without a virtual host will also be copied into this directory
|
||
|
|
restartWaitTime: INTEGER = 10
|
Duration (in secs) to wait after the restart server step has been executed
|
||
|
|
startCommand: STRING
|
The command to start Apache. Arguments containing spaces are not supported
|
||
|
|
startWaitTime: INTEGER = 10
|
Duration (in secs) to wait after the start server step has been executed
|
||
|
|
stopCommand: STRING
|
The command to stop Apache. Arguments containing spaces are not supported
|
||
|
|
stopWaitTime: INTEGER = 10
|
Duration (in secs) to wait after the stop server step has been executed
|
||
|
|
envVars: MAP_STRING_STRING
|
Environment variables for container
|
||
|
|
restartCommand: STRING
|
The command to restart Apache. If left blank, reload command is used. If reload command is also blank than the sequence 'stop, start' is used. Arguments containing spaces are not supported
|
||
|
|
stopStartRestartConnection:
CI<overthere.Host>
|
If set, the connection settings to use to connect to the target system to execute start, stop, restart etc. operations for the container.
|
||
|
|
tags: SET_OF_STRING
|
If set, only deployables with the same tag will be automatically mapped to this container.
|
Hidden properties | ||
---|---|---|
|
|
restartOrder: INTEGER = 90
|
The order of the restart container step in the step list.
|
||
|
|
restartScript: STRING = <#assign restart=(container.restartCommand)!''><#if restart != ''>www/apache/restart<#else>www/apache/stopstart#if>
|
The command to restart or reload Apache. If left blank, the sequence 'stop, start' is used. Arguments containing spaces are not supported
|
||
|
|
startOrder: INTEGER = 90
|
The order of the start container step in the step list.
|
||
|
|
startScript: STRING = www/apache/start
|
The command to start Apache. Arguments containing spaces are not supported
|
||
|
|
stopOrder: INTEGER = 10
|
The order of the stop container step in the step list.
|
||
|
|
stopScript: STRING = www/apache/stop
|
The command to stop Apache. Arguments containing spaces are not supported
|
||
|
|
inspectClasspathResources: SET_OF_STRING
|
Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
|
||
|
|
inspectScript: STRING
|
Classpath to the script used to inspect the generic container.
|
||
|
|
inspectTemplateClasspathResources: SET_OF_STRING
|
Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
|
||
|
|
restartClasspathResources: SET_OF_STRING
|
Additional classpath resources that should be uploaded to the working directory before executing the restart script.
|
||
|
|
restartTemplateClasspathResources: SET_OF_STRING
|
Additional template classpath resources that should be uploaded to the working directory before executing the restart script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
|
||
|
|
startClasspathResources: SET_OF_STRING
|
Additional classpath resources that should be uploaded to the working directory before executing the start script.
|
||
|
|
startTemplateClasspathResources: SET_OF_STRING
|
Additional template classpath resources that should be uploaded to the working directory before executing the start script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
|
||
|
|
stopClasspathResources: SET_OF_STRING
|
Additional classpath resources that should be uploaded to the working directory before executing the stop script.
|
||
|
|
stopTemplateClasspathResources: SET_OF_STRING
|
Additional template classpath resources that should be uploaded to the working directory before executing the stop script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
|
Control task | Parameter CI | Attributes | Description |
---|---|---|---|
restart |
Restart Apache |
||
start |
Start Apache |
||
stop |
Stop Apache |
www.ApacheProxyPass
Type Hierarchy | www.ApacheConfFragment >> generic.ProcessedTemplate >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployed, udm.EmbeddedDeployedContainer |
Description unavailable
Parent | ||
---|---|---|
|
|
container:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public properties | ||
---|---|---|
|
|
from: STRING
|
The path that needs to be proxied
|
||
|
|
to: STRING
|
The URL that the from path needs to be proxied to
|
||
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
options: STRING
|
The proxy parameters
|
||
|
|
reverse: BOOLEAN
|
Whether to set up a ProxyPassReverse also
|
Hidden properties | ||
---|---|---|
|
|
createOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
createOrder: INTEGER = 50
|
The order of the step in the step list for the create operation.
|
||
|
|
createVerb: STRING = Deploy
|
Create Verb
|
||
|
|
destroyOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
destroyOrder: INTEGER = 40
|
The order of the step in the step list for the destroy operation.
|
||
|
|
destroyVerb: STRING = Remove
|
Destroy Verb
|
||
|
|
modifyOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
modifyOrder: INTEGER = 50
|
The order of the step in the step list for the modify operation.
|
||
|
|
modifyVerb: STRING = Modify
|
Modify Verb
|
||
|
|
noopOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
noopOrder: INTEGER = 50
|
The order of the step in the step list for the noop operation.
|
||
|
|
noopVerb: STRING = Modify
|
Noop Verb
|
||
|
|
targetDirectory: STRING = ${deployed.container.configurationFragmentDirectory}
|
Target directory name
|
||
|
|
targetFile: STRING = ${deployed.name}.conf
|
Target file name
|
||
|
|
template: STRING = www/apache/${deployed.type}.conf.ftl
|
Configuration fragment template file name.
|
||
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
||
|
|
createTargetDirectory: BOOLEAN
|
Create the target directory on the generic server if it does not exist.
|
||
|
|
inspectClasspathResources: SET_OF_STRING
|
Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
|
||
|
|
inspectScript: STRING
|
Classpath to the script used to inspect the generic container.
|
||
|
|
inspectTemplateClasspathResources: SET_OF_STRING
|
Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
|
||
|
|
restartRequired: BOOLEAN = true
|
The generic container requires a restart for the action performed by this deployed.
|
||
|
|
restartRequiredForNoop: BOOLEAN
|
The generic container requires a restart for the NOOP action performed by this deployed.
|
||
|
|
targetDirectoryShared: BOOLEAN = true
|
Is the target directory shared by others on the generic server. When true, the target directory is not deleted during a destroy operation; only the artifacts copied to it.
|
www.ApacheProxyPassSpec
Type Hierarchy | www.ApacheConfFragmentSpec >> generic.Resource >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployable, udm.Taggable |
Description unavailable (deployable)
Public properties | ||
---|---|---|
|
|
from: STRING
|
The path that needs to be proxied (string)
|
||
|
|
options: STRING
|
The proxy parameters (string) default()
|
||
|
|
reverse: STRING
|
Whether to set up a ProxyPassReverse also (boolean) default(false)
|
||
|
|
tags: SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
to: STRING
|
The URL that the from path needs to be proxied to (string)
|
Hidden properties | ||
---|---|---|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
The set of CI templates.
|
www.ApacheVirtualHost
Type Hierarchy | www.ApacheConfFragment >> generic.ProcessedTemplate >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployed, udm.EmbeddedDeployedContainer |
Apache virtual host
Parent | ||
---|---|---|
|
|
container:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public properties | ||
---|---|---|
|
|
host: STRING
|
The virtual host name. Use '*' to match all hosts
|
||
|
|
port: STRING
|
The virtual host port. Use '*' to match all ports
|
||
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
documentRoot: STRING
|
The document root for web content using this virtual host. If left blank, a directory is created in the web server's document root
|
Hidden properties | ||
---|---|---|
|
|
createOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
createOrder: INTEGER = 50
|
The order of the step in the step list for the create operation.
|
||
|
|
createVerb: STRING = Deploy
|
Create Verb
|
||
|
|
destroyOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
destroyOrder: INTEGER = 40
|
The order of the step in the step list for the destroy operation.
|
||
|
|
destroyVerb: STRING = Remove
|
Destroy Verb
|
||
|
|
modifyOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
modifyOrder: INTEGER = 50
|
The order of the step in the step list for the modify operation.
|
||
|
|
modifyVerb: STRING = Modify
|
Modify Verb
|
||
|
|
noopOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
noopOrder: INTEGER = 50
|
The order of the step in the step list for the noop operation.
|
||
|
|
noopVerb: STRING = Modify
|
Noop Verb
|
||
|
|
targetDirectory: STRING = ${deployed.container.configurationFragmentDirectory}
|
Target directory name
|
||
|
|
targetFile: STRING = ${deployed.name}.conf
|
Target file name
|
||
|
|
template: STRING = www/apache/${deployed.type}.conf.ftl
|
Configuration fragment template file name.
|
||
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
||
|
|
createTargetDirectory: BOOLEAN
|
Create the target directory on the generic server if it does not exist.
|
||
|
|
inspectClasspathResources: SET_OF_STRING
|
Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
|
||
|
|
inspectScript: STRING
|
Classpath to the script used to inspect the generic container.
|
||
|
|
inspectTemplateClasspathResources: SET_OF_STRING
|
Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
|
||
|
|
restartRequired: BOOLEAN = true
|
The generic container requires a restart for the action performed by this deployed.
|
||
|
|
restartRequiredForNoop: BOOLEAN
|
The generic container requires a restart for the NOOP action performed by this deployed.
|
||
|
|
targetDirectoryShared: BOOLEAN = true
|
Is the target directory shared by others on the generic server. When true, the target directory is not deleted during a destroy operation; only the artifacts copied to it.
|
www.ApacheVirtualHostSpec
Type Hierarchy | www.ApacheConfFragmentSpec >> generic.Resource >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployable, udm.Taggable |
Specification for an Apache virtual host
Public properties | ||
---|---|---|
|
|
documentRoot: STRING
|
The document root for web content using this virtual host. If left blank, a directory is created in the web server's document root (string)
|
||
|
|
host: STRING
|
The virtual host name. Use '*' to match all hosts (string)
|
||
|
|
port: STRING
|
The virtual host port. Use '*' to match all ports (string)
|
||
|
|
tags: SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
Hidden properties | ||
---|---|---|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
The set of CI templates.
|
www.DeployedApacheConfFile
Type Hierarchy | generic.CopiedArtifact >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
Deployed Apache configuration file
Parent | ||
---|---|---|
|
|
container:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public properties | ||
---|---|---|
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
placeholders: MAP_STRING_STRING
|
A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
|
Hidden properties | ||
---|---|---|
|
|
createOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
createOrder: INTEGER = 50
|
The order of the step in the step list for the create operation.
|
||
|
|
createVerb: STRING = Deploy
|
Create Verb
|
||
|
|
destroyOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
destroyOrder: INTEGER = 40
|
The order of the step in the step list for the destroy operation.
|
||
|
|
destroyVerb: STRING = Remove
|
Destroy Verb
|
||
|
|
modifyOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
modifyOrder: INTEGER = 50
|
The order of the step in the step list for the modify operation.
|
||
|
|
modifyVerb: STRING = Modify
|
Modify Verb
|
||
|
|
noopOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
noopOrder: INTEGER = 50
|
The order of the step in the step list for the noop operation.
|
||
|
|
noopVerb: STRING = Modify
|
Noop Verb
|
||
|
|
targetDirectory: STRING = ${deployed.container.configurationFragmentDirectory}
|
Target directory name
|
||
|
|
targetFile: STRING = ${deployed.name}
|
Target file name
|
||
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
||
|
|
copyDirectlyToTargetPath: BOOLEAN
|
If set to true, files are directly copied to the target directory without first being uploaded to the staging or temporary directory (like versions of XL Deploy prior to 4.0.0)
|
||
|
|
createTargetDirectory: BOOLEAN
|
Create the target directory on the generic server if it does not exist.
|
||
|
|
inspectClasspathResources: SET_OF_STRING
|
Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
|
||
|
|
inspectScript: STRING
|
Classpath to the script used to inspect the generic container.
|
||
|
|
inspectTemplateClasspathResources: SET_OF_STRING
|
Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
|
||
|
|
preserveExistingFiles: BOOLEAN
|
If set to true, preserve the existing files on the remote host (do not delete the copied files during the destroy operation).
|
||
|
|
restartRequired: BOOLEAN = true
|
The generic container requires a restart for the action performed by this deployed.
|
||
|
|
restartRequiredForNoop: BOOLEAN
|
The generic container requires a restart for the NOOP action performed by this deployed.
|
||
|
|
targetDirectoryShared: BOOLEAN = true
|
Is the target directory shared by others on the generic server. When true, the target directory is not deleted during a destroy operation; only the artifacts copied to it.
|
||
|
|
targetPathSharedSubDirectories: BOOLEAN
|
If set to true, the sub directories on the target machine are not deleted if files other than that copied by XL Deploy are present. Please note that setting this option to true will cause the removal process to be a slower.
|
www.PublishedWebContent
Type Hierarchy | generic.CopiedArtifact >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
Web content on the webserver
Parent | ||
---|---|---|
|
|
container:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public properties | ||
---|---|---|
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
placeholders: MAP_STRING_STRING
|
A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
|
||
|
| |
Virtual host which this web content maps to.
|
Hidden properties | ||
---|---|---|
|
|
createOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
createOrder: INTEGER = 50
|
The order of the step in the step list for the create operation.
|
||
|
|
createVerb: STRING = Deploy
|
Create Verb
|
||
|
|
destroyOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
destroyOrder: INTEGER = 40
|
The order of the step in the step list for the destroy operation.
|
||
|
|
destroyVerb: STRING = Remove
|
Destroy Verb
|
||
|
|
modifyOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
modifyOrder: INTEGER = 50
|
The order of the step in the step list for the modify operation.
|
||
|
|
modifyVerb: STRING = Modify
|
Modify Verb
|
||
|
|
noopOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
noopOrder: INTEGER = 50
|
The order of the step in the step list for the noop operation.
|
||
|
|
noopVerb: STRING = Modify
|
Noop Verb
|
||
|
|
targetDirectory: STRING = <#assign target=(deployed.virtualHost.documentRoot)!''/><#if target != ''>${target}<#else>${deployed.container.defaultDocumentRoot}#if>
|
Target directory name
|
||
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
||
|
|
copyDirectlyToTargetPath: BOOLEAN
|
If set to true, files are directly copied to the target directory without first being uploaded to the staging or temporary directory (like versions of XL Deploy prior to 4.0.0)
|
||
|
|
createTargetDirectory: BOOLEAN
|
Create the target directory on the generic server if it does not exist.
|
||
|
|
inspectClasspathResources: SET_OF_STRING
|
Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
|
||
|
|
inspectScript: STRING
|
Classpath to the script used to inspect the generic container.
|
||
|
|
inspectTemplateClasspathResources: SET_OF_STRING
|
Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
|
||
|
|
preserveExistingFiles: BOOLEAN
|
If set to true, preserve the existing files on the remote host (do not delete the copied files during the destroy operation).
|
||
|
|
restartRequired: BOOLEAN
|
The generic container requires a restart for the action performed by this deployed.
|
||
|
|
restartRequiredForNoop: BOOLEAN
|
The generic container requires a restart for the NOOP action performed by this deployed.
|
||
|
|
targetDirectoryShared: BOOLEAN = true
|
Is the target directory shared by others on the generic server. When true, the target directory is not deleted during a destroy operation; only the artifacts copied to it.
|
||
|
|
targetFile: STRING
|
Name of the artifact on the generic server.
|
||
|
|
targetPathSharedSubDirectories: BOOLEAN
|
If set to true, the sub directories on the target machine are not deleted if files other than that copied by XL Deploy are present. Please note that setting this option to true will cause the removal process to be a slower.
|
www.WebContent
Type Hierarchy | generic.Folder >> udm.BaseDeployableFolderArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FolderArtifact, udm.SourceArtifact, udm.Taggable |
Folder containing web content (HTML pages, images, etc)
Public properties | ||
---|---|---|
|
|
checksum: STRING
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
credentials:
CI<credentials.Credentials>
|
Credentials of the URI.
|
||
|
|
excludeFileNamesRegex: STRING
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
|
A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
|
||
|
|
fileUri: STRING
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
isRescanned: BOOLEAN
|
Indicates if the artifact has been rescanned
|
||
|
|
placeholders: SET_OF_STRING
|
Placeholders detected in this artifact
|
||
|
|
preScannedPlaceholders: BOOLEAN
|
Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
|
||
|
|
proxySettings:
CI<credentials.ProxySettings>
|
Proxy Settings for artifact location
|
||
|
|
scanPlaceholders: BOOLEAN = true
|
Whether to scan this artifact to replace placeholders when it is imported
|
||
|
|
tags: SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
Hidden properties | ||
---|---|---|
|
|
textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|
Regular expression that matches file names of text files
|
||
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
The set of CI templates.
|
||
|
|
delimiters: STRING = {{ }}
|
The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|