JEE Plugin Reference 9.5.x

The XL Deploy JEE plugin provides support for Java EE archives such as EAR files and WAR files, as well as specifications for resources such as JNDI and mail session resources.

This document provides information that is specific to this version of the JEE plugin. For general information about the plugin, refer to Introduction to the XL Deploy JEE plugin.

CI Reference

Configuration Item Overview

Deployables

CIDescription
jee.DataSourceSpec Deployable Java EE DataSource accessible via JNDI.
jee.Ear Deployable EAR artifact.
jee.EjbJar Deployable EJB JAR artifact.
jee.JndiResourceSpec Deployable Java EE Resource accessible via JNDI.
jee.MailSessionSpec Deployable Java EE Mail Session accessible via JNDI.
jee.QueueConnectionFactorySpec Deployable Java EE JMS QueueConnectionFactory accessible via JNDI.
jee.QueueSpec Deployable Java EE JMS Queue accessible via JNDI.
jee.ResourceSpec Description unavailable
jee.TopicConnectionFactorySpec Deployable Java EE JMS TopicConnectionFactory accessible via JNDI.
jee.TopicSpec Deployable Jave EE JMS Topic accessible via JNDI.
jee.War Deployable WAR artifact.

Configuration Item Details

jee.DataSourceSpec

Type Hierarchy jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces udm.Deployable, udm.Taggable

Deployable Java EE DataSource accessible via JNDI.

  Public properties
 
 
jndiName: STRING
Name used to lookup this resource in JNDI
 
 
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.

jee.Ear

Type Hierarchy udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces udm.ArchiveArtifact, udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable

Deployable EAR artifact.

  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
 
 
fileUri: STRING
The URI pointing to the (remote) location of the file this artifact represents
 
 
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
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
 
 
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

jee.EjbJar

Type Hierarchy udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces udm.ArchiveArtifact, udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable

Deployable EJB JAR artifact.

  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
 
 
fileUri: STRING
The URI pointing to the (remote) location of the file this artifact represents
 
 
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
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
 
 
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

jee.JndiResourceSpec

Virtual Type
Type Hierarchy jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces udm.Deployable, udm.Taggable

Deployable Java EE Resource accessible via JNDI.

  Public properties
 
 
jndiName: STRING
Name used to lookup this resource in JNDI
 
 
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.

jee.MailSessionSpec

Type Hierarchy jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces udm.Deployable, udm.Taggable

Deployable Java EE Mail Session accessible via JNDI.

  Public properties
 
 
jndiName: STRING
Name used to lookup this resource in JNDI
 
 
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.

jee.QueueConnectionFactorySpec

Type Hierarchy jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces udm.Deployable, udm.Taggable

Deployable Java EE JMS QueueConnectionFactory accessible via JNDI.

  Public properties
 
 
jndiName: STRING
Name used to lookup this resource in JNDI
 
 
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.

jee.QueueSpec

Type Hierarchy jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces udm.Deployable, udm.Taggable

Deployable Java EE JMS Queue accessible via JNDI.

  Public properties
 
 
jndiName: STRING
Name used to lookup this resource in JNDI
 
 
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.

jee.ResourceSpec

Virtual Type
Type Hierarchy udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces udm.Deployable, udm.Taggable

Description unavailable

  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.

jee.TopicConnectionFactorySpec

Type Hierarchy jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces udm.Deployable, udm.Taggable

Deployable Java EE JMS TopicConnectionFactory accessible via JNDI.

  Public properties
 
 
jndiName: STRING
Name used to lookup this resource in JNDI
 
 
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.

jee.TopicSpec

Type Hierarchy jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces udm.Deployable, udm.Taggable

Deployable Jave EE JMS Topic accessible via JNDI.

  Public properties
 
 
jndiName: STRING
Name used to lookup this resource in JNDI
 
 
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.

jee.War

Type Hierarchy udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces udm.ArchiveArtifact, udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable

Deployable WAR artifact.

  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
 
 
fileUri: STRING
The URI pointing to the (remote) location of the file this artifact represents
 
 
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
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
 
 
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