Weblogic Plugin Reference
The XL Deploy Oracle WebLogic server (WLS) plugin allows you to manage deployments and resources on a WebLogic server.
This document provides information that is specific to this version of the WebLogic plugin. For general information about the plugin, refer to Introduction to the XL Deploy WebLogic plugin.
Requirements
- XL Deploy 5.5.0 or later
- WebLogic 9.x, 10.3, 11g, or 12c (Unix and Microsoft Windows)
- WebLogic Domain user credentials
- User credentials for accessing the host running the WebLogic Administration Server
- User credentials for accessing the target hosts of managed servers (for NoStage mode)
Using the deployables and deployeds
The following table describes which deployable/container combinations are possible and which deployeds they generate.
| Deployable | Container | Generated deployed |
|---|---|---|
| wls.ConnectionFactorySpec | wls.Cluster wls.Server wls.JmsServer |
wls.ConnectionFactory |
| wls.DataSourceSpec | wls.Cluster wls.Server |
wls.DataSource |
| wls.Ear | wls.Cluster wls.Server |
wls.EarModule wls.WarModule wls.EjbJarModule |
| wls.EjbJar | wls.Cluster wls.Server |
wls.EarModule wls.WarModule wls.EjbJarModule |
| wls.File | wls.Cluster wls.Server |
wls.DeployedFile |
| wls.FilePersistentStoreSpec | wls.Server | wls.FilePersistentStore |
| wls.Folder | wls.Cluster wls.Server |
wls.DeployedFolder |
| wls.JmsFilePersistentStoreSpec | wls.JmsServer | wls.JmsFilePersistentStore |
| wls.JmsJdbcPersistentStoreSpec | wls.JmsServer | wls.JmsJdbcPersistentStore |
| wls.JmsPersistentStoreSpec | wls.JmsServer | wls.JmsPersistentStore |
| wls.MailSessionSpec | wls.Cluster wls.Server |
wls.MailSession |
| wls.PersistentStoreSpec | wls.Server | wls.PersistentStore |
| wls.QueueSpec | wls.JmsServer | wls.Queue |
| wls.SharedLibraryWar | wls.Cluster wls.Server |
wls.SharedLibraryWarModule |
| wls.SharedLibraryJar | wls.Cluster wls.Server |
wls.SharedLibraryJarModule |
| wls.TopicSpec | wls.JmsServer | wls.Topic |
| wls.UniformDistributedQueueSpec | wls.Cluster wls.Server wls.JmsServer |
wls.UniformDistributedQueue |
| wls.UniformDistributedTopicSpec | wls.Cluster wls.Server wls.JmsServer |
wls.UniformDistributedTopic |
| wls.War | wls.Cluster wls.Server |
wls.EarModule wls.WarModule wls.EjbJarModule |
Deployed Actions Table
The following table describes the effect a deployed has on its container.
| Deployed | Actions performed for operations | ||
|---|---|---|---|
| Create | Destroy | Modify | |
| wls.EarModule wls.WarModule wls.EjbJarModule |
|
|
|
| wls.SharedLibraryWarModule |
|
|
|
| wls.SharedLibraryJarModule |
|
|
|
| wls.DataSource |
|
|
|
| wls.Queue |
|
|
|
| wls.Topic |
|
|
|
| wls.UniformDistributedQueue |
|
|
|
| wls.UniformDistributedTopic |
|
|
|
| wls.ConnectionFactory |
|
|
|
| wls.MailSession |
|
|
|
| wls.FilePersistentStore |
|
|
|
| wls.JmsFilePersistentStore |
|
|
|
| wls.JmsJdbcPersistentStore |
|
|
|
| wls.DeployedFile |
|
|
|
| wls.DeployedFolder |
|
|
|
Release Notes - WLS Plugin
Version 6.0.1
Bug fixes
- DEPL-11354 - When using WLS plugin, WAR file is not deleted from temporary directory after preview if deployment is cancelled
- DEPL-11127 - Support automatic retirement of versioned applications
Version 6.0.0
Compatible with XL Deploy 6.0.0.
Version 5.5.0
Compatible with XL Deploy 5.5.0.
Bug fixes
- [DEPL-9478] - WebLogic control tasks do not work with satellites
Version 5.1.0
Bug fixes
- [DEPL-8415] - Fixed issue that reset the redeploy strategy when updating an EAR deployment
- [DEPL-8383] - Fixed the issue that displayed the password to WLST in cleartext
Improvements
- [DEPL-8407] - Support configurable version properties when deploying a versioned application
Deprecations
- [DEPL-9047] - Deprecate support for WebLogic 9 and 10.0
Version 5.0.1
Support for WLS 9.x will be deprecated in XL Deploy 5.1.0 and removed in XL Deploy 5.5.0.
Bug fixes
- [DEPL-8415] - Fixed issue that reset the redeploy strategy when updating an EAR deployment
- [DEPL-8383] - Fixed the issue that displayed the password to WLST in cleartext
Improvements
- [DEPL-8407] - Support configurable version properties when deploying a versioned application
Version 5.0.0
Compatible with XL Deploy 5.0.
Version 4.5.2
Bug fixes
- [DEPL-8383] - Fixed the issue that displayed the password to WLST in cleartext
Improvements
- [DEPL-8407] - Support configurable version properties when deploying a versioned application
Version 4.5.1
Bug fixes
- [DEPL-3532] - Cannot create a WebLogic Datasource with the 'properties' field set
- [DEPL-7791] - Make start/stop steps in wls-plugin idempotent
- [DEPL-5903] - Upgrading a wls.Ear resets the Retire Timeout to -1
- [DEPL-7337] - Delete artifact step has wrong order with side-by-side undeployment
- [DEPL-7339] - Updating package containing sharelib and Ear/War module generates invalid plan
- [DEPL-7338] - Side-by-side update with shared lib in package and NoStage generates error
Improvements
- [DEPL-7265] - Support deploying to managed servers in parallel
- [DEPL-4529] - Support configuration of exposing deployed CIs during deployment
- [DEPL-4270] - Add label, descriptions and categories to all types and properties in wls-plugin
- [DEPL-4878] - Make WLS application activation timeout configurable
- [DEPL-4692] - Support Weblogic Deployment Plan
- [DEPL-7885] - Support multi target deployment on Clusters
Version 4.5.0
Changes
- [DEPL-6274] - Added python step primitive for the wls plugin
Bug fixes
- [DEPL-6182] - WLS discovery fails on JmsServer with migratable target
- [DEPL-6274] - Handle case when deployed.file is None during application deployment.
Version 4.0.0
Changes
Updated to use newer versions of dependencies.
Improvements
- [DEPL-5314] - Update WLS plugin documentation with manifest.xml example
Version 3.9.2
Bug fixes
- [DEPLOYITPB-4924] - Tags on wls.JmsServer don't have any effect
- [DEPLOYITPB-4958] - WLS discovery should either discover weblogic version or make version an inspectionProperty
Version 3.9.1
Improvements
- [DEPLOYITPB-4814] - Allow user to specify an explicit hostname to use when connection to the WLS admin server
- [DEPLOYITPB-4815] - Add ability to generate wlst from a template
Version 3.9.0
Improvements
- [DEPLOYITPB-4404] - Support upgrading shared libraries
- [DEPLOYITPB-4588] - Add a property to control if the extensibleArtifact needs to have start & stop steps generated
Documentation update
- [DEPLOYITPB-3772] - Update documentation to include WLS 12c support
Version 3.8.1
Improvements
- [DEPLOYITPB-4000] - Wls.Domain implements wls.WlsContainer
Bug fixes
- [DEPLOYITPB-3891] - WebLogic plugin does not set the 'versionIdentifier' property if the archive's manifest cannot be read
- [DEPLOYITPB-3909] - Add new option on wls.Resource: STOP_START
- [DEPLOYITPB-4074] - wls.Domain exposes password in logging
- [DEPLOYITPB-4107] - When wls.Deployed have a property telling to stop & start the wls.Target: Stop and Start Step are always triggered
Version 3.8.0
Improvements
- [DEPLOYITPB-3605] - Allow user to configure non-standard location of wlst.sh
Bug fixes
- [DEPLOYITPB-2146] - Upgrading an application on two cluster for a versioned side_by_side deployment doesn't work, since deploying to two clusters can't work in 2 steps
- [DEPLOYITPB-3401] - Cannot start WebLogic cluster
- [DEPLOYITPB-3607] - WebLogic plugin does not allow specifying of different connection protocol
- [DEPLOYITPB-3739] - Discovery of emty wls.Cluster fails
Version 3.7.1
Improvements
- [DEPLOYITPB-2977] - Make the orders (START_CONTAINERS, STOP_CONTAINERS...) configurable throught synthetic.xml
- [DEPLOYITPB-3419] - StartWlsServerWithScriptStep default template includes a test procedure ensuring the server is really started
- [DEPLOYITPB-3522] - deploy files and folders to wlsContainer
- [DEPLOYITPB-3523] - Allowing to restart target after deploying a resource to a wlscontainer or copying files
Bug fixes
- [DEPLOYITPB-3371] - WebLogic discovery fails if there are no JMSServers
- [DEPLOYITPB-3409] - StartApplication does not control the status of the operation
- [DEPLOYITPB-3410] - StartWlsServerWithScriptStep should be implemented using a template, allowing to set easily environment variable or other stuff
- [DEPLOYITPB-3418] - Stop Target template script miss the exit
Version 3.7.0
Bug fixes
- [DEPLOYITPB-3185] - Output sent to stderr is sometimes lost when running with the Python daemon
- [DEPLOYITPB-3186] - Spurious "None" printed when an exception is thrown by a script running in the Python daemon
Version 3.7.0-beta-1
Improvements
- [DEPLOYITPB-3004] - Avoid artifact upload in steps that don't need them
Bug fixes
- [DEPLOYITPB-2946] - the artifact is versioned without a version identifier set.
Version 3.6.0
Bug fixes
- [DEPLOYITPB-2189] - Property "properties" on wls.DataSource is a STRING instead of MAP_STRING_STRING
- [DEPLOYITPB-2211] - When an error is encountered, the weblogic session remains open
- [DEPLOYITPB-2702] - 11g itest for creating connection factory fails
CI Reference
Configuration Item Overview
Deployables
| CI | Description |
|---|---|
| wls.ConnectionFactorySpec | Specification for a JMS connection factory |
| wls.DataSourceSpec | Specification for a datasource |
| wls.DeploymentPlan | Deployment plan XML file that is deployed to the WLS AdminServer host |
| wls.Ear | A JEE EAR archive |
| wls.EjbJar | A JEE EJB archive |
| wls.File | File that is deployed to the server lib directory |
| wls.FilePersistentStoreSpec | A file-based persistent store |
| wls.Folder | Folder that is deployed to the server lib directory |
| wls.JmsFilePersistentStoreSpec | A file-based persistent store for JMS messages |
| wls.JmsJdbcPersistentStoreSpec | A database backed persistent store for JMS messages |
| wls.JmsPersistentStoreSpec | A persistent store for JMS messages |
| wls.JmsResourceSpec | Base deployable type for all JMS related resources |
| wls.MailSessionSpec | Specification for a mail session |
| wls.PersistentStoreSpec | The persistent store supports persistence to a file-based store or to a JDBC-enabled database |
| wls.QueueSpec | Specification for a JMS Queue |
| wls.ResourceSpec | Base deployable of all Resources |
| wls.SharedLibraryJar | A JEE Jar library archive |
| wls.SharedLibraryWar | A JEE War library archive |
| wls.TopicSpec | Specification for a JMS Topic |
| wls.UniformDistributedQueueSpec | Specification for a JMS uniform distributed queue |
| wls.UniformDistributedTopicSpec | Specification for a JMS uniform distributed topic |
| wls.War | A JEE WAR archive |
Deployeds
| CI | Description |
|---|---|
| wls.AbstractQueue | Description unavailable |
| wls.AbstractTopic | Description unavailable |
| wls.AbstractUniformDistributedQueue | Description unavailable |
| wls.AbstractUniformDistributedTopic | Description unavailable |
| wls.BaseWlsDeployed | Base deployed of all WLS deployeds |
| wls.ConnectionFactory | A connection factory defines a set of connection configuration parameters that are used to create connections for JMS clients |
| wls.CopiedArtifact | Base class for all deployeds meant to contain Applications |
| wls.CopiedDeploymentPlan | Deployment plan XML file that is deployed to the WLS AdminServer host |
| wls.DataSource | An object bound to the JNDI tree that provides database connectivity through a pool of JDBC connections |
| wls.DeployedFile | Deployed configuration File |
| wls.DeployedFolder | Deployed configuration Folder |
| wls.EarModule | Ear with values configured for a deployment |
| wls.EjbJarModule | EJB with values configured for a deployment |
| wls.ExtensibleDeployedArtifact | Base class for all deployeds meant to contain Applications |
| wls.ExtensibleDeployedSharedLibrary | Base class for all shared library deployeds |
| wls.FilePersistentStore | A file-based persistent store |
| wls.JmsDestination | Base class for all JMS destinations, which can have a error destination property defined on them |
| wls.JmsFilePersistentStore | A file-based persistent store for JMS messages |
| wls.JmsJdbcPersistentStore | A database backed persistent store for JMS messages |
| wls.JmsPersistentStore | A persistent store for JMS messages |
| wls.JmsResource | Base deployed type for all JMS related resources |
| wls.MailSession | Mail sessions facilitate the process of using the JavaMail APIs, which provide applications and other J2EE modules with access to Internet Message Access Protocol (IMAP)- and Simple Mail Transfer Protocol (SMTP)-capable mail servers on your network or the Internet |
| wls.PersistentStore | The persistent store supports persistence to a file-based store or to a JDBC-enabled database |
| wls.Queue | A JMS Queue Defines a point-to-point destination type, which are used for asynchronous peer communications |
| wls.Resource | Base deployed of all Resources |
| wls.SharedLibraryJarModule | The Java EE library feature provides an easy way to share one or more types of Java EE modules among multiple Enterprise Applications |
| wls.SharedLibraryWarModule | The Java EE library feature provides an easy way to share one or more types of Java EE modules among multiple Enterprise Applications |
| wls.Topic | A JMS Topic Defines a topic destination type, which are used for asynchronous peer communications |
| wls.UniformDistributedQueue | A distributed Queue defines a set of queues that are distributed on multiple JMS servers, but which are accessible as a single, logical queue to JMS clients |
| wls.UniformDistributedTopic | A distributed Queue defines a set of topics that are distributed on multiple JMS servers, but which are accessible as a single, logical topic to JMS clients |
| wls.WarModule | War with values configured for a deployment |
Containers
| CI | Description |
|---|---|
| wls.Cluster | WebLogic Cluster which defines groups of WebLogic servers that work together to increase scalability and reliability |
| wls.Domain | WebLogic Domain which is a collection of WebLogic Server instances that is managed by a single Administration Server |
| wls.JmsServer | WebLogic JMS server, that act as management containers for the queues and topics in JMS modules that are targeted to them |
| wls.Server | WebLogic Server that runs in its own Java Virtual Machine (JVM) and has its own configuration |
Other Configuration Items
| CI | Description |
|---|---|
| wls.AbstractQueue | Description unavailable |
| wls.AbstractTopic | Description unavailable |
| wls.AbstractUniformDistributedQueue | Description unavailable |
| wls.AbstractUniformDistributedTopic | Description unavailable |
| wls.BaseWlsDeployed | Base deployed of all WLS deployeds |
| wls.Cluster | WebLogic Cluster which defines groups of WebLogic servers that work together to increase scalability and reliability |
| wls.ConnectionFactory | A connection factory defines a set of connection configuration parameters that are used to create connections for JMS clients |
| wls.ConnectionFactorySpec | Specification for a JMS connection factory |
| wls.CopiedArtifact | Base class for all deployeds meant to contain Applications |
| wls.CopiedDeploymentPlan | Deployment plan XML file that is deployed to the WLS AdminServer host |
| wls.DataSource | An object bound to the JNDI tree that provides database connectivity through a pool of JDBC connections |
| wls.DataSourceSpec | Specification for a datasource |
| wls.DeployedFile | Deployed configuration File |
| wls.DeployedFolder | Deployed configuration Folder |
| wls.DeploymentPlan | Deployment plan XML file that is deployed to the WLS AdminServer host |
| wls.Domain | WebLogic Domain which is a collection of WebLogic Server instances that is managed by a single Administration Server |
| wls.Ear | A JEE EAR archive |
| wls.EarModule | Ear with values configured for a deployment |
| wls.EjbJar | A JEE EJB archive |
| wls.EjbJarModule | EJB with values configured for a deployment |
| wls.ExtensibleDeployedArtifact | Base class for all deployeds meant to contain Applications |
| wls.ExtensibleDeployedSharedLibrary | Base class for all shared library deployeds |
| wls.File | File that is deployed to the server lib directory |
| wls.FilePersistentStore | A file-based persistent store |
| wls.FilePersistentStoreSpec | A file-based persistent store |
| wls.Folder | Folder that is deployed to the server lib directory |
| wls.JmsDestination | Base class for all JMS destinations, which can have a error destination property defined on them |
| wls.JmsFilePersistentStore | A file-based persistent store for JMS messages |
| wls.JmsFilePersistentStoreSpec | A file-based persistent store for JMS messages |
| wls.JmsJdbcPersistentStore | A database backed persistent store for JMS messages |
| wls.JmsJdbcPersistentStoreSpec | A database backed persistent store for JMS messages |
| wls.JmsPersistentStore | A persistent store for JMS messages |
| wls.JmsPersistentStoreSpec | A persistent store for JMS messages |
| wls.JmsResource | Base deployed type for all JMS related resources |
| wls.JmsResourceSpec | Base deployable type for all JMS related resources |
| wls.JmsServer | WebLogic JMS server, that act as management containers for the queues and topics in JMS modules that are targeted to them |
| wls.MailSession | Mail sessions facilitate the process of using the JavaMail APIs, which provide applications and other J2EE modules with access to Internet Message Access Protocol (IMAP)- and Simple Mail Transfer Protocol (SMTP)-capable mail servers on your network or the Internet |
| wls.MailSessionSpec | Specification for a mail session |
| wls.PersistentStore | The persistent store supports persistence to a file-based store or to a JDBC-enabled database |
| wls.PersistentStoreSpec | The persistent store supports persistence to a file-based store or to a JDBC-enabled database |
| wls.Queue | A JMS Queue Defines a point-to-point destination type, which are used for asynchronous peer communications |
| wls.QueueSpec | Specification for a JMS Queue |
| wls.Resource | Base deployed of all Resources |
| wls.ResourceSpec | Base deployable of all Resources |
| wls.Server | WebLogic Server that runs in its own Java Virtual Machine (JVM) and has its own configuration |
| wls.SharedLibraryJar | A JEE Jar library archive |
| wls.SharedLibraryJarModule | The Java EE library feature provides an easy way to share one or more types of Java EE modules among multiple Enterprise Applications |
| wls.SharedLibraryWar | A JEE War library archive |
| wls.SharedLibraryWarModule | The Java EE library feature provides an easy way to share one or more types of Java EE modules among multiple Enterprise Applications |
| wls.Topic | A JMS Topic Defines a topic destination type, which are used for asynchronous peer communications |
| wls.TopicSpec | Specification for a JMS Topic |
| wls.UniformDistributedQueue | A distributed Queue defines a set of queues that are distributed on multiple JMS servers, but which are accessible as a single, logical queue to JMS clients |
| wls.UniformDistributedQueueSpec | Specification for a JMS uniform distributed queue |
| wls.UniformDistributedTopic | A distributed Queue defines a set of topics that are distributed on multiple JMS servers, but which are accessible as a single, logical topic to JMS clients |
| wls.UniformDistributedTopicSpec | Specification for a JMS uniform distributed topic |
| wls.War | A JEE WAR archive |
| wls.WarModule | War with values configured for a deployment |
Configuration Item Details
wls.AbstractQueue
| Virtual Type | |
|---|---|
| Type Hierarchy | wls.JmsDestination >> wls.JmsResource >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
Description unavailable
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
jmsModuleName
:
STRING
|
|
Existing or new Jms system module which will be used to hold this resource
|
||
|
|
|
jndiName
:
STRING
|
|
Global JNDI name used to look up the destination within the JNDI namespace
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
|
|
Target error destination for messages that have expired or reached their redelivery limit
|
||
|
|
|
subDeploymentName
:
STRING
|
|
Subdeployment name, if null the deployment name is generated by Deployit using the following pattern, ${deployed.jmsModuleName}-subdeployment-for-${deployed.name}
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 60
|
|
Create Order
|
||
|
|
|
createVerb
:
STRING
= Create
|
|
Create Verb
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 40
|
|
Destroy Order
|
||
|
|
|
destroyVerb
:
STRING
= Destroy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 40
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
setErrorDestinationOrder
:
INTEGER
= 61
|
|
Set Error Destination Order
|
||
|
|
|
setErrorDestinationVerb
:
STRING
= Set error queue for
|
|
Set Error Destination Verb
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, jndiName, jmsModuleName, subDeploymentName, errorDestination, setErrorDestinationScript, setErrorDestinationVerb, setErrorDestinationOrder, unsetErrorDestinationVerb, unsetErrorDestinationOrder, unsetErrorDestinationScript, restartTarget, libraryScripts, discoverOrder, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
unsetErrorDestinationOrder
:
INTEGER
= 37
|
|
Unset Error Destination Order
|
||
|
|
|
unsetErrorDestinationVerb
:
STRING
= Unset error queue from =
|
|
Unset Error Destination Verb
|
||
|
|
|
createScript
:
STRING
|
|
Python script invoked to create this resource
|
||
|
|
|
destroyScript
:
STRING
|
|
Python script invoked to destroy this resource
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this resource
|
||
|
|
|
setErrorDestinationScript
:
STRING
|
|
Python script invoked to set error destination on this jms resource
|
||
|
|
|
unsetErrorDestinationScript
:
STRING
|
|
Python script invoked to unset error destination from this jms resource
|
wls.AbstractTopic
| Virtual Type | |
|---|---|
| Type Hierarchy | wls.JmsDestination >> wls.JmsResource >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
Description unavailable
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
jmsModuleName
:
STRING
|
|
Existing or new Jms system module which will be used to hold this resource
|
||
|
|
|
jndiName
:
STRING
|
|
Global JNDI name used to look up the destination within the JNDI namespace
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
|
|
Target error destination for messages that have expired or reached their redelivery limit
|
||
|
|
|
subDeploymentName
:
STRING
|
|
Subdeployment name, if null the deployment name is generated by Deployit using the following pattern, ${deployed.jmsModuleName}-subdeployment-for-${deployed.name}
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 60
|
|
Create Order
|
||
|
|
|
createVerb
:
STRING
= Create
|
|
Create Verb
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 40
|
|
Destroy Order
|
||
|
|
|
destroyVerb
:
STRING
= Destroy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 40
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
setErrorDestinationOrder
:
INTEGER
= 61
|
|
Set Error Destination Order
|
||
|
|
|
setErrorDestinationVerb
:
STRING
= Set error queue for
|
|
Set Error Destination Verb
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, jndiName, jmsModuleName, subDeploymentName, errorDestination, setErrorDestinationScript, setErrorDestinationVerb, setErrorDestinationOrder, unsetErrorDestinationVerb, unsetErrorDestinationOrder, unsetErrorDestinationScript, restartTarget, libraryScripts, discoverOrder, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
unsetErrorDestinationOrder
:
INTEGER
= 37
|
|
Unset Error Destination Order
|
||
|
|
|
unsetErrorDestinationVerb
:
STRING
= Unset error queue from =
|
|
Unset Error Destination Verb
|
||
|
|
|
createScript
:
STRING
|
|
Python script invoked to create this resource
|
||
|
|
|
destroyScript
:
STRING
|
|
Python script invoked to destroy this resource
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this resource
|
||
|
|
|
setErrorDestinationScript
:
STRING
|
|
Python script invoked to set error destination on this jms resource
|
||
|
|
|
unsetErrorDestinationScript
:
STRING
|
|
Python script invoked to unset error destination from this jms resource
|
wls.AbstractUniformDistributedQueue
| Virtual Type | |
|---|---|
| Type Hierarchy | wls.JmsDestination >> wls.JmsResource >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
Description unavailable
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
jmsModuleName
:
STRING
|
|
Existing or new Jms system module which will be used to hold this resource
|
||
|
|
|
jndiName
:
STRING
|
|
Global JNDI name used to look up the destination within the JNDI namespace
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
|
|
Target error destination for messages that have expired or reached their redelivery limit
|
||
|
|
|
subDeploymentName
:
STRING
|
|
Subdeployment name, if null the deployment name is generated by Deployit using the following pattern, ${deployed.jmsModuleName}-subdeployment-for-${deployed.name}
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 60
|
|
Create Order
|
||
|
|
|
createVerb
:
STRING
= Create
|
|
Create Verb
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 40
|
|
Destroy Order
|
||
|
|
|
destroyVerb
:
STRING
= Destroy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 40
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
setErrorDestinationOrder
:
INTEGER
= 61
|
|
Set Error Destination Order
|
||
|
|
|
setErrorDestinationVerb
:
STRING
= Set error queue for
|
|
Set Error Destination Verb
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, jndiName, jmsModuleName, subDeploymentName, errorDestination, setErrorDestinationScript, setErrorDestinationVerb, setErrorDestinationOrder, unsetErrorDestinationVerb, unsetErrorDestinationOrder, unsetErrorDestinationScript, restartTarget, libraryScripts, discoverOrder, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
unsetErrorDestinationOrder
:
INTEGER
= 37
|
|
Unset Error Destination Order
|
||
|
|
|
unsetErrorDestinationVerb
:
STRING
= Unset error queue from =
|
|
Unset Error Destination Verb
|
||
|
|
|
createScript
:
STRING
|
|
Python script invoked to create this resource
|
||
|
|
|
destroyScript
:
STRING
|
|
Python script invoked to destroy this resource
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this resource
|
||
|
|
|
setErrorDestinationScript
:
STRING
|
|
Python script invoked to set error destination on this jms resource
|
||
|
|
|
unsetErrorDestinationScript
:
STRING
|
|
Python script invoked to unset error destination from this jms resource
|
wls.AbstractUniformDistributedTopic
| Virtual Type | |
|---|---|
| Type Hierarchy | wls.JmsDestination >> wls.JmsResource >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
Description unavailable
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
jmsModuleName
:
STRING
|
|
Existing or new Jms system module which will be used to hold this resource
|
||
|
|
|
jndiName
:
STRING
|
|
Global JNDI name used to look up the destination within the JNDI namespace
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
|
|
Target error destination for messages that have expired or reached their redelivery limit
|
||
|
|
|
subDeploymentName
:
STRING
|
|
Subdeployment name, if null the deployment name is generated by Deployit using the following pattern, ${deployed.jmsModuleName}-subdeployment-for-${deployed.name}
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 60
|
|
Create Order
|
||
|
|
|
createVerb
:
STRING
= Create
|
|
Create Verb
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 40
|
|
Destroy Order
|
||
|
|
|
destroyVerb
:
STRING
= Destroy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 40
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
setErrorDestinationOrder
:
INTEGER
= 61
|
|
Set Error Destination Order
|
||
|
|
|
setErrorDestinationVerb
:
STRING
= Set error queue for
|
|
Set Error Destination Verb
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, jndiName, jmsModuleName, subDeploymentName, errorDestination, setErrorDestinationScript, setErrorDestinationVerb, setErrorDestinationOrder, unsetErrorDestinationVerb, unsetErrorDestinationOrder, unsetErrorDestinationScript, restartTarget, libraryScripts, discoverOrder, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
unsetErrorDestinationOrder
:
INTEGER
= 37
|
|
Unset Error Destination Order
|
||
|
|
|
unsetErrorDestinationVerb
:
STRING
= Unset error queue from =
|
|
Unset Error Destination Verb
|
||
|
|
|
createScript
:
STRING
|
|
Python script invoked to create this resource
|
||
|
|
|
destroyScript
:
STRING
|
|
Python script invoked to destroy this resource
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this resource
|
||
|
|
|
setErrorDestinationScript
:
STRING
|
|
Python script invoked to set error destination on this jms resource
|
||
|
|
|
unsetErrorDestinationScript
:
STRING
|
|
Python script invoked to unset error destination from this jms resource
|
wls.BaseWlsDeployed
| Virtual Type | |
|---|---|
| Type Hierarchy | python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
Base deployed of all WLS deployeds.
| 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]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
wls.Cluster
| Type Hierarchy | udm.BaseContainer >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | python.PythonManagedContainer, wls.WlsContainer, udm.Container, udm.ConfigurationItem, overthere.HostContainer, udm.Taggable, wls.JmsTarget |
WebLogic Cluster which defines groups of WebLogic servers that work together to increase scalability and reliability
| Parent | ||
|---|---|---|
|
|
|
|
|
The domain to which the WebLogic Cluster belongs. 'asContainment'=true, means a Cluster is 'contained' under a Domain
|
| Public Properties | ||
|---|---|---|
|
|
|
|
|
Servers in the WebLogic Cluster
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, only deployables with the same tag will be automatically mapped to this container.
|
| Hidden Properties | ||
|---|---|---|
|
|
|
startOrder
:
INTEGER
= 80
|
|
Start Order
|
||
|
|
|
startWaitTime
:
INTEGER
= 1
|
|
The time to wait in seconds for a container start action.
|
||
|
|
|
stopOrder
:
INTEGER
= 20
|
|
Stop Order
|
| Control task | Parameter CI | Attributes | Description |
|---|---|---|---|
| start |
No description. |
||
| stop |
No description. |
wls.ConnectionFactory
| Type Hierarchy | wls.JmsResource >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
A connection factory defines a set of connection configuration parameters that are used to create connections for JMS clients. Connection factories can configure properties of the connections returned to the JMS client, and also provide configurable options for default delivery, transaction, and message flow control parameters
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
jmsModuleName
:
STRING
|
|
Existing or new Jms system module which will be used to hold this resource
|
||
|
|
|
jndiName
:
STRING
|
|
Global JNDI name used to look up the destination within the JNDI namespace
|
||
|
|
|
LoadBalancingParams_ServerAffinityEnabled
:
BOOLEAN
|
|
ServerAffinityEnabled
|
||
|
|
|
TransactionParams_XAConnectionFactoryEnabled
:
BOOLEAN
|
|
XAConnectionFactoryEnabled
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
subDeploymentName
:
STRING
|
|
Subdeployment name, if null the deployment name is generated by Deployit using the following pattern, ${deployed.jmsModuleName}-subdeployment-for-${deployed.name}
|
| Hidden Properties | ||
|---|---|---|
|
|
|
additionalPropertiesNotToExpose
:
STRING
= libraryScripts, discoverOrder
|
|
Additional Properties Not To Expose
|
||
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 60
|
|
Create Order
|
||
|
|
|
createScript
:
STRING
= wls/jms/create-connection-factory.py
|
|
Python script invoked to create this resource
|
||
|
|
|
createVerb
:
STRING
= Create
|
|
Create Verb
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 40
|
|
Destroy Order
|
||
|
|
|
destroyScript
:
STRING
= wls/jms/destroy-connection-factory.py
|
|
Python script invoked to destroy this resource
|
||
|
|
|
destroyVerb
:
STRING
= Destroy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 40
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, destroyOrder, jndiName, jmsModuleName, subDeploymentName, restartTarget, libraryScripts, discoverOrder, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this resource
|
wls.ConnectionFactorySpec
| Type Hierarchy | wls.JmsResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.ConfigurationItem, udm.Taggable, udm.Deployable |
Specification for a JMS connection factory
| Public Properties | ||
|---|---|---|
|
|
|
LoadBalancingParams_ServerAffinityEnabled
:
STRING
|
|
ServerAffinityEnabled (boolean)
|
||
|
|
|
TransactionParams_XAConnectionFactoryEnabled
:
STRING
|
|
XAConnectionFactoryEnabled (boolean)
|
||
|
|
|
jmsModuleName
:
STRING
|
|
Existing or new Jms system module which will be used to hold this resource (string)
|
||
|
|
|
jndiName
:
STRING
|
|
Global JNDI name used to look up the destination within the JNDI namespace (string)
|
||
|
|
|
subDeploymentName
:
STRING
|
|
Subdeployment name, if null the deployment name is generated by Deployit using the following pattern, ${deployed.jmsModuleName}-subdeployment-for-${deployed.name} (string)
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
wls.CopiedArtifact
| Virtual Type | |
|---|---|
| Type Hierarchy | udm.BaseDeployed >> udm.BaseConfigurationItem |
| Interfaces | udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem |
Base class for all deployeds meant to contain Applications
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
targetDirectory
:
STRING
|
|
Path to which artifact must be copied to on the wls server.
|
||
|
|
|
targetRestartPolicy
:
ENUM [RESTART, STOP_START]
= RESTART
|
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true'
|
||
|
|
|
createTargetDirectory
:
BOOLEAN
= false
|
|
Create the target directory on the wls server if it does not exist.
|
||
|
|
|
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>
|
||
|
|
|
restartTarget
:
BOOLEAN
= false
|
|
Restart the target container
|
||
|
|
|
targetDirectoryShared
:
BOOLEAN
= true
|
|
Is the target directory shared by others on the wls 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 wls server.
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOrder
:
INTEGER
= 50
|
|
The order of the step in the step list for the create operation.
|
||
|
|
|
destroyOrder
:
INTEGER
= 40
|
|
The order of the step in the step list for the destroy operation.
|
wls.CopiedDeploymentPlan
| Type Hierarchy | generic.CopiedArtifact >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem |
Deployment plan XML file that is deployed to the WLS AdminServer host
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
targetDirectory
:
STRING
|
|
Specifies the target directory of the deployment plan file.
|
||
|
|
|
createTargetDirectory
:
BOOLEAN
= true
|
|
Create the target directory on the WLS AdminServer host if it does not exist.
|
||
|
|
|
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>
|
||
|
|
|
targetFile
:
STRING
|
|
Name of the artifact on the generic server.
|
| 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
= Create
|
|
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
= Destroy
|
|
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
|
||
|
|
|
copyDirectlyToTargetPath
:
BOOLEAN
= false
|
|
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)
|
||
|
|
|
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
= false
|
|
If set to true, preserve the existing files on the remote host (do not delete the copied files during the destroy operation).
|
||
|
|
|
restartRequired
:
BOOLEAN
= false
|
|
The generic container requires a restart for the action performed by this deployed.
|
||
|
|
|
restartRequiredForNoop
:
BOOLEAN
= false
|
|
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
= false
|
|
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.
|
wls.DataSource
| Type Hierarchy | wls.Resource >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
An object bound to the JNDI tree that provides database connectivity through a pool of JDBC connections
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
driverName
:
STRING
|
|
Full package name of JDBC driver class used to create the physical database connections in the connection pool
|
||
|
|
|
jndiNames
:
STRING
|
|
JNDI path to where this data source is bound
|
||
|
|
|
password
:
STRING
|
|
Password attribute passed to the JDBC driver when creating physical database connections
|
||
|
|
|
targetRestartPolicy
:
ENUM [RESTART, STOP_START]
= RESTART
|
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true'
|
||
|
|
|
url
:
STRING
|
|
URL of the database to connect to.
|
||
|
|
|
username
:
STRING
|
|
Username attribute passed to the JDBC driver when creating physical database connections
|
||
|
|
|
JDBCConnectionPoolParams_CapacityIncrement
:
INTEGER
|
|
Number of connections created when new connections are added to the connection pool
|
||
|
|
|
JDBCConnectionPoolParams_InitialCapacity
:
INTEGER
|
|
Number of physical connections to create when creating the connection pool
|
||
|
|
|
JDBCConnectionPoolParams_MaxCapacity
:
INTEGER
|
|
Maximum number of physical connections that this connection pool can contain
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
properties
:
MAP_STRING_STRING
|
|
The map of properties passed to the JDBC driver that are used to create physical database connections
|
||
|
|
|
restartTarget
:
BOOLEAN
= false
|
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource
|
| Hidden Properties | ||
|---|---|---|
|
|
|
additionalPropertiesNotToExpose
:
STRING
= jndiNames, url, driverName, username, password, properties, libraryScripts, discoverOrder
|
|
Additional Properties Not To Expose
|
||
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 60
|
|
Create Order
|
||
|
|
|
createScript
:
STRING
= wls/ds/create-datasource.py
|
|
Python script invoked to create this resource
|
||
|
|
|
createVerb
:
STRING
= Create
|
|
Create Verb
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 40
|
|
Destroy Order
|
||
|
|
|
destroyScript
:
STRING
= wls/ds/destroy-datasource.py
|
|
Python script invoked to destroy this resource
|
||
|
|
|
destroyVerb
:
STRING
= Destroy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 40
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, _properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyScript, destroyVerb, destroyOrder, jndiName, restartTarget, libraryScripts, discoverOrder, targetRestartPolicy, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this resource
|
wls.DataSourceSpec
| Type Hierarchy | wls.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.ConfigurationItem, udm.Taggable, udm.Deployable |
Specification for a datasource
| Public Properties | ||
|---|---|---|
|
|
|
JDBCConnectionPoolParams_CapacityIncrement
:
STRING
|
|
Number of connections created when new connections are added to the connection pool (integer)
|
||
|
|
|
JDBCConnectionPoolParams_InitialCapacity
:
STRING
|
|
Number of physical connections to create when creating the connection pool (integer)
|
||
|
|
|
JDBCConnectionPoolParams_MaxCapacity
:
STRING
|
|
Maximum number of physical connections that this connection pool can contain (integer)
|
||
|
|
|
driverName
:
STRING
|
|
Full package name of JDBC driver class used to create the physical database connections in the connection pool (string)
|
||
|
|
|
jndiNames
:
STRING
|
|
JNDI path to where this data source is bound (string)
|
||
|
|
|
password
:
STRING
|
|
Password attribute passed to the JDBC driver when creating physical database connections (string)
|
||
|
|
|
properties
:
MAP_STRING_STRING
|
|
The map of properties passed to the JDBC driver that are used to create physical database connections (map_string_string)
|
||
|
|
|
restartTarget
:
STRING
|
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource (boolean) default(false)
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
targetRestartPolicy
:
STRING
|
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true' (enum) values(RESTART, STOP_START) default(RESTART)
|
||
|
|
|
url
:
STRING
|
|
URL of the database to connect to. (string)
|
||
|
|
|
username
:
STRING
|
|
Username attribute passed to the JDBC driver when creating physical database connections (string)
|
wls.DeployedFile
| Type Hierarchy | wls.CopiedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem |
Deployed configuration File
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
targetDirectory
:
STRING
= ${deployed.container.domain.domainHome}/lib
|
|
Path to which artifact must be copied to on the wls server.
|
||
|
|
|
targetRestartPolicy
:
ENUM [RESTART, STOP_START]
= RESTART
|
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true'
|
||
|
|
|
createTargetDirectory
:
BOOLEAN
= false
|
|
Create the target directory on the wls server if it does not exist.
|
||
|
|
|
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>
|
||
|
|
|
restartTarget
:
BOOLEAN
= false
|
|
Restart the target container
|
||
|
|
|
targetDirectoryShared
:
BOOLEAN
= true
|
|
Is the target directory shared by others on the wls 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 wls server.
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOrder
:
INTEGER
= 50
|
|
The order of the step in the step list for the create operation.
|
||
|
|
|
destroyOrder
:
INTEGER
= 40
|
|
The order of the step in the step list for the destroy operation.
|
wls.DeployedFolder
| Type Hierarchy | wls.CopiedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem |
Deployed configuration Folder
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
targetDirectory
:
STRING
= ${deployed.container.domain.domainHome}/lib
|
|
Path to which artifact must be copied to on the wls server.
|
||
|
|
|
targetRestartPolicy
:
ENUM [RESTART, STOP_START]
= RESTART
|
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true'
|
||
|
|
|
createTargetDirectory
:
BOOLEAN
= false
|
|
Create the target directory on the wls server if it does not exist.
|
||
|
|
|
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>
|
||
|
|
|
restartTarget
:
BOOLEAN
= false
|
|
Restart the target container
|
||
|
|
|
targetDirectoryShared
:
BOOLEAN
= true
|
|
Is the target directory shared by others on the wls 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 wls server.
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOrder
:
INTEGER
= 50
|
|
The order of the step in the step list for the create operation.
|
||
|
|
|
destroyOrder
:
INTEGER
= 40
|
|
The order of the step in the step list for the destroy operation.
|
wls.DeploymentPlan
| Type Hierarchy | generic.File >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact |
Deployment plan XML file that is deployed to the WLS AdminServer host.
| Public Properties | ||
|---|---|---|
|
|
|
checksum
:
STRING
|
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
|
createTargetDirectory
:
STRING
|
|
Create the target directory on the WLS AdminServer host if it does not exist. (boolean) default(true)
|
||
|
|
|
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
|
||
|
|
|
scanPlaceholders
:
BOOLEAN
= true
|
|
Whether to scan this artifact for placeholders when it is imported
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
targetDirectory
:
STRING
|
|
Specifies the target directory of the deployment plan file. (string)
|
||
|
|
|
targetFile
:
STRING
|
|
Name of the artifact on the generic server. (string)
|
| 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
|
||
|
|
|
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
|
wls.Domain
| Type Hierarchy | udm.BaseContainer >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | python.PythonManagedContainer, python.PythonManagingContainer, wls.WlsContainer, udm.Container, udm.ConfigurationItem, overthere.HostContainer, udm.Taggable |
WebLogic Domain which is a collection of WebLogic Server instances that is managed by a single Administration Server
| Children | ||
|---|---|---|
|
|
|
|
|
WebLogic clusters belonging to domain
|
||
|
|
|
|
|
WebLogic servers belonging to domain
|
| Public Properties | ||
|---|---|---|
|
|
|
adminServerName
:
STRING
= AdminServer
|
|
The name of the admin server
|
||
|
|
|
host
:
CI<overthere.Host>
|
|
The host that runs the admin server
|
||
|
|
|
password
:
STRING
|
|
Password which is used to login to the WebLogic Domain.
|
||
|
|
|
port
:
INTEGER
= 7001
|
|
Port to be used by the AdminServer for this domain
|
||
|
|
|
protocol
:
ENUM [t3, t3s]
= t3
|
|
Protocol to be used by the AdminServer for this domain
|
||
|
|
|
startMode
:
ENUM [NodeManager, Script, WindowsService]
= NodeManager
|
|
Tells how a managed server is start and stop, default is NodeManager, others are Script or Windows Service
|
||
|
|
|
username
:
STRING
|
|
Username which is used to login to the WebLogic Domain.
|
||
|
|
|
version
:
ENUM [WEBLOGIC_9, WEBLOGIC_10, WEBLOGIC_11, WEBLOGIC_12]
= WEBLOGIC_10
|
|
Version of Oracle WebLogic Server
|
||
|
|
|
wlHome
:
STRING
|
|
The location of the WebLogic Server installation
|
||
|
|
|
deploymentMode
:
ENUM [SINGLE_TARGET, MULTI_TARGET]
= SINGLE_TARGET
|
|
Specify if deploy, undeploy, start and stop operations should be batched and target multiple servers as part of one WLST command. Valid values: 'SINGLE_TARGET' (default, issues a separate call to each target server), 'MULTI_TARGET' (issues one call for multiple target servers by setting the WLST targets options).
|
||
|
|
|
domainHome
:
STRING
|
|
The location of the WebLogic domain. Defaults to
|
||
|
|
|
hostname
:
STRING
|
|
Host to connect to for WLST
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, only deployables with the same tag will be automatically mapped to this container.
|
||
|
|
|
wlstPath
:
STRING
|
|
Location of the wlst binary. Defaults to
|
| Hidden Properties | ||
|---|---|---|
|
|
|
deployedsToDiscover
:
SET_OF_STRING
= [wls.FilePersistentStore]
|
|
Deployeds To Discover
|
||
|
|
|
destroyJmsModuleOrder
:
INTEGER
= 100
|
|
Order used to trigger the clean of the JMS Modules of the domain
|
||
|
|
|
startOrder
:
INTEGER
= 80
|
|
Start Order
|
||
|
|
|
stopOrder
:
INTEGER
= 20
|
|
Stop Order
|
||
|
|
|
customWlstTemplatePath
:
STRING
|
|
Path containing the custom wlst templates: wlst.sh.ftl (Unix) and wlst.cmd.ftl (Windows)
|
||
|
|
|
runWithDaemon
:
BOOLEAN
= true
|
|
Set to true to execute commands with the Python daemon
|
wls.Ear
| Type Hierarchy | jee.Ear >> udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.ArchiveArtifact, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact |
A JEE EAR archive
| Public Properties | ||
|---|---|---|
|
|
|
automaticVersioning
:
STRING
|
|
If set, the 'versionIdentifier' property is managed by the plugin. Any value explicitly set for 'versionIdentifier' is ignored. 'automaticVersioning' is enabled by default, in which case a unique version is created for the deployed module. If the manifest file includes an implementation version, then you must disable 'automaticVersioning'. If your manifest file includes a specification version and you want to use the implementation version that is defined in the manifest file, then you must set 'automaticVersioning' to false and enter the specification version as the 'versionIdentifier' property on the CI. (boolean) default(true)
|
||
|
|
|
block
:
STRING
|
|
boolean value specifying whether the deployment should block user interaction until the command complete (boolean) default(true)
|
||
|
|
|
checksum
:
STRING
|
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
|
deploymentOrder
:
STRING
|
|
By default, new applications and modules are configured with a Deployment Order value of 100 (integer) default(100)
|
||
|
|
|
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
|
||
|
|
|
planPath
:
STRING
|
|
Name of the deployment plan file. The filename can be absolute or relative to the application directory. (string)
|
||
|
|
|
redeploymentStrategy
:
STRING
|
|
Indicates what redeployment strategy to use for upgrading the application. Possible values: CLASSIC, STOP_START, SIDE_BY_SIDE (enum) values(CLASSIC, STOP_START, SIDE_BY_SIDE) default(CLASSIC)
|
||
|
|
|
retireTimeout
:
STRING
|
|
Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy (integer) default(-1)
|
||
|
|
|
scanPlaceholders
:
BOOLEAN
= false
|
|
Whether to scan this artifact for placeholders when it is imported
|
||
|
|
|
sharedLibraries
:
STRING
|
|
Shared Libraries
|
||
|
|
|
stageMode
:
STRING
|
|
Indicates whether the artifact will be deployed as staged or nostage mode (enum) values(Stage, NoStage) default(Stage)
|
||
|
|
|
stagingDirectory
:
STRING
|
|
Absolute directory path where the artifact will be uploaded and used by the servers for nostage deployment mode (string)
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
versionIdentifier
:
STRING
|
|
Version Identifier (string)
|
||
|
|
|
versioned
:
STRING
|
|
Indicates wither this artifact is to be deployed as a versioned application (boolean) default(false)
|
| 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
|
||
|
|
|
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
|
wls.EarModule
| Type Hierarchy | wls.ExtensibleDeployedArtifact >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem |
Ear with values configured for a deployment
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
deploymentOrder
:
INTEGER
= 100
|
|
By default, new applications and modules are configured with a Deployment Order value of 100
|
||
|
|
|
redeploymentStrategy
:
ENUM [CLASSIC, STOP_START, SIDE_BY_SIDE]
= CLASSIC
|
|
Indicates what redeployment strategy to use for upgrading the application. Possible values: CLASSIC, STOP_START, SIDE_BY_SIDE
|
||
|
|
|
retireTimeout
:
INTEGER
= -1
|
|
Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy
|
||
|
|
|
automaticVersioning
:
BOOLEAN
= true
|
|
If set, the 'versionIdentifier' property is managed by the plugin. Any value explicitly set for 'versionIdentifier' is ignored. 'automaticVersioning' is enabled by default, in which case a unique version is created for the deployed module. If the manifest file includes an implementation version, then you must disable 'automaticVersioning'. If your manifest file includes a specification version and you want to use the implementation version that is defined in the manifest file, then you must set 'automaticVersioning' to false and enter the specification version as the 'versionIdentifier' property on the CI.
|
||
|
|
|
block
:
BOOLEAN
= true
|
|
boolean value specifying whether the deployment should block user interaction until the command complete
|
||
|
|
|
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>
|
||
|
|
|
planPath
:
STRING
|
|
Name of the deployment plan file. The filename can be absolute or relative to the application directory.
|
||
|
|
|
|
|
Shared Libraries
|
||
|
|
|
stageMode
:
ENUM [Stage, NoStage]
= Stage
|
|
Indicates whether the artifact will be deployed as staged or nostage mode
|
||
|
|
|
stagingDirectory
:
STRING
|
|
Absolute directory path where the artifact will be uploaded and used by the servers for nostage deployment mode
|
||
|
|
|
versionIdentifier
:
STRING
|
|
Version Identifier
|
||
|
|
|
versioned
:
BOOLEAN
= false
|
|
Indicates wither this artifact is to be deployed as a versioned application
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 70
|
|
Create Order
|
||
|
|
|
createScript
:
STRING
= wls/application/deploy-application.py
|
|
Python script invoked to deploy this Java EE artifact
|
||
|
|
|
createVerb
:
STRING
= Deploy
|
|
Create Verb
|
||
|
|
|
deleteArtifactOrder
:
INTEGER
= 31
|
|
Delete Artifact Order
|
||
|
|
|
deleteRetiredArtifactOrder
:
INTEGER
= 99
|
|
Delete Retired Artifact Order
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 30
|
|
Destroy Order
|
||
|
|
|
destroyScript
:
STRING
= wls/application/undeploy-application.py
|
|
Python script invoked to undeploy this Java EE artifact
|
||
|
|
|
destroyVerb
:
STRING
= Undeploy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
isRunningRetryWaitInterval
:
INTEGER
= 500
|
|
Time in milliseconds to wait before next retry to check if the deployment is still running
|
||
|
|
|
manifestVersionProperty
:
STRING
= Extension-Name
|
|
Property in the manifest file of the archive indicating that it is a versioned artifact. You can override this property in XLDEPLOY_HOME/conf/deployit-defaults.properties. For example: wls.WarModule.manifestVersionProperty=Weblogic-Application-Version.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 60
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, deployable, properties, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, deleteArtifactOrder, startScript, startVerb, startOrder, stopScript, stopVerb, stopOrder, deploymentStrategy, placeholders, file, redeploymentStrategy, securityPermissions, inheritPermissions, exposeDeployedApplication, stopRetiredApplicationOrder, undeployRetiredApplicationOrder, deleteRetiredArtifactOrder, isRunningRetryWaitInterval, wlstPath, libraryScripts, discoverOrder, deploymentOrder, isStartOrStopOperationRequired, automaticVersioning, createOptions, modifyOptions, destroyOptions, noopOptions, manifestVersionProperty, versionTemplateFile, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
startOrder
:
INTEGER
= 90
|
|
Start Order
|
||
|
|
|
startScript
:
STRING
= wls/application/start-application.py
|
|
Python script invoked to start this Java EE artifact
|
||
|
|
|
startVerb
:
STRING
= Start
|
|
Start Verb
|
||
|
|
|
stopOrder
:
INTEGER
= 10
|
|
Stop Order
|
||
|
|
|
stopRetiredApplicationOrder
:
INTEGER
= 95
|
|
Stop Retired Application Order
|
||
|
|
|
stopScript
:
STRING
= wls/application/stop-application.py
|
|
Python script invoked to stop this Java EE artifact
|
||
|
|
|
stopVerb
:
STRING
= Stop
|
|
Stop Verb
|
||
|
|
|
undeployRetiredApplicationOrder
:
INTEGER
= 98
|
|
Undeploy Retired Application Order
|
||
|
|
|
versionExpression
:
STRING
= [#ftl]${manifestAttributes["Specification-Version"]}[#if manifestAttributes["Implementation-Version"]??]@${manifestAttributes["Implementation-Version"]}[/#if]
|
|
FreeMarker expression used to build the version based on the manifest file (properties are put in a map named 'manifestAttributes'). You can override this property in XLDEPLOY_HOME/conf/deployit-defaults.properties. For example: wls.WarModule.versionExpression=${manifestAttributes['Weblogic-Application-Version']}.
|
||
|
|
|
wlstPath
:
STRING
= AppDeployments
|
|
Wlst Path
|
||
|
|
|
activationTimeout
:
INTEGER
= -10
|
|
Time (in milliseconds) that WLST waits for the activation of configuration changes to complete before canceling the operation. A value of -1 indicates that the operation will not time out. A value of -10 indicates that this parameter will not be taken into account and server set default will be used. This argument normally defaults to 300,000 ms (or 5 minutes).
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
isStartOrStopOperationRequired
:
BOOLEAN
= true
|
|
Is Start Or Stop Operation Required
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this Java EE artifact
|
wls.EjbJar
| Type Hierarchy | jee.EjbJar >> udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.ArchiveArtifact, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact |
A JEE EJB archive
| Public Properties | ||
|---|---|---|
|
|
|
automaticVersioning
:
STRING
|
|
If set, the 'versionIdentifier' property is managed by the plugin. Any value explicitly set for 'versionIdentifier' is ignored. 'automaticVersioning' is enabled by default, in which case a unique version is created for the deployed module. If the manifest file includes an implementation version, then you must disable 'automaticVersioning'. If your manifest file includes a specification version and you want to use the implementation version that is defined in the manifest file, then you must set 'automaticVersioning' to false and enter the specification version as the 'versionIdentifier' property on the CI. (boolean) default(true)
|
||
|
|
|
block
:
STRING
|
|
boolean value specifying whether the deployment should block user interaction until the command complete (boolean) default(true)
|
||
|
|
|
checksum
:
STRING
|
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
|
deploymentOrder
:
STRING
|
|
By default, new applications and modules are configured with a Deployment Order value of 100 (integer) default(100)
|
||
|
|
|
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
|
||
|
|
|
planPath
:
STRING
|
|
Name of the deployment plan file. The filename can be absolute or relative to the application directory. (string)
|
||
|
|
|
redeploymentStrategy
:
STRING
|
|
Indicates what redeployment strategy to use for upgrading the application. Possible values: CLASSIC, STOP_START, SIDE_BY_SIDE (enum) values(CLASSIC, STOP_START, SIDE_BY_SIDE) default(CLASSIC)
|
||
|
|
|
retireTimeout
:
STRING
|
|
Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy (integer) default(-1)
|
||
|
|
|
scanPlaceholders
:
BOOLEAN
= false
|
|
Whether to scan this artifact for placeholders when it is imported
|
||
|
|
|
stageMode
:
STRING
|
|
Indicates whether the artifact will be deployed as staged or nostage mode (enum) values(Stage, NoStage) default(Stage)
|
||
|
|
|
stagingDirectory
:
STRING
|
|
Absolute directory path where the artifact will be uploaded and used by the servers for nostage deployment mode (string)
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
versionIdentifier
:
STRING
|
|
Version Identifier (string)
|
||
|
|
|
versioned
:
STRING
|
|
Indicates wither this artifact is to be deployed as a versioned application (boolean) default(false)
|
| 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
|
||
|
|
|
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
|
wls.EjbJarModule
| Type Hierarchy | wls.ExtensibleDeployedArtifact >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem |
EJB with values configured for a deployment
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
deploymentOrder
:
INTEGER
= 100
|
|
By default, new applications and modules are configured with a Deployment Order value of 100
|
||
|
|
|
redeploymentStrategy
:
ENUM [CLASSIC, STOP_START, SIDE_BY_SIDE]
= CLASSIC
|
|
Indicates what redeployment strategy to use for upgrading the application. Possible values: CLASSIC, STOP_START, SIDE_BY_SIDE
|
||
|
|
|
retireTimeout
:
INTEGER
= -1
|
|
Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy
|
||
|
|
|
automaticVersioning
:
BOOLEAN
= true
|
|
If set, the 'versionIdentifier' property is managed by the plugin. Any value explicitly set for 'versionIdentifier' is ignored. 'automaticVersioning' is enabled by default, in which case a unique version is created for the deployed module. If the manifest file includes an implementation version, then you must disable 'automaticVersioning'. If your manifest file includes a specification version and you want to use the implementation version that is defined in the manifest file, then you must set 'automaticVersioning' to false and enter the specification version as the 'versionIdentifier' property on the CI.
|
||
|
|
|
block
:
BOOLEAN
= true
|
|
boolean value specifying whether the deployment should block user interaction until the command complete
|
||
|
|
|
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>
|
||
|
|
|
planPath
:
STRING
|
|
Name of the deployment plan file. The filename can be absolute or relative to the application directory.
|
||
|
|
|
stageMode
:
ENUM [Stage, NoStage]
= Stage
|
|
Indicates whether the artifact will be deployed as staged or nostage mode
|
||
|
|
|
stagingDirectory
:
STRING
|
|
Absolute directory path where the artifact will be uploaded and used by the servers for nostage deployment mode
|
||
|
|
|
versionIdentifier
:
STRING
|
|
Version Identifier
|
||
|
|
|
versioned
:
BOOLEAN
= false
|
|
Indicates wither this artifact is to be deployed as a versioned application
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 70
|
|
Create Order
|
||
|
|
|
createScript
:
STRING
= wls/application/deploy-application.py
|
|
Python script invoked to deploy this Java EE artifact
|
||
|
|
|
createVerb
:
STRING
= Deploy
|
|
Create Verb
|
||
|
|
|
deleteArtifactOrder
:
INTEGER
= 31
|
|
Delete Artifact Order
|
||
|
|
|
deleteRetiredArtifactOrder
:
INTEGER
= 99
|
|
Delete Retired Artifact Order
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 30
|
|
Destroy Order
|
||
|
|
|
destroyScript
:
STRING
= wls/application/undeploy-application.py
|
|
Python script invoked to undeploy this Java EE artifact
|
||
|
|
|
destroyVerb
:
STRING
= Undeploy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
isRunningRetryWaitInterval
:
INTEGER
= 500
|
|
Time in milliseconds to wait before next retry to check if the deployment is still running
|
||
|
|
|
manifestVersionProperty
:
STRING
= Extension-Name
|
|
Property in the manifest file of the archive indicating that it is a versioned artifact. You can override this property in XLDEPLOY_HOME/conf/deployit-defaults.properties. For example: wls.WarModule.manifestVersionProperty=Weblogic-Application-Version.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 60
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, deployable, properties, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, deleteArtifactOrder, startScript, startVerb, startOrder, stopScript, stopVerb, stopOrder, deploymentStrategy, placeholders, file, redeploymentStrategy, securityPermissions, inheritPermissions, exposeDeployedApplication, stopRetiredApplicationOrder, undeployRetiredApplicationOrder, deleteRetiredArtifactOrder, isRunningRetryWaitInterval, wlstPath, libraryScripts, discoverOrder, deploymentOrder, isStartOrStopOperationRequired, automaticVersioning, createOptions, modifyOptions, destroyOptions, noopOptions, manifestVersionProperty, versionTemplateFile, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
startOrder
:
INTEGER
= 90
|
|
Start Order
|
||
|
|
|
startScript
:
STRING
= wls/application/start-application.py
|
|
Python script invoked to start this Java EE artifact
|
||
|
|
|
startVerb
:
STRING
= Start
|
|
Start Verb
|
||
|
|
|
stopOrder
:
INTEGER
= 10
|
|
Stop Order
|
||
|
|
|
stopRetiredApplicationOrder
:
INTEGER
= 95
|
|
Stop Retired Application Order
|
||
|
|
|
stopScript
:
STRING
= wls/application/stop-application.py
|
|
Python script invoked to stop this Java EE artifact
|
||
|
|
|
stopVerb
:
STRING
= Stop
|
|
Stop Verb
|
||
|
|
|
undeployRetiredApplicationOrder
:
INTEGER
= 98
|
|
Undeploy Retired Application Order
|
||
|
|
|
versionExpression
:
STRING
= [#ftl]${manifestAttributes["Specification-Version"]}[#if manifestAttributes["Implementation-Version"]??]@${manifestAttributes["Implementation-Version"]}[/#if]
|
|
FreeMarker expression used to build the version based on the manifest file (properties are put in a map named 'manifestAttributes'). You can override this property in XLDEPLOY_HOME/conf/deployit-defaults.properties. For example: wls.WarModule.versionExpression=${manifestAttributes['Weblogic-Application-Version']}.
|
||
|
|
|
wlstPath
:
STRING
= AppDeployments
|
|
Wlst Path
|
||
|
|
|
activationTimeout
:
INTEGER
= -10
|
|
Time (in milliseconds) that WLST waits for the activation of configuration changes to complete before canceling the operation. A value of -1 indicates that the operation will not time out. A value of -10 indicates that this parameter will not be taken into account and server set default will be used. This argument normally defaults to 300,000 ms (or 5 minutes).
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
isStartOrStopOperationRequired
:
BOOLEAN
= true
|
|
Is Start Or Stop Operation Required
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this Java EE artifact
|
wls.ExtensibleDeployedArtifact
| Virtual Type | |
|---|---|
| Type Hierarchy | wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
| Interfaces | udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem |
Base class for all deployeds meant to contain Applications
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
deploymentOrder
:
INTEGER
= 100
|
|
By default, new applications and modules are configured with a Deployment Order value of 100
|
||
|
|
|
redeploymentStrategy
:
ENUM [CLASSIC, STOP_START, SIDE_BY_SIDE]
= CLASSIC
|
|
Indicates what redeployment strategy to use for upgrading the application. Possible values: CLASSIC, STOP_START, SIDE_BY_SIDE
|
||
|
|
|
retireTimeout
:
INTEGER
= -1
|
|
Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy
|
||
|
|
|
automaticVersioning
:
BOOLEAN
= true
|
|
If set, the 'versionIdentifier' property is managed by the plugin. Any value explicitly set for 'versionIdentifier' is ignored. 'automaticVersioning' is enabled by default, in which case a unique version is created for the deployed module. If the manifest file includes an implementation version, then you must disable 'automaticVersioning'. If your manifest file includes a specification version and you want to use the implementation version that is defined in the manifest file, then you must set 'automaticVersioning' to false and enter the specification version as the 'versionIdentifier' property on the CI.
|
||
|
|
|
block
:
BOOLEAN
= true
|
|
boolean value specifying whether the deployment should block user interaction until the command complete
|
||
|
|
|
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>
|
||
|
|
|
planPath
:
STRING
|
|
Name of the deployment plan file. The filename can be absolute or relative to the application directory.
|
||
|
|
|
stageMode
:
ENUM [Stage, NoStage]
= Stage
|
|
Indicates whether the artifact will be deployed as staged or nostage mode
|
||
|
|
|
stagingDirectory
:
STRING
|
|
Absolute directory path where the artifact will be uploaded and used by the servers for nostage deployment mode
|
||
|
|
|
versionIdentifier
:
STRING
|
|
Version Identifier
|
||
|
|
|
versioned
:
BOOLEAN
= false
|
|
Indicates wither this artifact is to be deployed as a versioned application
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 70
|
|
Create Order
|
||
|
|
|
createScript
:
STRING
= wls/application/deploy-application.py
|
|
Python script invoked to deploy this Java EE artifact
|
||
|
|
|
createVerb
:
STRING
= Deploy
|
|
Create Verb
|
||
|
|
|
deleteArtifactOrder
:
INTEGER
= 31
|
|
Delete Artifact Order
|
||
|
|
|
deleteRetiredArtifactOrder
:
INTEGER
= 99
|
|
Delete Retired Artifact Order
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 30
|
|
Destroy Order
|
||
|
|
|
destroyScript
:
STRING
= wls/application/undeploy-application.py
|
|
Python script invoked to undeploy this Java EE artifact
|
||
|
|
|
destroyVerb
:
STRING
= Undeploy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
isRunningRetryWaitInterval
:
INTEGER
= 500
|
|
Time in milliseconds to wait before next retry to check if the deployment is still running
|
||
|
|
|
manifestVersionProperty
:
STRING
= Extension-Name
|
|
Property in the manifest file of the archive indicating that it is a versioned artifact. You can override this property in XLDEPLOY_HOME/conf/deployit-defaults.properties. For example: wls.WarModule.manifestVersionProperty=Weblogic-Application-Version.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 60
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, deployable, properties, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, deleteArtifactOrder, startScript, startVerb, startOrder, stopScript, stopVerb, stopOrder, deploymentStrategy, placeholders, file, redeploymentStrategy, securityPermissions, inheritPermissions, exposeDeployedApplication, stopRetiredApplicationOrder, undeployRetiredApplicationOrder, deleteRetiredArtifactOrder, isRunningRetryWaitInterval, wlstPath, libraryScripts, discoverOrder, deploymentOrder, isStartOrStopOperationRequired, automaticVersioning, createOptions, modifyOptions, destroyOptions, noopOptions, manifestVersionProperty, versionTemplateFile, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
startOrder
:
INTEGER
= 90
|
|
Start Order
|
||
|
|
|
startScript
:
STRING
= wls/application/start-application.py
|
|
Python script invoked to start this Java EE artifact
|
||
|
|
|
startVerb
:
STRING
= Start
|
|
Start Verb
|
||
|
|
|
stopOrder
:
INTEGER
= 10
|
|
Stop Order
|
||
|
|
|
stopRetiredApplicationOrder
:
INTEGER
= 95
|
|
Stop Retired Application Order
|
||
|
|
|
stopScript
:
STRING
= wls/application/stop-application.py
|
|
Python script invoked to stop this Java EE artifact
|
||
|
|
|
stopVerb
:
STRING
= Stop
|
|
Stop Verb
|
||
|
|
|
undeployRetiredApplicationOrder
:
INTEGER
= 98
|
|
Undeploy Retired Application Order
|
||
|
|
|
versionExpression
:
STRING
= [#ftl]${manifestAttributes["Specification-Version"]}[#if manifestAttributes["Implementation-Version"]??]@${manifestAttributes["Implementation-Version"]}[/#if]
|
|
FreeMarker expression used to build the version based on the manifest file (properties are put in a map named 'manifestAttributes'). You can override this property in XLDEPLOY_HOME/conf/deployit-defaults.properties. For example: wls.WarModule.versionExpression=${manifestAttributes['Weblogic-Application-Version']}.
|
||
|
|
|
wlstPath
:
STRING
= AppDeployments
|
|
Wlst Path
|
||
|
|
|
activationTimeout
:
INTEGER
= -10
|
|
Time (in milliseconds) that WLST waits for the activation of configuration changes to complete before canceling the operation. A value of -1 indicates that the operation will not time out. A value of -10 indicates that this parameter will not be taken into account and server set default will be used. This argument normally defaults to 300,000 ms (or 5 minutes).
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
isStartOrStopOperationRequired
:
BOOLEAN
= true
|
|
Is Start Or Stop Operation Required
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this Java EE artifact
|
wls.ExtensibleDeployedSharedLibrary
| Virtual Type | |
|---|---|
| Type Hierarchy | wls.ExtensibleDeployedArtifact >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
| Interfaces | udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem |
Base class for all shared library deployeds
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
deploymentOrder
:
INTEGER
= 100
|
|
By default, new applications and modules are configured with a Deployment Order value of 100
|
||
|
|
|
redeploymentStrategy
:
ENUM [CLASSIC, STOP_START, SIDE_BY_SIDE]
= CLASSIC
|
|
Indicates what redeployment strategy to use for upgrading the application. Possible values: CLASSIC, STOP_START, SIDE_BY_SIDE
|
||
|
|
|
retireTimeout
:
INTEGER
= -1
|
|
Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy
|
||
|
|
|
automaticVersioning
:
BOOLEAN
= true
|
|
If set, the 'versionIdentifier' property is managed by the plugin. Any value explicitly set for 'versionIdentifier' is ignored. 'automaticVersioning' is enabled by default, in which case a unique version is created for the deployed module. If the manifest file includes an implementation version, then you must disable 'automaticVersioning'. If your manifest file includes a specification version and you want to use the implementation version that is defined in the manifest file, then you must set 'automaticVersioning' to false and enter the specification version as the 'versionIdentifier' property on the CI.
|
||
|
|
|
block
:
BOOLEAN
= true
|
|
boolean value specifying whether the deployment should block user interaction until the command complete
|
||
|
|
|
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>
|
||
|
|
|
planPath
:
STRING
|
|
Name of the deployment plan file. The filename can be absolute or relative to the application directory.
|
||
|
|
|
stageMode
:
ENUM [Stage, NoStage]
= Stage
|
|
Indicates whether the artifact will be deployed as staged or nostage mode
|
||
|
|
|
stagingDirectory
:
STRING
|
|
Absolute directory path where the artifact will be uploaded and used by the servers for nostage deployment mode
|
||
|
|
|
versionIdentifier
:
STRING
|
|
Version Identifier
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 70
|
|
Create Order
|
||
|
|
|
createScript
:
STRING
= wls/application/deploy-application.py
|
|
Python script invoked to deploy this Java EE artifact
|
||
|
|
|
createVerb
:
STRING
= Deploy
|
|
Create Verb
|
||
|
|
|
deleteArtifactOrder
:
INTEGER
= 31
|
|
Delete Artifact Order
|
||
|
|
|
deleteRetiredArtifactOrder
:
INTEGER
= 99
|
|
Delete Retired Artifact Order
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 30
|
|
Destroy Order
|
||
|
|
|
destroyScript
:
STRING
= wls/application/undeploy-application.py
|
|
Python script invoked to undeploy this Java EE artifact
|
||
|
|
|
destroyVerb
:
STRING
= Undeploy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
isRunningRetryWaitInterval
:
INTEGER
= 500
|
|
Time in milliseconds to wait before next retry to check if the deployment is still running
|
||
|
|
|
libraryModule
:
STRING
= true
|
|
Library Module
|
||
|
|
|
manifestVersionProperty
:
STRING
= Extension-Name
|
|
Property in the manifest file of the archive indicating that it is a versioned artifact. You can override this property in XLDEPLOY_HOME/conf/deployit-defaults.properties. For example: wls.WarModule.manifestVersionProperty=Weblogic-Application-Version.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 60
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
runtimeDependenciesTypes
:
LIST_OF_STRING
= [wls.EarModule, wls.WarModule]
|
|
Runtime Dependencies Types
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, deployable, properties, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, deleteArtifactOrder, startScript, startVerb, startOrder, stopScript, stopVerb, stopOrder, deploymentStrategy, placeholders, file, redeploymentStrategy, securityPermissions, inheritPermissions, exposeDeployedApplication, stopRetiredApplicationOrder, undeployRetiredApplicationOrder, deleteRetiredArtifactOrder, isRunningRetryWaitInterval, wlstPath, libraryScripts, discoverOrder, deploymentOrder, isStartOrStopOperationRequired, automaticVersioning, createOptions, modifyOptions, destroyOptions, noopOptions, manifestVersionProperty, versionTemplateFile, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
startOrder
:
INTEGER
= 90
|
|
Start Order
|
||
|
|
|
startScript
:
STRING
= wls/application/start-application.py
|
|
Python script invoked to start this Java EE artifact
|
||
|
|
|
startVerb
:
STRING
= Start
|
|
Start Verb
|
||
|
|
|
stopOrder
:
INTEGER
= 10
|
|
Stop Order
|
||
|
|
|
stopRetiredApplicationOrder
:
INTEGER
= 95
|
|
Stop Retired Application Order
|
||
|
|
|
stopScript
:
STRING
= wls/application/stop-application.py
|
|
Python script invoked to stop this Java EE artifact
|
||
|
|
|
stopVerb
:
STRING
= Stop
|
|
Stop Verb
|
||
|
|
|
undeployRetiredApplicationOrder
:
INTEGER
= 98
|
|
Undeploy Retired Application Order
|
||
|
|
|
versionExpression
:
STRING
= [#ftl]${manifestAttributes["Specification-Version"]}[#if manifestAttributes["Implementation-Version"]??]@${manifestAttributes["Implementation-Version"]}[/#if]
|
|
FreeMarker expression used to build the version based on the manifest file (properties are put in a map named 'manifestAttributes'). You can override this property in XLDEPLOY_HOME/conf/deployit-defaults.properties. For example: wls.WarModule.versionExpression=${manifestAttributes['Weblogic-Application-Version']}.
|
||
|
|
|
wlstPath
:
STRING
= Libraries
|
|
Wlst Path
|
||
|
|
|
activationTimeout
:
INTEGER
= -10
|
|
Time (in milliseconds) that WLST waits for the activation of configuration changes to complete before canceling the operation. A value of -1 indicates that the operation will not time out. A value of -10 indicates that this parameter will not be taken into account and server set default will be used. This argument normally defaults to 300,000 ms (or 5 minutes).
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
isStartOrStopOperationRequired
:
BOOLEAN
= false
|
|
Is Start Or Stop Operation Required
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this Java EE artifact
|
||
|
|
|
versioned
:
BOOLEAN
= true
|
|
Indicates wither this artifact is to be deployed as a versioned application
|
wls.File
| Type Hierarchy | generic.File >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact |
File that is deployed to the server lib directory
| Public Properties | ||
|---|---|---|
|
|
|
checksum
:
STRING
|
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
|
createTargetDirectory
:
STRING
|
|
Create the target directory on the wls server if it does not exist. (boolean) default(false)
|
||
|
|
|
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
|
||
|
|
|
restartTarget
:
STRING
|
|
Restart the target container (boolean) default(false)
|
||
|
|
|
scanPlaceholders
:
BOOLEAN
= true
|
|
Whether to scan this artifact for placeholders when it is imported
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
targetDirectory
:
STRING
|
|
Path to which artifact must be copied to on the wls server. (string) default(${deployed.container.domain.domainHome}/lib)
|
||
|
|
|
targetDirectoryShared
:
STRING
|
|
Is the target directory shared by others on the wls server. When true, the target directory is not deleted during a destroy operation; only the artifacts copied to it. (boolean) default(true)
|
||
|
|
|
targetFile
:
STRING
|
|
Name of the artifact on the wls server. (string)
|
||
|
|
|
targetRestartPolicy
:
STRING
|
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true' (enum) values(RESTART, STOP_START) default(RESTART)
|
| 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
|
||
|
|
|
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
|
wls.FilePersistentStore
| Type Hierarchy | wls.PersistentStore >> wls.Resource >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
A file-based persistent store.
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
directory
:
STRING
|
|
The path name to the file system directory where the file store maintains its data files.
|
||
|
|
|
synchronousWritePolicy
:
STRING
= Cache-Flush
|
|
The disk write policy that determines how the file store writes data to disk. The valid policy options are: Direct-Write, Direct-Write-With-Cache, Cache-Flush, Disabled.
|
||
|
|
|
targetRestartPolicy
:
ENUM [RESTART, STOP_START]
= RESTART
|
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true'
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
restartTarget
:
BOOLEAN
= false
|
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 60
|
|
Create Order
|
||
|
|
|
createScript
:
STRING
= wls/resources/create-file-persistence-store.py
|
|
Python script invoked to create this resource
|
||
|
|
|
createVerb
:
STRING
= Create
|
|
Create Verb
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 40
|
|
Destroy Order
|
||
|
|
|
destroyScript
:
STRING
= wls/resources/destroy-file-persistence-store.py
|
|
Python script invoked to destroy this resource
|
||
|
|
|
destroyVerb
:
STRING
= Destroy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 40
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, _properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyScript, destroyVerb, destroyOrder, jndiName, restartTarget, libraryScripts, discoverOrder, targetRestartPolicy, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this resource
|
wls.FilePersistentStoreSpec
| Type Hierarchy | wls.PersistentStoreSpec >> wls.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.ConfigurationItem, udm.Taggable, udm.Deployable |
A file-based persistent store. (deployable)
| Public Properties | ||
|---|---|---|
|
|
|
directory
:
STRING
|
|
The path name to the file system directory where the file store maintains its data files. (string)
|
||
|
|
|
restartTarget
:
STRING
|
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource (boolean) default(false)
|
||
|
|
|
synchronousWritePolicy
:
STRING
|
|
The disk write policy that determines how the file store writes data to disk. The valid policy options are: Direct-Write, Direct-Write-With-Cache, Cache-Flush, Disabled. (string) default(Cache-Flush)
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
targetRestartPolicy
:
STRING
|
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true' (enum) values(RESTART, STOP_START) default(RESTART)
|
wls.Folder
| Type Hierarchy | generic.Folder >> udm.BaseDeployableFolderArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.FolderArtifact, udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.DeployableArtifact, udm.Deployable |
Folder that is deployed to the server lib directory
| Public Properties | ||
|---|---|---|
|
|
|
checksum
:
STRING
|
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
|
createTargetDirectory
:
STRING
|
|
Create the target directory on the wls server if it does not exist. (boolean) default(false)
|
||
|
|
|
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
|
||
|
|
|
restartTarget
:
STRING
|
|
Restart the target container (boolean) default(false)
|
||
|
|
|
scanPlaceholders
:
BOOLEAN
= true
|
|
Whether to scan this artifact for placeholders when it is imported
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
targetDirectory
:
STRING
|
|
Path to which artifact must be copied to on the wls server. (string) default(${deployed.container.domain.domainHome}/lib)
|
||
|
|
|
targetDirectoryShared
:
STRING
|
|
Is the target directory shared by others on the wls server. When true, the target directory is not deleted during a destroy operation; only the artifacts copied to it. (boolean) default(true)
|
||
|
|
|
targetFile
:
STRING
|
|
Name of the artifact on the wls server. (string)
|
||
|
|
|
targetRestartPolicy
:
STRING
|
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true' (enum) values(RESTART, STOP_START) default(RESTART)
|
| 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
|
||
|
|
|
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
|
wls.JmsDestination
| Virtual Type | |
|---|---|
| Type Hierarchy | wls.JmsResource >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
Base class for all JMS destinations, which can have a error destination property defined on them
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
jmsModuleName
:
STRING
|
|
Existing or new Jms system module which will be used to hold this resource
|
||
|
|
|
jndiName
:
STRING
|
|
Global JNDI name used to look up the destination within the JNDI namespace
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
|
|
Target error destination for messages that have expired or reached their redelivery limit
|
||
|
|
|
subDeploymentName
:
STRING
|
|
Subdeployment name, if null the deployment name is generated by Deployit using the following pattern, ${deployed.jmsModuleName}-subdeployment-for-${deployed.name}
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 60
|
|
Create Order
|
||
|
|
|
createVerb
:
STRING
= Create
|
|
Create Verb
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 40
|
|
Destroy Order
|
||
|
|
|
destroyVerb
:
STRING
= Destroy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 40
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
setErrorDestinationOrder
:
INTEGER
= 61
|
|
Set Error Destination Order
|
||
|
|
|
setErrorDestinationVerb
:
STRING
= Set error queue for
|
|
Set Error Destination Verb
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, jndiName, jmsModuleName, subDeploymentName, errorDestination, setErrorDestinationScript, setErrorDestinationVerb, setErrorDestinationOrder, unsetErrorDestinationVerb, unsetErrorDestinationOrder, unsetErrorDestinationScript, restartTarget, libraryScripts, discoverOrder, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
unsetErrorDestinationOrder
:
INTEGER
= 37
|
|
Unset Error Destination Order
|
||
|
|
|
unsetErrorDestinationVerb
:
STRING
= Unset error queue from =
|
|
Unset Error Destination Verb
|
||
|
|
|
createScript
:
STRING
|
|
Python script invoked to create this resource
|
||
|
|
|
destroyScript
:
STRING
|
|
Python script invoked to destroy this resource
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this resource
|
||
|
|
|
setErrorDestinationScript
:
STRING
|
|
Python script invoked to set error destination on this jms resource
|
||
|
|
|
unsetErrorDestinationScript
:
STRING
|
|
Python script invoked to unset error destination from this jms resource
|
wls.JmsFilePersistentStore
| Type Hierarchy | wls.JmsPersistentStore >> wls.Resource >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
A file-based persistent store for JMS messages.
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
directory
:
STRING
|
|
The path name to the file system directory where the file store maintains its data files.
|
||
|
|
|
synchronousWritePolicy
:
STRING
= Cache-Flush
|
|
The disk write policy that determines how the file store writes data to disk. The valid policy options are: Direct-Write, Direct-Write-With-Cache, Cache-Flush, Disabled.
|
||
|
|
|
targetRestartPolicy
:
ENUM [RESTART, STOP_START]
= RESTART
|
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true'
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
restartTarget
:
BOOLEAN
= false
|
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 60
|
|
Create Order
|
||
|
|
|
createScript
:
STRING
= wls/jms/create-jms-file-persistence-store.py
|
|
Python script invoked to create this resource
|
||
|
|
|
createVerb
:
STRING
= Create
|
|
Create Verb
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 40
|
|
Destroy Order
|
||
|
|
|
destroyScript
:
STRING
= wls/jms/destroy-jms-file-persistence-store.py
|
|
Python script invoked to destroy this resource
|
||
|
|
|
destroyVerb
:
STRING
= Destroy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 40
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, _properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyScript, destroyVerb, destroyOrder, jndiName, restartTarget, libraryScripts, discoverOrder, targetRestartPolicy, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this resource
|
wls.JmsFilePersistentStoreSpec
| Type Hierarchy | wls.JmsPersistentStoreSpec >> wls.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.ConfigurationItem, udm.Taggable, udm.Deployable |
A file-based persistent store for JMS messages. (deployable)
| Public Properties | ||
|---|---|---|
|
|
|
directory
:
STRING
|
|
The path name to the file system directory where the file store maintains its data files. (string)
|
||
|
|
|
restartTarget
:
STRING
|
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource (boolean) default(false)
|
||
|
|
|
synchronousWritePolicy
:
STRING
|
|
The disk write policy that determines how the file store writes data to disk. The valid policy options are: Direct-Write, Direct-Write-With-Cache, Cache-Flush, Disabled. (string) default(Cache-Flush)
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
targetRestartPolicy
:
STRING
|
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true' (enum) values(RESTART, STOP_START) default(RESTART)
|
wls.JmsJdbcPersistentStore
| Type Hierarchy | wls.JmsPersistentStore >> wls.Resource >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
A database backed persistent store for JMS messages.
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
|
|
The JDBC data source used by this JDBC store to access its backing table.
|
||
|
|
|
prefixName
:
STRING
=
|
|
The prefix for the JDBC store's database table (WLStore), in the following format: [[[catalog.]schema.]prefix].
|
||
|
|
|
targetRestartPolicy
:
ENUM [RESTART, STOP_START]
= RESTART
|
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true'
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
restartTarget
:
BOOLEAN
= false
|
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 62
|
|
Create Order
|
||
|
|
|
createScript
:
STRING
= wls/jms/create-jms-jdbc-persistence-store.py
|
|
Python script invoked to create this resource
|
||
|
|
|
createVerb
:
STRING
= Create
|
|
Create Verb
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 38
|
|
Destroy Order
|
||
|
|
|
destroyScript
:
STRING
= wls/jms/destroy-jms-jdbc-persistence-store.py
|
|
Python script invoked to destroy this resource
|
||
|
|
|
destroyVerb
:
STRING
= Destroy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 40
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, _properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyScript, destroyVerb, destroyOrder, jndiName, restartTarget, libraryScripts, discoverOrder, targetRestartPolicy, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this resource
|
wls.JmsJdbcPersistentStoreSpec
| Type Hierarchy | wls.JmsPersistentStoreSpec >> wls.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.ConfigurationItem, udm.Taggable, udm.Deployable |
A database backed persistent store for JMS messages. (deployable)
| Public Properties | ||
|---|---|---|
|
|
|
prefixName
:
STRING
|
|
The prefix for the JDBC store's database table (WLStore), in the following format: [[[catalog.]schema.]prefix]. (string) default()
|
||
|
|
|
restartTarget
:
STRING
|
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource (boolean) default(false)
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
targetRestartPolicy
:
STRING
|
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true' (enum) values(RESTART, STOP_START) default(RESTART)
|
wls.JmsPersistentStore
| Virtual Type | |
|---|---|
| Type Hierarchy | wls.Resource >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
A persistent store for JMS messages.
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
targetRestartPolicy
:
ENUM [RESTART, STOP_START]
= RESTART
|
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true'
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
restartTarget
:
BOOLEAN
= false
|
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 60
|
|
Create Order
|
||
|
|
|
createVerb
:
STRING
= Create
|
|
Create Verb
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 40
|
|
Destroy Order
|
||
|
|
|
destroyVerb
:
STRING
= Destroy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 40
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, _properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyScript, destroyVerb, destroyOrder, jndiName, restartTarget, libraryScripts, discoverOrder, targetRestartPolicy, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
createScript
:
STRING
|
|
Python script invoked to create this resource
|
||
|
|
|
destroyScript
:
STRING
|
|
Python script invoked to destroy this resource
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this resource
|
wls.JmsPersistentStoreSpec
| Type Hierarchy | wls.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.ConfigurationItem, udm.Taggable, udm.Deployable |
A persistent store for JMS messages. (deployable)
| Public Properties | ||
|---|---|---|
|
|
|
restartTarget
:
STRING
|
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource (boolean) default(false)
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
targetRestartPolicy
:
STRING
|
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true' (enum) values(RESTART, STOP_START) default(RESTART)
|
wls.JmsResource
| Virtual Type | |
|---|---|
| Type Hierarchy | wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
Base deployed type for all JMS related resources
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
jmsModuleName
:
STRING
|
|
Existing or new Jms system module which will be used to hold this resource
|
||
|
|
|
jndiName
:
STRING
|
|
Global JNDI name used to look up the destination within the JNDI namespace
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
subDeploymentName
:
STRING
|
|
Subdeployment name, if null the deployment name is generated by Deployit using the following pattern, ${deployed.jmsModuleName}-subdeployment-for-${deployed.name}
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 60
|
|
Create Order
|
||
|
|
|
createVerb
:
STRING
= Create
|
|
Create Verb
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 40
|
|
Destroy Order
|
||
|
|
|
destroyVerb
:
STRING
= Destroy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 40
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, destroyOrder, jndiName, jmsModuleName, subDeploymentName, restartTarget, libraryScripts, discoverOrder, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
createScript
:
STRING
|
|
Python script invoked to create this resource
|
||
|
|
|
destroyScript
:
STRING
|
|
Python script invoked to destroy this resource
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this resource
|
wls.JmsResourceSpec
| Virtual Type | |
|---|---|
| Type Hierarchy | udm.BaseDeployable >> udm.BaseConfigurationItem |
| Interfaces | udm.ConfigurationItem, udm.Taggable, udm.Deployable |
Base deployable type for all JMS related resources
| Public Properties | ||
|---|---|---|
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
wls.JmsServer
| Type Hierarchy | udm.BaseContainer >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | python.PythonManagedContainer, udm.Container, udm.ConfigurationItem, overthere.HostContainer, udm.Taggable, wls.JmsTarget |
WebLogic JMS server, that act as management containers for the queues and topics in JMS modules that are targeted to them
| Parent | ||
|---|---|---|
|
|
|
|
|
A server instance or migratable target this JMS server is deployed to. 'asContainment'=true, means a JmsServer is 'contained' under a Server
|
| Public Properties | ||
|---|---|---|
|
|
|
tags
:
SET_OF_STRING
|
|
If set, only deployables with the same tag will be automatically mapped to this container.
|
wls.MailSession
| Type Hierarchy | wls.Resource >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
Mail sessions facilitate the process of using the JavaMail APIs, which provide applications and other J2EE modules with access to Internet Message Access Protocol (IMAP)- and Simple Mail Transfer Protocol (SMTP)-capable mail servers on your network or the Internet
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
jndiName
:
STRING
|
|
The JNDI name that modules use to access this mail session.
|
||
|
|
|
targetRestartPolicy
:
ENUM [RESTART, STOP_START]
= RESTART
|
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true'
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
javaMailProperties
:
MAP_STRING_STRING
|
|
The configuration options and user authentication data that this mail session uses to interact with a mail server. Each property that you specify overrides the default property value as defined by the JavaMail API Design Specification.
|
||
|
|
|
restartTarget
:
BOOLEAN
= false
|
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource
|
| Hidden Properties | ||
|---|---|---|
|
|
|
additionalPropertiesNotToExpose
:
STRING
= jndiName,javaMailProperties,libraryScripts,discoverOrder
|
|
Additional Properties Not To Expose
|
||
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 60
|
|
Create Order
|
||
|
|
|
createScript
:
STRING
= wls/resources/create-mail-session.py
|
|
Python script invoked to create this resource
|
||
|
|
|
createVerb
:
STRING
= Create
|
|
Create Verb
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 40
|
|
Destroy Order
|
||
|
|
|
destroyScript
:
STRING
= wls/resources/destroy-mail-session.py
|
|
Python script invoked to destroy this resource
|
||
|
|
|
destroyVerb
:
STRING
= Destroy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 40
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, _properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyScript, destroyVerb, destroyOrder, jndiName, restartTarget, libraryScripts, discoverOrder, targetRestartPolicy, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this resource
|
wls.MailSessionSpec
| Type Hierarchy | wls.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.ConfigurationItem, udm.Taggable, udm.Deployable |
Specification for a mail session
| Public Properties | ||
|---|---|---|
|
|
|
javaMailProperties
:
MAP_STRING_STRING
|
|
The configuration options and user authentication data that this mail session uses to interact with a mail server. Each property that you specify overrides the default property value as defined by the JavaMail API Design Specification. (map_string_string)
|
||
|
|
|
jndiName
:
STRING
|
|
The JNDI name that modules use to access this mail session. (string)
|
||
|
|
|
restartTarget
:
STRING
|
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource (boolean) default(false)
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
targetRestartPolicy
:
STRING
|
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true' (enum) values(RESTART, STOP_START) default(RESTART)
|
wls.PersistentStore
| Virtual Type | |
|---|---|
| Type Hierarchy | wls.Resource >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
The persistent store supports persistence to a file-based store or to a JDBC-enabled database.
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
targetRestartPolicy
:
ENUM [RESTART, STOP_START]
= RESTART
|
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true'
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
restartTarget
:
BOOLEAN
= false
|
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 60
|
|
Create Order
|
||
|
|
|
createVerb
:
STRING
= Create
|
|
Create Verb
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 40
|
|
Destroy Order
|
||
|
|
|
destroyVerb
:
STRING
= Destroy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 40
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, _properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyScript, destroyVerb, destroyOrder, jndiName, restartTarget, libraryScripts, discoverOrder, targetRestartPolicy, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
createScript
:
STRING
|
|
Python script invoked to create this resource
|
||
|
|
|
destroyScript
:
STRING
|
|
Python script invoked to destroy this resource
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this resource
|
wls.PersistentStoreSpec
| Type Hierarchy | wls.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.ConfigurationItem, udm.Taggable, udm.Deployable |
The persistent store supports persistence to a file-based store or to a JDBC-enabled database. (deployable)
| Public Properties | ||
|---|---|---|
|
|
|
restartTarget
:
STRING
|
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource (boolean) default(false)
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
targetRestartPolicy
:
STRING
|
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true' (enum) values(RESTART, STOP_START) default(RESTART)
|
wls.Queue
| Type Hierarchy | wls.AbstractQueue >> wls.JmsDestination >> wls.JmsResource >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
A JMS Queue Defines a point-to-point destination type, which are used for asynchronous peer communications. A message delivered to a queue is distributed to only one consumer
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
jmsModuleName
:
STRING
|
|
Existing or new Jms system module which will be used to hold this resource
|
||
|
|
|
jndiName
:
STRING
|
|
Global JNDI name used to look up the destination within the JNDI namespace
|
||
|
|
|
DeliveryFailureParams_RedeliveryLimit
:
INTEGER
= -1
|
|
Number of redelivery tries a message can have before it is moved to the error destination
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
|
|
Target error destination for messages that have expired or reached their redelivery limit
|
||
|
|
|
subDeploymentName
:
STRING
|
|
Subdeployment name, if null the deployment name is generated by Deployit using the following pattern, ${deployed.jmsModuleName}-subdeployment-for-${deployed.name}
|
| Hidden Properties | ||
|---|---|---|
|
|
|
additionalPropertiesNotToExpose
:
STRING
= libraryScripts, discoverOrder, discoverScript
|
|
Additional Properties Not To Expose
|
||
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 60
|
|
Create Order
|
||
|
|
|
createScript
:
STRING
= wls/jms/create-queue.py
|
|
Python script invoked to create this resource
|
||
|
|
|
createVerb
:
STRING
= Create
|
|
Create Verb
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 40
|
|
Destroy Order
|
||
|
|
|
destroyScript
:
STRING
= wls/jms/destroy-queue.py
|
|
Python script invoked to destroy this resource
|
||
|
|
|
destroyVerb
:
STRING
= Destroy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
discoverScript
:
STRING
= wls/jms/discover-inspect-queues.py
|
|
Python WLST script invoked to inspect a JMS Queue.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
= [wls/jms/discover-inspect-queues-lib.py]
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 40
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
setErrorDestinationOrder
:
INTEGER
= 61
|
|
Set Error Destination Order
|
||
|
|
|
setErrorDestinationScript
:
STRING
= wls/jms/set-error-queue.py
|
|
Python script invoked to set error destination on this jms resource
|
||
|
|
|
setErrorDestinationVerb
:
STRING
= Set error queue for
|
|
Set Error Destination Verb
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, jndiName, jmsModuleName, subDeploymentName, errorDestination, setErrorDestinationScript, setErrorDestinationVerb, setErrorDestinationOrder, unsetErrorDestinationVerb, unsetErrorDestinationOrder, unsetErrorDestinationScript, restartTarget, libraryScripts, discoverOrder, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
unsetErrorDestinationOrder
:
INTEGER
= 37
|
|
Unset Error Destination Order
|
||
|
|
|
unsetErrorDestinationScript
:
STRING
= wls/jms/unset-error-queue.py
|
|
Python script invoked to unset error destination from this jms resource
|
||
|
|
|
unsetErrorDestinationVerb
:
STRING
= Unset error queue from =
|
|
Unset Error Destination Verb
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this resource
|
wls.QueueSpec
| Type Hierarchy | wls.JmsResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.ConfigurationItem, udm.Taggable, udm.Deployable |
Specification for a JMS Queue
| Public Properties | ||
|---|---|---|
|
|
|
DeliveryFailureParams_RedeliveryLimit
:
STRING
|
|
Number of redelivery tries a message can have before it is moved to the error destination (integer) default(-1)
|
||
|
|
|
jmsModuleName
:
STRING
|
|
Existing or new Jms system module which will be used to hold this resource (string)
|
||
|
|
|
jndiName
:
STRING
|
|
Global JNDI name used to look up the destination within the JNDI namespace (string)
|
||
|
|
|
subDeploymentName
:
STRING
|
|
Subdeployment name, if null the deployment name is generated by Deployit using the following pattern, ${deployed.jmsModuleName}-subdeployment-for-${deployed.name} (string)
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
wls.Resource
| Virtual Type | |
|---|---|
| Type Hierarchy | wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
Base deployed of all Resources
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
targetRestartPolicy
:
ENUM [RESTART, STOP_START]
= RESTART
|
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true'
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
restartTarget
:
BOOLEAN
= false
|
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 60
|
|
Create Order
|
||
|
|
|
createVerb
:
STRING
= Create
|
|
Create Verb
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 40
|
|
Destroy Order
|
||
|
|
|
destroyVerb
:
STRING
= Destroy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 40
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, _properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyScript, destroyVerb, destroyOrder, jndiName, restartTarget, libraryScripts, discoverOrder, targetRestartPolicy, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
createScript
:
STRING
|
|
Python script invoked to create this resource
|
||
|
|
|
destroyScript
:
STRING
|
|
Python script invoked to destroy this resource
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this resource
|
wls.ResourceSpec
| Virtual Type | |
|---|---|
| Type Hierarchy | udm.BaseDeployable >> udm.BaseConfigurationItem |
| Interfaces | udm.ConfigurationItem, udm.Taggable, udm.Deployable |
Base deployable of all Resources
| Public Properties | ||
|---|---|---|
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
wls.Server
| Type Hierarchy | udm.BaseContainer >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | python.PythonManagedContainer, wls.WlsContainer, udm.Container, udm.ConfigurationItem, overthere.HostContainer, udm.Taggable, wls.JmsTarget |
WebLogic Server that runs in its own Java Virtual Machine (JVM) and has its own configuration
| Parent | ||
|---|---|---|
|
|
|
|
|
WebLogic domain to which this server belongs. 'asContainment'=true, means a Server is 'contained' under a Domain
|
| Public Properties | ||
|---|---|---|
|
|
|
maxRetries
:
INTEGER
= 10
|
|
Number of times to attempt executing the test, in case the step fails
|
||
|
|
|
port
:
INTEGER
= 0
|
|
Port for the server runs on
|
||
|
|
|
retryWaitInterval
:
INTEGER
= 5
|
|
Time in seconds to wait before next retry
|
||
|
|
|
startDelay
:
INTEGER
= 5
|
|
Time in seconds to wait before starting the execution of the verify step
|
||
|
|
|
envVars
:
MAP_STRING_STRING
|
|
Environment variables for server
|
||
|
|
|
host
:
CI<overthere.Host>
|
|
Host on which this server is running, needed to perform no-stage deployments and to start the server via a script
|
||
|
|
|
startCommand
:
STRING
|
|
Command that should be executed to start the managed server.
|
||
|
|
|
stopCommand
:
STRING
|
|
Command that should be executed to stop the managed server.
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, only deployables with the same tag will be automatically mapped to this container.
|
||
|
|
|
testServerIsRunning
:
BOOLEAN
= true
|
|
Test Server Is Running
|
| Hidden Properties | ||
|---|---|---|
|
|
|
startOrder
:
INTEGER
= 80
|
|
Start Order
|
||
|
|
|
startScript
:
STRING
= wls/server/start-script
|
|
Start Script
|
||
|
|
|
startWaitTime
:
INTEGER
= 1
|
|
The time to wait in seconds for a container start action.
|
||
|
|
|
stopOrder
:
INTEGER
= 20
|
|
Stop Order
|
||
|
|
|
stopScript
:
STRING
= wls/server/stop-script
|
|
Stop Script
|
| Control task | Parameter CI | Attributes | Description |
|---|---|---|---|
| start |
No description. |
||
| stop |
No description. |
wls.SharedLibraryJar
| Type Hierarchy | generic.Archive >> udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.ArchiveArtifact, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact |
A JEE Jar library archive
| Public Properties | ||
|---|---|---|
|
|
|
automaticVersioning
:
STRING
|
|
If set, the 'versionIdentifier' property is managed by the plugin. Any value explicitly set for 'versionIdentifier' is ignored. 'automaticVersioning' is enabled by default, in which case a unique version is created for the deployed module. If the manifest file includes an implementation version, then you must disable 'automaticVersioning'. If your manifest file includes a specification version and you want to use the implementation version that is defined in the manifest file, then you must set 'automaticVersioning' to false and enter the specification version as the 'versionIdentifier' property on the CI. (boolean) default(true)
|
||
|
|
|
block
:
STRING
|
|
boolean value specifying whether the deployment should block user interaction until the command complete (boolean) default(true)
|
||
|
|
|
checksum
:
STRING
|
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
|
deploymentOrder
:
STRING
|
|
By default, new applications and modules are configured with a Deployment Order value of 100 (integer) default(100)
|
||
|
|
|
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
|
||
|
|
|
planPath
:
STRING
|
|
Name of the deployment plan file. The filename can be absolute or relative to the application directory. (string)
|
||
|
|
|
redeploymentStrategy
:
STRING
|
|
Indicates what redeployment strategy to use for upgrading the application. Possible values: CLASSIC, STOP_START, SIDE_BY_SIDE (enum) values(CLASSIC, STOP_START, SIDE_BY_SIDE) default(CLASSIC)
|
||
|
|
|
retireTimeout
:
STRING
|
|
Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy (integer) default(-1)
|
||
|
|
|
scanPlaceholders
:
BOOLEAN
= false
|
|
Whether to scan this artifact for placeholders when it is imported
|
||
|
|
|
stageMode
:
STRING
|
|
Indicates whether the artifact will be deployed as staged or nostage mode (enum) values(Stage, NoStage) default(Stage)
|
||
|
|
|
stagingDirectory
:
STRING
|
|
Absolute directory path where the artifact will be uploaded and used by the servers for nostage deployment mode (string)
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
versionIdentifier
:
STRING
|
|
Version Identifier (string)
|
| 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
|
||
|
|
|
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
|
wls.SharedLibraryJarModule
| Type Hierarchy | wls.ExtensibleDeployedSharedLibrary >> wls.ExtensibleDeployedArtifact >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem |
The Java EE library feature provides an easy way to share one or more types of Java EE modules among multiple Enterprise Applications. In particular, a Java EE library is a stand-alone EJB or Web Application module, multiple EJB or Web Application modules packaged in an Enterprise Application (EAR), or a single plain JAR file that is registered with the Java EE application container upon deployment
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
deploymentOrder
:
INTEGER
= 100
|
|
By default, new applications and modules are configured with a Deployment Order value of 100
|
||
|
|
|
redeploymentStrategy
:
ENUM [CLASSIC, STOP_START, SIDE_BY_SIDE]
= CLASSIC
|
|
Indicates what redeployment strategy to use for upgrading the application. Possible values: CLASSIC, STOP_START, SIDE_BY_SIDE
|
||
|
|
|
retireTimeout
:
INTEGER
= -1
|
|
Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy
|
||
|
|
|
automaticVersioning
:
BOOLEAN
= true
|
|
If set, the 'versionIdentifier' property is managed by the plugin. Any value explicitly set for 'versionIdentifier' is ignored. 'automaticVersioning' is enabled by default, in which case a unique version is created for the deployed module. If the manifest file includes an implementation version, then you must disable 'automaticVersioning'. If your manifest file includes a specification version and you want to use the implementation version that is defined in the manifest file, then you must set 'automaticVersioning' to false and enter the specification version as the 'versionIdentifier' property on the CI.
|
||
|
|
|
block
:
BOOLEAN
= true
|
|
boolean value specifying whether the deployment should block user interaction until the command complete
|
||
|
|
|
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>
|
||
|
|
|
planPath
:
STRING
|
|
Name of the deployment plan file. The filename can be absolute or relative to the application directory.
|
||
|
|
|
stageMode
:
ENUM [Stage, NoStage]
= Stage
|
|
Indicates whether the artifact will be deployed as staged or nostage mode
|
||
|
|
|
stagingDirectory
:
STRING
|
|
Absolute directory path where the artifact will be uploaded and used by the servers for nostage deployment mode
|
||
|
|
|
versionIdentifier
:
STRING
|
|
Version Identifier
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 68
|
|
Create Order
|
||
|
|
|
createScript
:
STRING
= wls/application/deploy-application.py
|
|
Python script invoked to deploy this Java EE artifact
|
||
|
|
|
createVerb
:
STRING
= Deploy
|
|
Create Verb
|
||
|
|
|
deleteArtifactOrder
:
INTEGER
= 31
|
|
Delete Artifact Order
|
||
|
|
|
deleteRetiredArtifactOrder
:
INTEGER
= 99
|
|
Delete Retired Artifact Order
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 32
|
|
Destroy Order
|
||
|
|
|
destroyScript
:
STRING
= wls/application/undeploy-application.py
|
|
Python script invoked to undeploy this Java EE artifact
|
||
|
|
|
destroyVerb
:
STRING
= Undeploy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
isRunningRetryWaitInterval
:
INTEGER
= 500
|
|
Time in milliseconds to wait before next retry to check if the deployment is still running
|
||
|
|
|
libraryModule
:
STRING
= true
|
|
Library Module
|
||
|
|
|
manifestVersionProperty
:
STRING
= Extension-Name
|
|
Property in the manifest file of the archive indicating that it is a versioned artifact. You can override this property in XLDEPLOY_HOME/conf/deployit-defaults.properties. For example: wls.WarModule.manifestVersionProperty=Weblogic-Application-Version.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 60
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
runtimeDependenciesTypes
:
LIST_OF_STRING
= [wls.EarModule, wls.WarModule]
|
|
Runtime Dependencies Types
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, deployable, properties, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, deleteArtifactOrder, startScript, startVerb, startOrder, stopScript, stopVerb, stopOrder, deploymentStrategy, placeholders, file, redeploymentStrategy, securityPermissions, inheritPermissions, exposeDeployedApplication, stopRetiredApplicationOrder, undeployRetiredApplicationOrder, deleteRetiredArtifactOrder, isRunningRetryWaitInterval, wlstPath, libraryScripts, discoverOrder, deploymentOrder, isStartOrStopOperationRequired, automaticVersioning, createOptions, modifyOptions, destroyOptions, noopOptions, manifestVersionProperty, versionTemplateFile, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
startOrder
:
INTEGER
= 90
|
|
Start Order
|
||
|
|
|
startScript
:
STRING
= wls/application/start-application.py
|
|
Python script invoked to start this Java EE artifact
|
||
|
|
|
startVerb
:
STRING
= Start
|
|
Start Verb
|
||
|
|
|
stopOrder
:
INTEGER
= 10
|
|
Stop Order
|
||
|
|
|
stopRetiredApplicationOrder
:
INTEGER
= 95
|
|
Stop Retired Application Order
|
||
|
|
|
stopScript
:
STRING
= wls/application/stop-application.py
|
|
Python script invoked to stop this Java EE artifact
|
||
|
|
|
stopVerb
:
STRING
= Stop
|
|
Stop Verb
|
||
|
|
|
undeployRetiredApplicationOrder
:
INTEGER
= 98
|
|
Undeploy Retired Application Order
|
||
|
|
|
versionExpression
:
STRING
= [#ftl]${manifestAttributes["Specification-Version"]}[#if manifestAttributes["Implementation-Version"]??]@${manifestAttributes["Implementation-Version"]}[/#if]
|
|
FreeMarker expression used to build the version based on the manifest file (properties are put in a map named 'manifestAttributes'). You can override this property in XLDEPLOY_HOME/conf/deployit-defaults.properties. For example: wls.WarModule.versionExpression=${manifestAttributes['Weblogic-Application-Version']}.
|
||
|
|
|
wlstPath
:
STRING
= Libraries
|
|
Wlst Path
|
||
|
|
|
activationTimeout
:
INTEGER
= -10
|
|
Time (in milliseconds) that WLST waits for the activation of configuration changes to complete before canceling the operation. A value of -1 indicates that the operation will not time out. A value of -10 indicates that this parameter will not be taken into account and server set default will be used. This argument normally defaults to 300,000 ms (or 5 minutes).
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
isStartOrStopOperationRequired
:
BOOLEAN
= false
|
|
Is Start Or Stop Operation Required
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this Java EE artifact
|
||
|
|
|
versioned
:
BOOLEAN
= true
|
|
Indicates wither this artifact is to be deployed as a versioned application
|
wls.SharedLibraryWar
| Type Hierarchy | jee.War >> udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.ArchiveArtifact, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact |
A JEE War library archive
| Public Properties | ||
|---|---|---|
|
|
|
automaticVersioning
:
STRING
|
|
If set, the 'versionIdentifier' property is managed by the plugin. Any value explicitly set for 'versionIdentifier' is ignored. 'automaticVersioning' is enabled by default, in which case a unique version is created for the deployed module. If the manifest file includes an implementation version, then you must disable 'automaticVersioning'. If your manifest file includes a specification version and you want to use the implementation version that is defined in the manifest file, then you must set 'automaticVersioning' to false and enter the specification version as the 'versionIdentifier' property on the CI. (boolean) default(true)
|
||
|
|
|
block
:
STRING
|
|
boolean value specifying whether the deployment should block user interaction until the command complete (boolean) default(true)
|
||
|
|
|
checksum
:
STRING
|
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
|
deploymentOrder
:
STRING
|
|
By default, new applications and modules are configured with a Deployment Order value of 100 (integer) default(100)
|
||
|
|
|
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
|
||
|
|
|
planPath
:
STRING
|
|
Name of the deployment plan file. The filename can be absolute or relative to the application directory. (string)
|
||
|
|
|
redeploymentStrategy
:
STRING
|
|
Indicates what redeployment strategy to use for upgrading the application. Possible values: CLASSIC, STOP_START, SIDE_BY_SIDE (enum) values(CLASSIC, STOP_START, SIDE_BY_SIDE) default(CLASSIC)
|
||
|
|
|
retireTimeout
:
STRING
|
|
Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy (integer) default(-1)
|
||
|
|
|
scanPlaceholders
:
BOOLEAN
= false
|
|
Whether to scan this artifact for placeholders when it is imported
|
||
|
|
|
stageMode
:
STRING
|
|
Indicates whether the artifact will be deployed as staged or nostage mode (enum) values(Stage, NoStage) default(Stage)
|
||
|
|
|
stagingDirectory
:
STRING
|
|
Absolute directory path where the artifact will be uploaded and used by the servers for nostage deployment mode (string)
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
versionIdentifier
:
STRING
|
|
Version Identifier (string)
|
| 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
|
||
|
|
|
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
|
wls.SharedLibraryWarModule
| Type Hierarchy | wls.ExtensibleDeployedSharedLibrary >> wls.ExtensibleDeployedArtifact >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem |
The Java EE library feature provides an easy way to share one or more types of Java EE modules among multiple Enterprise Applications. In particular, a Java EE library is a stand-alone EJB or Web Application module, multiple EJB or Web Application modules packaged in an Enterprise Application (EAR), or a single plain JAR file that is registered with the Java EE application container upon deployment
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
deploymentOrder
:
INTEGER
= 100
|
|
By default, new applications and modules are configured with a Deployment Order value of 100
|
||
|
|
|
redeploymentStrategy
:
ENUM [CLASSIC, STOP_START, SIDE_BY_SIDE]
= CLASSIC
|
|
Indicates what redeployment strategy to use for upgrading the application. Possible values: CLASSIC, STOP_START, SIDE_BY_SIDE
|
||
|
|
|
retireTimeout
:
INTEGER
= -1
|
|
Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy
|
||
|
|
|
automaticVersioning
:
BOOLEAN
= true
|
|
If set, the 'versionIdentifier' property is managed by the plugin. Any value explicitly set for 'versionIdentifier' is ignored. 'automaticVersioning' is enabled by default, in which case a unique version is created for the deployed module. If the manifest file includes an implementation version, then you must disable 'automaticVersioning'. If your manifest file includes a specification version and you want to use the implementation version that is defined in the manifest file, then you must set 'automaticVersioning' to false and enter the specification version as the 'versionIdentifier' property on the CI.
|
||
|
|
|
block
:
BOOLEAN
= true
|
|
boolean value specifying whether the deployment should block user interaction until the command complete
|
||
|
|
|
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>
|
||
|
|
|
planPath
:
STRING
|
|
Name of the deployment plan file. The filename can be absolute or relative to the application directory.
|
||
|
|
|
stageMode
:
ENUM [Stage, NoStage]
= Stage
|
|
Indicates whether the artifact will be deployed as staged or nostage mode
|
||
|
|
|
stagingDirectory
:
STRING
|
|
Absolute directory path where the artifact will be uploaded and used by the servers for nostage deployment mode
|
||
|
|
|
versionIdentifier
:
STRING
|
|
Version Identifier
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 70
|
|
Create Order
|
||
|
|
|
createScript
:
STRING
= wls/application/deploy-application.py
|
|
Python script invoked to deploy this Java EE artifact
|
||
|
|
|
createVerb
:
STRING
= Deploy
|
|
Create Verb
|
||
|
|
|
deleteArtifactOrder
:
INTEGER
= 31
|
|
Delete Artifact Order
|
||
|
|
|
deleteRetiredArtifactOrder
:
INTEGER
= 99
|
|
Delete Retired Artifact Order
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 30
|
|
Destroy Order
|
||
|
|
|
destroyScript
:
STRING
= wls/application/undeploy-application.py
|
|
Python script invoked to undeploy this Java EE artifact
|
||
|
|
|
destroyVerb
:
STRING
= Undeploy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
isRunningRetryWaitInterval
:
INTEGER
= 500
|
|
Time in milliseconds to wait before next retry to check if the deployment is still running
|
||
|
|
|
libraryModule
:
STRING
= true
|
|
Library Module
|
||
|
|
|
manifestVersionProperty
:
STRING
= Extension-Name
|
|
Property in the manifest file of the archive indicating that it is a versioned artifact. You can override this property in XLDEPLOY_HOME/conf/deployit-defaults.properties. For example: wls.WarModule.manifestVersionProperty=Weblogic-Application-Version.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 60
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
runtimeDependenciesTypes
:
LIST_OF_STRING
= [wls.EarModule, wls.WarModule]
|
|
Runtime Dependencies Types
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, deployable, properties, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, deleteArtifactOrder, startScript, startVerb, startOrder, stopScript, stopVerb, stopOrder, deploymentStrategy, placeholders, file, redeploymentStrategy, securityPermissions, inheritPermissions, exposeDeployedApplication, stopRetiredApplicationOrder, undeployRetiredApplicationOrder, deleteRetiredArtifactOrder, isRunningRetryWaitInterval, wlstPath, libraryScripts, discoverOrder, deploymentOrder, isStartOrStopOperationRequired, automaticVersioning, createOptions, modifyOptions, destroyOptions, noopOptions, manifestVersionProperty, versionTemplateFile, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
startOrder
:
INTEGER
= 90
|
|
Start Order
|
||
|
|
|
startScript
:
STRING
= wls/application/start-application.py
|
|
Python script invoked to start this Java EE artifact
|
||
|
|
|
startVerb
:
STRING
= Start
|
|
Start Verb
|
||
|
|
|
stopOrder
:
INTEGER
= 10
|
|
Stop Order
|
||
|
|
|
stopRetiredApplicationOrder
:
INTEGER
= 95
|
|
Stop Retired Application Order
|
||
|
|
|
stopScript
:
STRING
= wls/application/stop-application.py
|
|
Python script invoked to stop this Java EE artifact
|
||
|
|
|
stopVerb
:
STRING
= Stop
|
|
Stop Verb
|
||
|
|
|
undeployRetiredApplicationOrder
:
INTEGER
= 98
|
|
Undeploy Retired Application Order
|
||
|
|
|
versionExpression
:
STRING
= [#ftl]${manifestAttributes["Specification-Version"]}[#if manifestAttributes["Implementation-Version"]??]@${manifestAttributes["Implementation-Version"]}[/#if]
|
|
FreeMarker expression used to build the version based on the manifest file (properties are put in a map named 'manifestAttributes'). You can override this property in XLDEPLOY_HOME/conf/deployit-defaults.properties. For example: wls.WarModule.versionExpression=${manifestAttributes['Weblogic-Application-Version']}.
|
||
|
|
|
wlstPath
:
STRING
= Libraries
|
|
Wlst Path
|
||
|
|
|
activationTimeout
:
INTEGER
= -10
|
|
Time (in milliseconds) that WLST waits for the activation of configuration changes to complete before canceling the operation. A value of -1 indicates that the operation will not time out. A value of -10 indicates that this parameter will not be taken into account and server set default will be used. This argument normally defaults to 300,000 ms (or 5 minutes).
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
isStartOrStopOperationRequired
:
BOOLEAN
= false
|
|
Is Start Or Stop Operation Required
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this Java EE artifact
|
||
|
|
|
versioned
:
BOOLEAN
= true
|
|
Indicates wither this artifact is to be deployed as a versioned application
|
wls.Topic
| Type Hierarchy | wls.AbstractTopic >> wls.JmsDestination >> wls.JmsResource >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
A JMS Topic Defines a topic destination type, which are used for asynchronous peer communications. A message delivered to a queue is distributed to only or many consumers
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
jmsModuleName
:
STRING
|
|
Existing or new Jms system module which will be used to hold this resource
|
||
|
|
|
jndiName
:
STRING
|
|
Global JNDI name used to look up the destination within the JNDI namespace
|
||
|
|
|
DeliveryFailureParams_RedeliveryLimit
:
INTEGER
= -1
|
|
Number of redelivery tries a message can have before it is moved to the error destination
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
|
|
Target error destination for messages that have expired or reached their redelivery limit
|
||
|
|
|
subDeploymentName
:
STRING
|
|
Subdeployment name, if null the deployment name is generated by Deployit using the following pattern, ${deployed.jmsModuleName}-subdeployment-for-${deployed.name}
|
| Hidden Properties | ||
|---|---|---|
|
|
|
additionalPropertiesNotToExpose
:
STRING
= libraryScripts, discoverOrder
|
|
Additional Properties Not To Expose
|
||
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 60
|
|
Create Order
|
||
|
|
|
createScript
:
STRING
= wls/jms/create-topic.py
|
|
Python script invoked to create this resource
|
||
|
|
|
createVerb
:
STRING
= Create
|
|
Create Verb
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 40
|
|
Destroy Order
|
||
|
|
|
destroyScript
:
STRING
= wls/jms/destroy-topic.py
|
|
Python script invoked to destroy this resource
|
||
|
|
|
destroyVerb
:
STRING
= Destroy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 40
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
setErrorDestinationOrder
:
INTEGER
= 61
|
|
Set Error Destination Order
|
||
|
|
|
setErrorDestinationScript
:
STRING
= wls/jms/set-error-topic.py
|
|
Python script invoked to set error destination on this jms resource
|
||
|
|
|
setErrorDestinationVerb
:
STRING
= Set error queue for
|
|
Set Error Destination Verb
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, jndiName, jmsModuleName, subDeploymentName, errorDestination, setErrorDestinationScript, setErrorDestinationVerb, setErrorDestinationOrder, unsetErrorDestinationVerb, unsetErrorDestinationOrder, unsetErrorDestinationScript, restartTarget, libraryScripts, discoverOrder, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
unsetErrorDestinationOrder
:
INTEGER
= 37
|
|
Unset Error Destination Order
|
||
|
|
|
unsetErrorDestinationScript
:
STRING
= wls/jms/unset-error-topic.py
|
|
Python script invoked to unset error destination from this jms resource
|
||
|
|
|
unsetErrorDestinationVerb
:
STRING
= Unset error queue from =
|
|
Unset Error Destination Verb
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this resource
|
wls.TopicSpec
| Type Hierarchy | wls.JmsResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.ConfigurationItem, udm.Taggable, udm.Deployable |
Specification for a JMS Topic
| Public Properties | ||
|---|---|---|
|
|
|
DeliveryFailureParams_RedeliveryLimit
:
STRING
|
|
Number of redelivery tries a message can have before it is moved to the error destination (integer) default(-1)
|
||
|
|
|
jmsModuleName
:
STRING
|
|
Existing or new Jms system module which will be used to hold this resource (string)
|
||
|
|
|
jndiName
:
STRING
|
|
Global JNDI name used to look up the destination within the JNDI namespace (string)
|
||
|
|
|
subDeploymentName
:
STRING
|
|
Subdeployment name, if null the deployment name is generated by Deployit using the following pattern, ${deployed.jmsModuleName}-subdeployment-for-${deployed.name} (string)
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
wls.UniformDistributedQueue
| Type Hierarchy | wls.AbstractUniformDistributedQueue >> wls.JmsDestination >> wls.JmsResource >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
A distributed Queue defines a set of queues that are distributed on multiple JMS servers, but which are accessible as a single, logical queue to JMS clients
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
jmsModuleName
:
STRING
|
|
Existing or new Jms system module which will be used to hold this resource
|
||
|
|
|
jndiName
:
STRING
|
|
Global JNDI name used to look up the destination within the JNDI namespace
|
||
|
|
|
DeliveryFailureParams_RedeliveryLimit
:
INTEGER
= -1
|
|
Number of redelivery tries a message can have before it is moved to the error destination
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
|
|
Target error destination for messages that have expired or reached their redelivery limit
|
||
|
|
|
subDeploymentName
:
STRING
|
|
Subdeployment name, if null the deployment name is generated by Deployit using the following pattern, ${deployed.jmsModuleName}-subdeployment-for-${deployed.name}
|
| Hidden Properties | ||
|---|---|---|
|
|
|
additionalPropertiesNotToExpose
:
STRING
= libraryScripts, discoverOrder
|
|
Additional Properties Not To Expose
|
||
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 60
|
|
Create Order
|
||
|
|
|
createScript
:
STRING
= wls/jms/create-udd-queue.py
|
|
Python script invoked to create this resource
|
||
|
|
|
createVerb
:
STRING
= Create
|
|
Create Verb
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 40
|
|
Destroy Order
|
||
|
|
|
destroyScript
:
STRING
= wls/jms/destroy-udd-queue.py
|
|
Python script invoked to destroy this resource
|
||
|
|
|
destroyVerb
:
STRING
= Destroy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 40
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
setErrorDestinationOrder
:
INTEGER
= 61
|
|
Set Error Destination Order
|
||
|
|
|
setErrorDestinationScript
:
STRING
= wls/jms/set-udd-error-queue.py
|
|
Python script invoked to set error destination on this jms resource
|
||
|
|
|
setErrorDestinationVerb
:
STRING
= Set error queue for
|
|
Set Error Destination Verb
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, jndiName, jmsModuleName, subDeploymentName, errorDestination, setErrorDestinationScript, setErrorDestinationVerb, setErrorDestinationOrder, unsetErrorDestinationVerb, unsetErrorDestinationOrder, unsetErrorDestinationScript, restartTarget, libraryScripts, discoverOrder, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
unsetErrorDestinationOrder
:
INTEGER
= 37
|
|
Unset Error Destination Order
|
||
|
|
|
unsetErrorDestinationScript
:
STRING
= wls/jms/unset-udd-error-queue.py
|
|
Python script invoked to unset error destination from this jms resource
|
||
|
|
|
unsetErrorDestinationVerb
:
STRING
= Unset error queue from =
|
|
Unset Error Destination Verb
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this resource
|
wls.UniformDistributedQueueSpec
| Type Hierarchy | wls.JmsResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.ConfigurationItem, udm.Taggable, udm.Deployable |
Specification for a JMS uniform distributed queue
| Public Properties | ||
|---|---|---|
|
|
|
DeliveryFailureParams_RedeliveryLimit
:
STRING
|
|
Number of redelivery tries a message can have before it is moved to the error destination (integer) default(-1)
|
||
|
|
|
jmsModuleName
:
STRING
|
|
Existing or new Jms system module which will be used to hold this resource (string)
|
||
|
|
|
jndiName
:
STRING
|
|
Global JNDI name used to look up the destination within the JNDI namespace (string)
|
||
|
|
|
subDeploymentName
:
STRING
|
|
Subdeployment name, if null the deployment name is generated by Deployit using the following pattern, ${deployed.jmsModuleName}-subdeployment-for-${deployed.name} (string)
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
wls.UniformDistributedTopic
| Type Hierarchy | wls.AbstractUniformDistributedTopic >> wls.JmsDestination >> wls.JmsResource >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
A distributed Queue defines a set of topics that are distributed on multiple JMS servers, but which are accessible as a single, logical topic to JMS clients
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
jmsModuleName
:
STRING
|
|
Existing or new Jms system module which will be used to hold this resource
|
||
|
|
|
jndiName
:
STRING
|
|
Global JNDI name used to look up the destination within the JNDI namespace
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
|
|
Target error destination for messages that have expired or reached their redelivery limit
|
||
|
|
|
subDeploymentName
:
STRING
|
|
Subdeployment name, if null the deployment name is generated by Deployit using the following pattern, ${deployed.jmsModuleName}-subdeployment-for-${deployed.name}
|
| Hidden Properties | ||
|---|---|---|
|
|
|
additionalPropertiesNotToExpose
:
STRING
= libraryScripts, discoverOrder
|
|
Additional Properties Not To Expose
|
||
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 60
|
|
Create Order
|
||
|
|
|
createScript
:
STRING
= wls/jms/create-udd-topic.py
|
|
Python script invoked to create this resource
|
||
|
|
|
createVerb
:
STRING
= Create
|
|
Create Verb
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 40
|
|
Destroy Order
|
||
|
|
|
destroyScript
:
STRING
= wls/jms/destroy-udd-topic.py
|
|
Python script invoked to destroy this resource
|
||
|
|
|
destroyVerb
:
STRING
= Destroy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 40
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
setErrorDestinationOrder
:
INTEGER
= 61
|
|
Set Error Destination Order
|
||
|
|
|
setErrorDestinationScript
:
STRING
= wls/jms/set-udd-error-topic.py
|
|
Python script invoked to set error destination on this jms resource
|
||
|
|
|
setErrorDestinationVerb
:
STRING
= Set error queue for
|
|
Set Error Destination Verb
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, jndiName, jmsModuleName, subDeploymentName, errorDestination, setErrorDestinationScript, setErrorDestinationVerb, setErrorDestinationOrder, unsetErrorDestinationVerb, unsetErrorDestinationOrder, unsetErrorDestinationScript, restartTarget, libraryScripts, discoverOrder, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
unsetErrorDestinationOrder
:
INTEGER
= 37
|
|
Unset Error Destination Order
|
||
|
|
|
unsetErrorDestinationScript
:
STRING
= wls/jms/unset-udd-error-topic.py
|
|
Python script invoked to unset error destination from this jms resource
|
||
|
|
|
unsetErrorDestinationVerb
:
STRING
= Unset error queue from =
|
|
Unset Error Destination Verb
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this resource
|
wls.UniformDistributedTopicSpec
| Type Hierarchy | wls.JmsResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.ConfigurationItem, udm.Taggable, udm.Deployable |
Specification for a JMS uniform distributed topic
| Public Properties | ||
|---|---|---|
|
|
|
jmsModuleName
:
STRING
|
|
Existing or new Jms system module which will be used to hold this resource (string)
|
||
|
|
|
jndiName
:
STRING
|
|
Global JNDI name used to look up the destination within the JNDI namespace (string)
|
||
|
|
|
subDeploymentName
:
STRING
|
|
Subdeployment name, if null the deployment name is generated by Deployit using the following pattern, ${deployed.jmsModuleName}-subdeployment-for-${deployed.name} (string)
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
wls.War
| Type Hierarchy | jee.War >> udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.ArchiveArtifact, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact |
A JEE WAR archive
| Public Properties | ||
|---|---|---|
|
|
|
automaticVersioning
:
STRING
|
|
If set, the 'versionIdentifier' property is managed by the plugin. Any value explicitly set for 'versionIdentifier' is ignored. 'automaticVersioning' is enabled by default, in which case a unique version is created for the deployed module. If the manifest file includes an implementation version, then you must disable 'automaticVersioning'. If your manifest file includes a specification version and you want to use the implementation version that is defined in the manifest file, then you must set 'automaticVersioning' to false and enter the specification version as the 'versionIdentifier' property on the CI. (boolean) default(true)
|
||
|
|
|
block
:
STRING
|
|
boolean value specifying whether the deployment should block user interaction until the command complete (boolean) default(true)
|
||
|
|
|
checksum
:
STRING
|
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
|
deploymentOrder
:
STRING
|
|
By default, new applications and modules are configured with a Deployment Order value of 100 (integer) default(100)
|
||
|
|
|
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
|
||
|
|
|
planPath
:
STRING
|
|
Name of the deployment plan file. The filename can be absolute or relative to the application directory. (string)
|
||
|
|
|
redeploymentStrategy
:
STRING
|
|
Indicates what redeployment strategy to use for upgrading the application. Possible values: CLASSIC, STOP_START, SIDE_BY_SIDE (enum) values(CLASSIC, STOP_START, SIDE_BY_SIDE) default(CLASSIC)
|
||
|
|
|
retireTimeout
:
STRING
|
|
Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy (integer) default(-1)
|
||
|
|
|
scanPlaceholders
:
BOOLEAN
= false
|
|
Whether to scan this artifact for placeholders when it is imported
|
||
|
|
|
sharedLibraries
:
STRING
|
|
Shared Libraries
|
||
|
|
|
stageMode
:
STRING
|
|
Indicates whether the artifact will be deployed as staged or nostage mode (enum) values(Stage, NoStage) default(Stage)
|
||
|
|
|
stagingDirectory
:
STRING
|
|
Absolute directory path where the artifact will be uploaded and used by the servers for nostage deployment mode (string)
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
versionIdentifier
:
STRING
|
|
Version Identifier (string)
|
||
|
|
|
versioned
:
STRING
|
|
Indicates wither this artifact is to be deployed as a versioned application (boolean) default(false)
|
| 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
|
||
|
|
|
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
|
wls.WarModule
| Type Hierarchy | wls.ExtensibleDeployedArtifact >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem |
War with values configured for a deployment
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
deploymentOrder
:
INTEGER
= 100
|
|
By default, new applications and modules are configured with a Deployment Order value of 100
|
||
|
|
|
redeploymentStrategy
:
ENUM [CLASSIC, STOP_START, SIDE_BY_SIDE]
= CLASSIC
|
|
Indicates what redeployment strategy to use for upgrading the application. Possible values: CLASSIC, STOP_START, SIDE_BY_SIDE
|
||
|
|
|
retireTimeout
:
INTEGER
= -1
|
|
Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy
|
||
|
|
|
automaticVersioning
:
BOOLEAN
= true
|
|
If set, the 'versionIdentifier' property is managed by the plugin. Any value explicitly set for 'versionIdentifier' is ignored. 'automaticVersioning' is enabled by default, in which case a unique version is created for the deployed module. If the manifest file includes an implementation version, then you must disable 'automaticVersioning'. If your manifest file includes a specification version and you want to use the implementation version that is defined in the manifest file, then you must set 'automaticVersioning' to false and enter the specification version as the 'versionIdentifier' property on the CI.
|
||
|
|
|
block
:
BOOLEAN
= true
|
|
boolean value specifying whether the deployment should block user interaction until the command complete
|
||
|
|
|
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>
|
||
|
|
|
planPath
:
STRING
|
|
Name of the deployment plan file. The filename can be absolute or relative to the application directory.
|
||
|
|
|
|
|
Shared Libraries
|
||
|
|
|
stageMode
:
ENUM [Stage, NoStage]
= Stage
|
|
Indicates whether the artifact will be deployed as staged or nostage mode
|
||
|
|
|
stagingDirectory
:
STRING
|
|
Absolute directory path where the artifact will be uploaded and used by the servers for nostage deployment mode
|
||
|
|
|
versionIdentifier
:
STRING
|
|
Version Identifier
|
||
|
|
|
versioned
:
BOOLEAN
= false
|
|
Indicates wither this artifact is to be deployed as a versioned application
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder
:
INTEGER
= 70
|
|
Create Order
|
||
|
|
|
createScript
:
STRING
= wls/application/deploy-application.py
|
|
Python script invoked to deploy this Java EE artifact
|
||
|
|
|
createVerb
:
STRING
= Deploy
|
|
Create Verb
|
||
|
|
|
deleteArtifactOrder
:
INTEGER
= 31
|
|
Delete Artifact Order
|
||
|
|
|
deleteRetiredArtifactOrder
:
INTEGER
= 99
|
|
Delete Retired Artifact Order
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder
:
INTEGER
= 30
|
|
Destroy Order
|
||
|
|
|
destroyScript
:
STRING
= wls/application/undeploy-application.py
|
|
Python script invoked to undeploy this Java EE artifact
|
||
|
|
|
destroyVerb
:
STRING
= Undeploy
|
|
Destroy Verb
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
The order in which a discover step will be executed.
|
||
|
|
|
isRunningRetryWaitInterval
:
INTEGER
= 500
|
|
Time in milliseconds to wait before next retry to check if the deployment is still running
|
||
|
|
|
manifestVersionProperty
:
STRING
= Extension-Name
|
|
Property in the manifest file of the archive indicating that it is a versioned artifact. You can override this property in XLDEPLOY_HOME/conf/deployit-defaults.properties. For example: wls.WarModule.manifestVersionProperty=Weblogic-Application-Version.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder
:
INTEGER
= 60
|
|
Modify Order
|
||
|
|
|
modifyVerb
:
STRING
= Upgrade
|
|
Modify Verb
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
standardPropertiesNotToExpose
:
STRING
= id, name, type, deployable, properties, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, deleteArtifactOrder, startScript, startVerb, startOrder, stopScript, stopVerb, stopOrder, deploymentStrategy, placeholders, file, redeploymentStrategy, securityPermissions, inheritPermissions, exposeDeployedApplication, stopRetiredApplicationOrder, undeployRetiredApplicationOrder, deleteRetiredArtifactOrder, isRunningRetryWaitInterval, wlstPath, libraryScripts, discoverOrder, deploymentOrder, isStartOrStopOperationRequired, automaticVersioning, createOptions, modifyOptions, destroyOptions, noopOptions, manifestVersionProperty, versionTemplateFile, provisioners, ordinal, boundConfigurationItems
|
|
Standard Properties Not To Expose
|
||
|
|
|
startOrder
:
INTEGER
= 90
|
|
Start Order
|
||
|
|
|
startScript
:
STRING
= wls/application/start-application.py
|
|
Python script invoked to start this Java EE artifact
|
||
|
|
|
startVerb
:
STRING
= Start
|
|
Start Verb
|
||
|
|
|
stopOrder
:
INTEGER
= 10
|
|
Stop Order
|
||
|
|
|
stopRetiredApplicationOrder
:
INTEGER
= 95
|
|
Stop Retired Application Order
|
||
|
|
|
stopScript
:
STRING
= wls/application/stop-application.py
|
|
Python script invoked to stop this Java EE artifact
|
||
|
|
|
stopVerb
:
STRING
= Stop
|
|
Stop Verb
|
||
|
|
|
undeployRetiredApplicationOrder
:
INTEGER
= 98
|
|
Undeploy Retired Application Order
|
||
|
|
|
versionExpression
:
STRING
= [#ftl]${manifestAttributes["Specification-Version"]}[#if manifestAttributes["Implementation-Version"]??]@${manifestAttributes["Implementation-Version"]}[/#if]
|
|
FreeMarker expression used to build the version based on the manifest file (properties are put in a map named 'manifestAttributes'). You can override this property in XLDEPLOY_HOME/conf/deployit-defaults.properties. For example: wls.WarModule.versionExpression=${manifestAttributes['Weblogic-Application-Version']}.
|
||
|
|
|
wlstPath
:
STRING
= AppDeployments
|
|
Wlst Path
|
||
|
|
|
activationTimeout
:
INTEGER
= -10
|
|
Time (in milliseconds) that WLST waits for the activation of configuration changes to complete before canceling the operation. A value of -1 indicates that the operation will not time out. A value of -10 indicates that this parameter will not be taken into account and server set default will be used. This argument normally defaults to 300,000 ms (or 5 minutes).
|
||
|
|
|
exposeDeployedApplication
:
BOOLEAN
= false
|
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
|
isStartOrStopOperationRequired
:
BOOLEAN
= true
|
|
Is Start Or Stop Operation Required
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
|
modifyScript
:
STRING
|
|
Python script invoked to upgrade this Java EE artifact
|
Step Reference
wlst
Description
The wlst step executes a Python script via WebLogic Scripting Tool of a wls.Domain.
Examples
This is an example of a wlst step that will deploy an application:
<wlst>
<order>70</order>
<script>wls/application/deploy-application.py</script>
</wlst>
Note: Script wls/application/deploy-application.py is provided with the wls-plugin.
This is an example of a wlst step that will synchronize nodes, which is necessary after an application wls deployed:
<wlst>
<order>90</order>
<description>Start Application</description>
<script>wls/application/start-application.py</script>
</wlst>
Note: Script wls/application/start-application.py is provided with the wls-plugin.
Same steps created with Script rule:
context.addStep(steps.wlst(
order = 70,
script = "wls/application/deploy-application.py"
))
context.addStep(steps.wlst(
order = 90,
script = "wls/application/start-application.py"
))
Calculated step parameters
Target Domain
The target-domain parameter of a step is calculated as follows:
- If the scope is
deployedanddeployed.containeris of type python.PythonManagingContainer:deployed.container.managingContaineris of type wls.Domain, thetarget-domainis set todeployed.container.managingContainer.
- In other cases,
target-domaincannot be automatically calculated and must be specified manually.
Step Parameters
| Parameter | Type | Description | Required | Calculated |
|---|---|---|---|---|
| description | String | Description of this step, as it should appear in generated deployment plans | Yes | Yes |
| order | Integer | Execution order of the step | Yes | Yes |
| python-context | Map | Dictionary that represent context available to the python script | No | Yes |
| script | String | Path to the python script to be executed | Yes | No |
| target-domain | Domain | WebLogic domain where to execute the python script | Yes | Yes |
| upload-artifacts-in-python-context | Boolean | If true, the artifacts from the python context will be uploaded to the target host and available to the script as bindingName.file. Defaults to true. | Yes | No |