# Preface

This document describes the functionality provided by the WebLogic server (WLS) plugin.

See the Deployit Reference Manual for background information on Deployit and deployment concepts.

# Overview

The WLS plugin is a Deployit plugin that adds capability for managing deployments and resources on WebLogic server. It works out of the box for deploying/ undeploying application artifacts, datasource and other JMS resources (see the Features section below) , and can easily be extended to support more deployment options or management of new artifacts/resources on WLS.

## Features

- Deployment units
  - Enterprise application (EAR)
  - Web application (WAR)
  - Enterprise JavaBean (EJB)
  - J2EE Shared library
- Staging modes
  - Stage
  - Nostage
- Deployment strategies
  - Classical
  - Versioned
  - Side by side
- Resources
  - Datasource
  - JMS Queue
  - JMS Topic
  - JMS uniform distributed Queue
  - JMS uniform distributed Topic
  - JMS connection factory
  - Mail Session
  - Persistence Store (file and JDBC)
- Files & Folders
- Discovery

# Requirements

- Deployit requirements

  - Deployit: version 3.6+
  - WLS versions: WLS 9.x, WLS 10.3, WLS 11g (Unix and Windows)
  - Other Deployit Plugins: None

- Infrastructural requirements

  - WebLogic Domain user credentials
  - User credentials for accessing the Host managing the WebLogic Administration Server.
  - User credentials for accessing target Hosts of managed Servers (for NoStage mode)

# Usage in Deployment Packages

The plugin works with the standard deployment package of DAR format. Please see the Packaging Manual for more details about the DAR format and the ways to compose one.

The following is a sample MANIFEST.MF file that can be used to create a WebLogic specific deployment package. It contain declarations for an Ear, a datasource and a couple of JMS resources.

    Manifest-Version: 1.0
    Deployit-Package-Format-Version: 1.3
    CI-Application: SampleApp
    CI-Version: 1.0

    Name: SampleApp-1.0.ear
    CI-Name: SampleApp
    CI-Type: jee.Ear

    Name: testDatasource
    CI-Type: wls.DataSourceSpec
    CI-jndiNames: jdbc/sampleDatasource
    CI-url: jdbc:mysql://localhost/test
    CI-driverName: com.mysql.jdbc.Driver
    CI-username: {{DATABASE_USERNAME}}
    CI-password: {{DATABASE_PASSWORD}}

    Name: sampleQueue
    CI-Type: wls.QueueSpec
    CI-jndiName: jms/testQueue
    CI-jmsModuleName: {{JMS_MODULE_NAME}}

    Name: sampleCf
    CI-Type: wls.ConnectionFactorySpec
    CI-jndiName: jms/sampleCf
    CI-jmsModuleName: {{JMS_MODULE_NAME}}

# Using the deployables and deployeds

The following table describes which deployable/container combinations are possible.

## Deployable vs. Container table

Deployable | Container | Generated deployed
--- | --- | ---
Application artifact: jee.Ear jee.War wls.EjbJar | wls.Cluster wls.Server | wls.EarModule wls.WarModule wls.EjbJarModule
wls.SharedLibraryWar | wls.Cluster wls.Server | wls.SharedLibraryWarModule
wls.DataSourceSpec | wls.Cluster wls.Server | wls.DataSource
wls.QueueSpec | wls.JmsServer | wls.Queue
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.ConnectionFactorySpec | wls.Cluster wls.Server wls.JmsServer | wls.ConnectionFactory
wls.MailSessionSpec | wls.Cluster wls.Server | wls.MailSession
wls.File | wls.Cluster wls.Server | wls.DeployedFile
wls.Folder | wls.Cluster wls.Server | wls.DeployedFolder

The following table describes the effect a deployed has on it's container

## Deployed Actions Table

Deployed | Actions performed for operations
--- | ---
| Create | Destroy | Modify
wls.EarModule wls.WarModule wls.EjbJarModule | uploaded artifact to host deploy application start application | stop application undeploy application delete artifact from host | stop application undeploy application delete artifact from host uploaded new artifact to host deploy application start application
wls.SharedLibraryWarModule | upload library to host deploy library | undeploy library delete library from host | undeploy library delete library from host upload library to host deploy library
wls.DataSource | create datasource | destroy datasource | destroy datasource create new datasource
wls.Queue | create queue | destroy queue | modify queue (if modify-script specified in synthetic.xml) OR destroy queue create new queue
wls.Topic | create topic | destroy topic | modify topic (if modify-script specified in synthetic.xml) OR destroy topic create new topic
wls.UniformDistributedQueue | create UDD queue | destroy UDD queue | modify UDD queue (if modify-script specified in synthetic.xml) OR destroy UDD queue create new UDD queue
wls.UniformDistributedTopic | create UDD topic | destroy UDD topic | modify UDD topic (if modify-script specified in synthetic.xml) OR destroy UDD topic create new UDD topic
wls.ConnectionFactory | create connection factory | destroy connection factory | destroy connection factory create new connection factory
wls.MailSession | create mail session | destroy mail session | destroy mail session create mail session
wls.FilePersistentStore | create file persistence store | destroy file persistence store | destroy file persistence store create file persistence store
wls.JmsFilePersistentStore | create file persistence store and assign it on the JmsServer | destroy file persistence store and remove it from the JmsServer | destroy file persistence store create file persistence store
wls.JmsJdbcPersistentStore | create Jdbc persistence store and assign it on the JmsServer | destroy Jdbc persistence store and remove it from the JmsServer | destroy Jdbc persistence store create Jdbc persistence store
wls.DeployedFile | copy a file on the host where a wls.Server or wls.Cluster is running. | delete a file on the host where a wls.Server or wls.Cluster is running. | delete a file on the host where a wls.Server or wls.Cluster is running. copy a file on the host where a wls.Server or wls.Cluster is running.
wls.DeployedFolder | copy a folder on the host where a wls.Server or wls.Cluster is running. | delete a folder on the host where a wls.Server or wls.Cluster is running. | delete a folder on the host where a wls.Server or wls.Cluster is running. copy a folder on the host where a wls.Server or wls.Cluster is running.

# Deploying applications

The way an application is deployed to a container can be influenced by modifying properties of the corresponding deployed.

For example, if an Ear is to be deployed as a versioned application, using nostage mode, specify these properties in the deployed EarModule:

- `versioned` = true (or on UI, check the checkbox)
- `stage mode` = NoStage (or on UI, choose NoStage from the dropdown)
- `staging directory` = absolute path of the directory where Ear is to be uploaded

Similarly, if the deployed application needs to be upgraded using the side by side deployment strategy, modify these properties in the deployed EarModule:

- `staging directory` = new path of the directory where the new version of Ear will be uploaded
- `deployment strategy` = SIDE_BY_SIDE (or on the UI, choose SIDE_BY_SIDE from the dropdown)
- `retire timeout` = Time interval (seconds) if a timeout period is needed for retiring the previous version of the application

# Note about the version

The plugin allows to deploy non versioned artifacts (ear, war, ejbjar) as a versioned artifact. In this case, the plugin computes automatically the version using this pattern: Application-VersionOfThePackage. Of course, if you artifact is packaged with a version (for example Shared Library), the version will be read from the manifest file.

# Note about targeting to multiple containers

Certain deployables can be targeted to multiple containers. For example, an Ear can be targeted to two clusters. Similarly a datasource can be targeted to two clusters.

Note that the way WLS plugin handles this multiple targeting is by generating steps for each targeting. So for example, if a datasource is targeted to two cluster (say Cluster-1, Cluster-2) , Deployit will create two datasource creation steps, wherein.

- The first step will create the datasource on Cluser-1, with all the properties of the deployed datasource.
- The second step will add Cluster-2 to the target list of the datasource created in first step. If there are difference in the datasource values of this deployed, it overrides the previous value.

Since the second targeting overrides the properties of the first targeting, take utmost care to keep the properties of the deployeds (of the same deployable) uniform across each other.

Similar to creation, the following sequence of steps occurs if destroy operation takes place for such a multiple targeted datasource:

- The first step will remove Cluster-1 from datasource target's list
- The second step will remove Cluster-2 from datasource target's list, and since the datasource has no target set on it, it destroys the datasouce.

Note that the actual datasource destruction takes place in the second step, and the first step simply removes the first container from datasource targets.

# Creating resources

Deployit handles the creation of resources in the same way it handles deploying an application. An optional parameter can trigger a restart if needed. Refer to Reference Manual for more details on deploying resources.

# Copying files

Deployit handles the copy of files targeted on a wls.Server or wls.Cluster. An optional parameter can trigger a restart if needed. Refer to Reference Manual for more details on deploying files.

# Note about managing JMS resources

The WLS plugin greatly simplifies the management of JMS resources. It does this by automatically managing the JMS modules and sub-deployments needed for JMS resources, letting the user to focus on the actual JMS resource he needs to manage. For example, the followings is the sequence of steps that happens behind the scene when a JMS resource like Queue is created:

- the JMS module name is specified by user in deployed resource (look at 'jmsModuleName' property in Queue for example)
- plugin automatically creates the module if it is not present, otherwise adds the deployed container to existing module targets
- plugin automatically creates a subdeployment if is not present, otherwise adds the deployed container to existing subdeployment targets
- plugin creates/updates the JMS resource and assign the subdeployment created in previous step as the resource subdeployment

Similarly, the destruction of a JMS resource is handled behind the scene in the following way:

- the resource container is removed from it's subdeployment targets.
- destroys the JMS resource only if it's subdeployment targets list is empty (if it's the last one)
- destroys the subdeployment automatically if it contains no targets
- destroy JMS module if no other JMS resources are using it.

The thing to note is that the WLS plugin manage modules intelligently unless you want to use your own.

# Extension points

The WLS plugin is designed to be extended through Deployit's Plugin API type system and through the use of custom user defined WLST Python scripts. Refer to Customization Manual for an explanation of the type system.

The WLS plugin associates Create, Modify and Destroy operations received from Deployit with WLST Python scripts that need to be executed for the operation. The operation specific script is given a Python object representation of the Deployed that triggered the operation. The script is then executed using WLST on the target Domain. Below, for example is the definition of `wls.Datasource` in synthetic.xml:

    <type type="wls.DataSource" extends="wls.Resource" deployable-type="wls.DataSourceSpec" description="An object bound to the
                                  JNDI tree that provides database connectivity through a pool of JDBC connections">
        <generate-deployable type="wls.DataSourceSpec" extends="wls.ResourceSpec" description="Specification for a datasource"/>
        <property name="additionalPropertiesNotToExpose" hidden="true" default="jndiNames, url, driverName, username,
                                                password, properties"/>

        <property name="createScript" default="wls/ds/create-datasource.py" hidden="true" />

        <property name="destroyScript" default="wls/ds/destroy-datasource.py"  hidden="true" />

        <property name="jndiNames" description="JNDI path to where this data source is bound" />
        <property name="url" description="URL of the database to connect to." />
        <property name="driverName" description="Full package name of JDBC driver class used to create the physical
                  database connections in the connection pool" />
        <property name="username" description="Username attribute passed to the JDBC driver when creating
                  physical database connections" />
        <property name="password" password="true" description="Password attribute passed to the
                  JDBC driver when creating physical database connections" />
    </type>

The script has all the information from the Deployed at its disposal to translate into the WLST API calls needed to configure WebLogic. The following sample Python snippet is using deployed to create a datasource:

    cmo.createJDBCSystemResource(deployed.name)
    datasourcePath = '/JDBCSystemResources/%s/JDBCResource/%s' % (deployed.name, deployed.name)
    cd(datasourcePath)
    cd('%s/JDBCDriverParams/%s' % (datasourcePath, deployed.name))
    set("Url", deployed.url)
    set("DriverName", deployed.driverName)
    set('Password', deployed.password)
    # use jmsModuleName, jmsServer and jndiName to create the queue

The WLS plugin also offers the ability to influence the order in which scripts are executed in relation to other Deployed operations. The order allows for the chaining of scripts to create a logical sequence of events. For example, the following synthetic.xml snippet says that creation of the queue (order = 60) will happen before deployment of the Ear (order = 70), and the destruction of the queue (order = 40) will take place the after undeployment of the Ear (order = 30)

    <type type="wls.EarModule" extends="wls.ExtensibleDeployedArtifact" deployable-type="jee.Ear" description="Ear
                                                with values configured for a deployment">
        <generate-deployable type="wls.Ear" extends="jee.Ear" description="A JEE EAR archive"/>
        <property name="createScript" default="wls/application/deploy-application.py" hidden="true"/>
        <property name="createVerb" default="Deploy" hidden="true" />
        <property name="createOrder" kind="integer" default="70" hidden="true" />

        <property name="destroyScript" default="wls/application/undeploy-application.py" hidden="true"/>
        <property name="destroyVerb" default="Undeploy" hidden="true" />
        <property name="destroyOrder" kind="integer" default="30" hidden="true" />

        <property name="startScript" default="wls/application/start-application.py" hidden="true"/>
        <property name="startOrder" kind="integer" default="90" hidden="true" />

        <property name="stopScript" default="wls/application/stop-application.py" hidden="true"/>
        <property name="stopOrder" kind="integer" default="10" hidden="true" />
    </type>

    <type type="wls.Queue" extends="wls.AbstractQueue" deployable-type="wls.QueueSpec"
          description="A point-to-point destination type">
        <generate-deployable type="wls.QueueSpec" extends="wls.JmsResourceSpec" description="Specification for a JMS Queue"/>
        <property name="createScript" default="wls/jms/create-queue.py" hidden="true"/>
        <property name="createVerb" default="Create" hidden="true" />
        <property name="createOrder" kind="integer" default="60" hidden="true" />

        <property name="destroyScript" default="wls/jms/destroy-queue.py" hidden="true"/>
        <property name="destroyVerb" default="Destroy" hidden="true" />
        <property name="destroyOrder" kind="integer" default="40" hidden="true" />

        <property name="setErrorDestinationScript" default="wls/jms/set-error-queue.py" hidden="true"/>
        <property name="unsetErrorDestinationScript" default="wls/jms/unset-error-queue.py" hidden="true"/>
    </type>

Next section describes the extensibility by examples:

# Extending the Plugin (A Tutorial)

Hiding an existing property from a deployed/deployable

The following synthetic.xml snippet shows how JDBCConnectionPoolParams_CapacityIncrement property in wls.Datasource can be made hidden giving it a default value of 2.

    <type-modification type="wls.DataSource">
        <!-- makes the propery hidden from the UI -->
      <property name="JDBCConnectionPoolParams_CapacityIncrement"  category="Connection Pool" label="Capacity Increment"
             kind="integer" hidden="true" default="2"/>
    </type-modification>

Adding a new property to a deployed/deployable

The following synthetic.xml snippet shows how a new property `inactiveConnectionTimeoutSeconds` can be added to wls.Datasource

    <type-modification type="wls.DataSource">
        <!-- adding new property -->
        <property name="JDBCConnectionPoolParams_InactiveConnectionTimeoutSeconds"  category="Connection Pool"
                 label="Inactive Connection Timeout (sec)" kind="integer" description="inactive Connection Timeout in Seconds" />
    </type-modification>

Note that while adding a new property in WLS plugin, the property name should correspond to the relative path of the property (file) from the configuration item in WLST (minus the type name). For example, since the relative path of property `InactiveConnectionTimeoutSeconds` in WLST is `{datasource-name}/JDBCConnectionPoolParams/{datasource-name}/InactiveConnectionTimeoutSeconds`, the property name to use while adding a new property is `JDBCConnectionPoolParams_InactiveConnectionTimeoutSeconds`.

Adding a new type

The following synthetic.xml snippet shows the definition of a new CI type `wls.WorkManager`. Since it's a resource and it can be targeted to a Cluster or a Server, it has been made to extend wls.Resource

    <type type="wls.WorkManager" extends="wls.Resource" deployable-type="wls.WorkManagerSpec">
        <generate-deployable type="wls.WorkManagerSpec" extends="wls.ResourceSpec"/>
            <property name="createScript" default="wls/env/create-work-manager.py" hidden="true" />
        <property name="destroyScript" default="wls/env/destroy-work-manager.py" hidden="true" />
    </type>

The name property is automatically added to all CIs so it has not been defined explicitly as a property. Additional properties can be added in the definition as per the need.

Next step involves adding the Python scripts for the steps. For the `wls.WorkManager' example, two Python scripts needs to be created: create-work-manager.py and destroy-work-manager.py

wls/env/create-work-manager.py

    workManagerPath='/SelfTuning/%s/WorkManagers/%s' %(deployed.container.domain.name, deployed.name)
    connectAndEdit()

      if exists(workManagerPath):
        print 'Modifying work manager %s for target %s' % (deployed.name, deployed.container.name)
        setOrOverride = overrideWithWarning
    else:
        print 'Creating work manager %s for target %s' % (deployed.name, deployed.container.name)
        cd('/SelfTuning/' + deployed.container.domain.name + '/WorkManagers')
        cmo.createWorkManager(deployed.name)
        setOrOverride = set

    cd(workManagerPath)
    newTargets = []
    for t in get('Targets'):
        newTargets.append(t)

    newTargets.append(ObjectName(deployed.container.objectName))
    set('Targets', jarray.array(newTargets, ObjectName))

    saveAndExit()

wls/env/destroy-work-manager.py

    workManagerPath='/SelfTuning/%s/WorkManagers/%s' %(deployed.container.domain.name, deployed.name)
    connectAndEdit()

    if not exists(workManagerPath):
        print "Work manager with name %s does not exist." %(deployed.name)
        sys.exit(1)

    cd(workManagerPath)
    currentTargets = get('Targets')
    print 'oldTargets: %s' %(currentTargets)
    containerTarget = ObjectName(deployed.container.objectName)
    newTargets = []
    for t in currentTargets:
        if t != containerTarget:
           newTargets.append(t)

    print 'new targets: %s' %(newTargets)
    if len(newTargets) > 0:
           print 'Modifying work manager %s' %(deployed.name)
           set('Targets', jarray.array(newTargets, ObjectName))
    else:
           print 'Deleting workmanager %s' % (deployed.name)
           cd('../')
           delete(deployed.name, 'WorkManagers')

    saveAndExit()

Note 1: In the above example Python files, functions 'connectAndEdit()', 'saveAndExit()' are utility functions defined in the base.py file in WLS plugin. Have a look at the base.py file to see other utility functions.

# Discovery

Once the admin server's Host and Domain are specified, the following containers can be discovered by the WLS plugin:

- Cluster
- Server
- JMSServer

Here is an example CLI script which discovers a sample WLS domain:

    adminServerHost = repository.create(factory.configurationItem('Infrastructure/adminServerHost','overthere.SshHost',
                {'os':'UNIX','connectionType':'SFTP', 'address':'wls-103', 'username':'demo-user', 'password':'demo-password'}))

    wlsDomain = factory.configurationItem('Infrastructure/demoWlsDomain', 'wls.Domain',
                  {'wlHome':'/opt/bea-10.3/wlserver_10.3', 'domainHome':'/opt/bea-10.3/user_projects/domains/demoWlsDomain',
                  'port':'7001', 'username':'weblogic', 'password':'weblogic', 'adminServerName':'adminServer',
                  'startMode':'NodeManager', 'host':'Infrastructure/adminServerHost'})

    discoveredItems = deployit.discover(wlsDomain)
    print discoveredItems

    #discovery just discovers the topology and keeps the configuration items in memory. Save them in Deployit repository
    repository.create(discoveredItems)

Limitations

- The WLS topology discovery doesn't discover/associate the Host associated with the managed Servers. So if a Cluster is spanned on multiple Hosts, the creation of the managed server's Host and it's association with the Server is a manual process. This can be done using the CLI or more easily, using the UI. This may be needed for certain deployment scenarios where knowledge of the Server's Host is needed (like NoStage deployments) .

# CI Reference

## Configuration Item Overview

### Deployable Configuration Items

### Deployed Configuration Items

### Topology Configuration Items

### Virtual Deployable Configuration Items

### Virtual Deployed Configuration Items

## Configuration Item Details

### wls.AbstractQueue

Hierarchy | wls.JmsDestination >> wls.JmsResource >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.Deployed, udm.ConfigurationItem

Description unavailable

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
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.
errorDestination : CI<wls.JmsDestination> 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
createOrder : INTEGER = 60 Create Order
createVerb : STRING = Create Create Verb
destroyOrder : INTEGER = 40 Destroy Order
destroyVerb : STRING = Destroy Destroy Verb
modifyOrder : INTEGER = 40 Modify Order
modifyVerb : STRING = Upgrade Modify Verb
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 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.
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

Hierarchy | wls.JmsDestination >> wls.JmsResource >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.Deployed, udm.ConfigurationItem

Description unavailable

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
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.
errorDestination : CI<wls.JmsDestination> 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
createOrder : INTEGER = 60 Create Order
createVerb : STRING = Create Create Verb
destroyOrder : INTEGER = 40 Destroy Order
destroyVerb : STRING = Destroy Destroy Verb
modifyOrder : INTEGER = 40 Modify Order
modifyVerb : STRING = Upgrade Modify Verb
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 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.
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

Hierarchy | wls.JmsDestination >> wls.JmsResource >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.Deployed, udm.ConfigurationItem

Description unavailable

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
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.
errorDestination : CI<wls.JmsDestination> 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
createOrder : INTEGER = 60 Create Order
createVerb : STRING = Create Create Verb
destroyOrder : INTEGER = 40 Destroy Order
destroyVerb : STRING = Destroy Destroy Verb
modifyOrder : INTEGER = 40 Modify Order
modifyVerb : STRING = Upgrade Modify Verb
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 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.
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

Hierarchy | wls.JmsDestination >> wls.JmsResource >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.Deployed, udm.ConfigurationItem

Description unavailable

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
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.
errorDestination : CI<wls.JmsDestination> 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
createOrder : INTEGER = 60 Create Order
createVerb : STRING = Create Create Verb
destroyOrder : INTEGER = 40 Destroy Order
destroyVerb : STRING = Destroy Destroy Verb
modifyOrder : INTEGER = 40 Modify Order
modifyVerb : STRING = Upgrade Modify Verb
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 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.
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.Cluster

Hierarchy | udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, wls.WlsContainer, python.PythonManagedContainer, wls.JmsTarget, udm.ConfigurationItem, udm.Container

WebLogic Cluster which defines groups of WebLogic servers that work together to increase scalability and reliability

Public Properties
domain : CI<wls.Domain> The domain to which the WebLogic Cluster belongs. 'asContainment'=true, means a Cluster is 'contained' under a Domain
servers : SET_OF_CI<wls.Server> 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
stopOrder : INTEGER = 20 Stop Order
workaround : STRING = DEPLOYITPB-3589 Workaround

Control Tasks
start No description.
stop No description.

### wls.ConnectionFactory

Hierarchy | wls.JmsResource >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | 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

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
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
createOrder : INTEGER = 60 Create Order
createScript : STRING = wls/jms/create-connection-factory.py Create Script
createVerb : STRING = Create Create Verb
destroyOrder : INTEGER = 40 Destroy Order
destroyScript : STRING = wls/jms/destroy-connection-factory.py Destroy Script
destroyVerb : STRING = Destroy Destroy Verb
modifyOrder : INTEGER = 40 Modify Order
modifyVerb : STRING = Upgrade Modify Verb
standardPropertiesNotToExpose : STRING = id, name, type, properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, destroyOrder, jndiName, jmsModuleName, subDeploymentName 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.
modifyScript : STRING Python script invoked to upgrade this resource

### wls.ConnectionFactorySpec

Hierarchy | wls.JmsResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

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

Hierarchy | udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

Base class for all deployeds meant to contain Applications

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
targetDirectory : STRING Path to which artifact must be copied to on the wls server.
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.DataSource

Hierarchy | wls.Resource >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.Deployed, udm.ConfigurationItem

An object bound to the JNDI tree that provides database connectivity through a pool of JDBC connections

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
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
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 trigger a restart operation (stop & start) just after the creation or the deletion of the resource

Hidden Properties
additionalPropertiesNotToExpose : STRING = jndiNames, url, driverName, username, password, properties Additional Properties Not To Expose
createOrder : INTEGER = 60 Create Order
createScript : STRING = wls/ds/create-datasource.py Create Script
createVerb : STRING = Create Create Verb
destroyOrder : INTEGER = 40 Destroy Order
destroyScript : STRING = wls/ds/destroy-datasource.py Destroy Script
destroyVerb : STRING = Destroy Destroy Verb
modifyOrder : INTEGER = 40 Modify Order
modifyVerb : STRING = Upgrade Modify Verb
standardPropertiesNotToExpose : STRING = id, name, type, _properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyScript, destroyVerb, destroyOrder, jndiName, restartTarget 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.
modifyScript : STRING Python script invoked to upgrade this resource

### wls.DataSourceSpec

Hierarchy | wls.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

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 trigger a restart operation (stop & start) just after the creation or the deletion of the resource (boolean)
tags : SET_OF_STRING If set, this deployable will only be mapped automatically to containers with the same tag.
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

Hierarchy | wls.CopiedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

Deployed configuration File

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
targetDirectory : STRING = ${deployed.container.domain.domainHome}/lib Target Directory
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

Hierarchy | wls.CopiedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

Deployed configuration Folder

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
targetDirectory : STRING = ${deployed.container.domain.domainHome}/lib Target Directory
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.Domain

Hierarchy | udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, python.PythonManagingContainer, python.PythonManagedContainer, udm.ConfigurationItem, udm.Container

WebLogic Domain which is a collection of WebLogic Server instances that is managed by a single Administration Server

Public Properties
adminServerName : STRING = AdminServer The name of the admin server
clusters : SET_OF_CI<wls.Cluster> WebLogic clusters belonging to domain
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_10, WEBLOGIC_11] = WEBLOGIC_10 Version of Oracle WebLogic Server
wlHome : STRING The location of the WebLogic Server installation
domainHome : STRING The location of the WebLogic domain. Defaults to /../user_projects/domains/ (Unix) or \..\user_projects\domains\ (Windows)
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 /common/bin/wlst.sh (Unix) or \common\bin\wlst.cmd (Windows)

Hidden Properties
runWithDaemon : BOOLEAN = true Set to true to execute commands with the Python daemon

### wls.Ear

Hierarchy | jee.Ear >> udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.ArchiveArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

A JEE EAR archive

Public Properties
block : STRING boolean value specifying whether the deployment should block user interaction until the command complete (boolean)
deploymentOrder : STRING By default, new applications and modules are configured with a Deployment Order value of 100 (integer)
excludeFileNamesRegex : STRING Regular expression that matches file names that must be excluded from scanning
placeholders : SET_OF_STRING Placeholders detected in this artifact
redeploymentStrategy : STRING Indicates what redeployment strategy to use for upgrading the application (enum)
retireTimeout : STRING Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy (integer)
scanPlaceholders : BOOLEAN = true Scan Placeholders
stageMode : STRING Indicates whether the artifact will be deployed as staged or nostage mode (enum)
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)

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

### wls.EarModule

Hierarchy | wls.ExtensibleDeployedArtifact >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

Ear with values configured for a deployment

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
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
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>
retireTimeout : INTEGER = -1 Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy
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 Indicates wither this artifact is to be deployed as a versioned application

Hidden Properties
createOrder : INTEGER = 70 Create Order
createScript : STRING = wls/application/deploy-application.py Create Script
createVerb : STRING = Deploy Create Verb
destroyOrder : INTEGER = 30 Destroy Order
destroyScript : STRING = wls/application/undeploy-application.py Destroy Script
destroyVerb : STRING = Undeploy Destroy Verb
isRunningRetryWaitInterval : INTEGER = 500 Time in milliseconds to wait before next retry to check if the deployment is still running
modifyOrder : INTEGER = 60 Modify Order
modifyVerb : STRING = Upgrade Modify Verb
standardPropertiesNotToExpose : STRING = id, name, type, deployable, properties, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, startScript, startVerb, startOrder, stopScript, stopVerb, stopOrder, deploymentStrategy, placeholders, file, redeploymentStrategy, securityPermissions, inheritPermissions, exposeDeployedApplication, stopRetiredApplicationOrder, undeployRetiredApplicationOrder, isRunningRetryWaitInterval, wlstPath Standard Properties Not To Expose
startOrder : INTEGER = 90 Start Order
startScript : STRING = wls/application/start-application.py Start Script
startVerb : STRING = Start Start Verb
stopOrder : INTEGER = 10 Stop Order
stopRetiredApplicationOrder : INTEGER = 95 Stop Retired Application Order
stopScript : STRING = wls/application/stop-application.py Stop Script
stopVerb : STRING = Stop Stop Verb
undeployRetiredApplicationOrder : INTEGER = 98 Undeploy Retired Application Order
wlstPath : STRING = AppDeployments Wlst Path
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 Java EE artifact

### wls.EjbJar

Hierarchy | jee.EjbJar >> udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.ArchiveArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

A JEE EJB archive

Public Properties
block : STRING boolean value specifying whether the deployment should block user interaction until the command complete (boolean)
deploymentOrder : STRING By default, new applications and modules are configured with a Deployment Order value of 100 (integer)
excludeFileNamesRegex : STRING Regular expression that matches file names that must be excluded from scanning
placeholders : SET_OF_STRING Placeholders detected in this artifact
redeploymentStrategy : STRING Indicates what redeployment strategy to use for upgrading the application (enum)
retireTimeout : STRING Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy (integer)
scanPlaceholders : BOOLEAN = true Scan Placeholders
stageMode : STRING Indicates whether the artifact will be deployed as staged or nostage mode (enum)
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)

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

### wls.EjbJarModule

Hierarchy | wls.ExtensibleDeployedArtifact >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

EJB with values configured for a deployment

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
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
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>
retireTimeout : INTEGER = -1 Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy
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 Indicates wither this artifact is to be deployed as a versioned application

Hidden Properties
createOrder : INTEGER = 70 Create Order
createScript : STRING = wls/application/deploy-application.py Create Script
createVerb : STRING = Deploy Create Verb
destroyOrder : INTEGER = 30 Destroy Order
destroyScript : STRING = wls/application/undeploy-application.py Destroy Script
destroyVerb : STRING = Undeploy Destroy Verb
isRunningRetryWaitInterval : INTEGER = 500 Time in milliseconds to wait before next retry to check if the deployment is still running
modifyOrder : INTEGER = 60 Modify Order
modifyVerb : STRING = Upgrade Modify Verb
standardPropertiesNotToExpose : STRING = id, name, type, deployable, properties, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, startScript, startVerb, startOrder, stopScript, stopVerb, stopOrder, deploymentStrategy, placeholders, file, redeploymentStrategy, securityPermissions, inheritPermissions, exposeDeployedApplication, stopRetiredApplicationOrder, undeployRetiredApplicationOrder, isRunningRetryWaitInterval, wlstPath Standard Properties Not To Expose
startOrder : INTEGER = 90 Start Order
startScript : STRING = wls/application/start-application.py Start Script
startVerb : STRING = Start Start Verb
stopOrder : INTEGER = 10 Stop Order
stopRetiredApplicationOrder : INTEGER = 95 Stop Retired Application Order
stopScript : STRING = wls/application/stop-application.py Stop Script
stopVerb : STRING = Stop Stop Verb
undeployRetiredApplicationOrder : INTEGER = 98 Undeploy Retired Application Order
wlstPath : STRING = AppDeployments Wlst Path
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 Java EE artifact

### wls.ExtensibleDeployedArtifact

Hierarchy | python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

Base class for all deployeds meant to contain Applications

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
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
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>
retireTimeout : INTEGER = -1 Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy
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 Indicates wither this artifact is to be deployed as a versioned application

Hidden Properties
createOrder : INTEGER = 70 Create Order
createScript : STRING = wls/application/deploy-application.py Create Script
createVerb : STRING = Deploy Create Verb
destroyOrder : INTEGER = 30 Destroy Order
destroyScript : STRING = wls/application/undeploy-application.py Destroy Script
destroyVerb : STRING = Undeploy Destroy Verb
isRunningRetryWaitInterval : INTEGER = 500 Time in milliseconds to wait before next retry to check if the deployment is still running
modifyOrder : INTEGER = 60 Modify Order
modifyVerb : STRING = Upgrade Modify Verb
standardPropertiesNotToExpose : STRING = id, name, type, deployable, properties, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, startScript, startVerb, startOrder, stopScript, stopVerb, stopOrder, deploymentStrategy, placeholders, file, redeploymentStrategy, securityPermissions, inheritPermissions, exposeDeployedApplication, stopRetiredApplicationOrder, undeployRetiredApplicationOrder, isRunningRetryWaitInterval, wlstPath Standard Properties Not To Expose
startOrder : INTEGER = 90 Start Order
startScript : STRING = wls/application/start-application.py Start Script
startVerb : STRING = Start Start Verb
stopOrder : INTEGER = 10 Stop Order
stopRetiredApplicationOrder : INTEGER = 95 Stop Retired Application Order
stopScript : STRING = wls/application/stop-application.py Stop Script
stopVerb : STRING = Stop Stop Verb
undeployRetiredApplicationOrder : INTEGER = 98 Undeploy Retired Application Order
wlstPath : STRING = AppDeployments Wlst Path
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 Java EE artifact

### wls.File

Hierarchy | generic.File >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

File that is deployed to the server lib directory

Public Properties
createTargetDirectory : STRING Create the target directory on the wls server if it does not exist. (boolean)
excludeFileNamesRegex : STRING Regular expression that matches file names that must be excluded from scanning
placeholders : SET_OF_STRING Placeholders detected in this artifact
restartTarget : STRING Restart the target container (boolean)
scanPlaceholders : BOOLEAN = true Scan Placeholders
tags : SET_OF_STRING If set, this deployable will only be mapped automatically to containers with the same tag.
targetDirectory : STRING Target Directory (string)
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)
targetFile : STRING Name of the artifact on the wls 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

### wls.FilePersistentStore

Hierarchy | wls.PersistentStore >> wls.Resource >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.Deployed, udm.ConfigurationItem

Description unavailable

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
directory : STRING Directory
synchronousWritePolicy : STRING = Cache-Flush Synchronous Write Policy
deployable : CI<udm.Deployable> The deployable that this deployed is derived from.
restartTarget : BOOLEAN = false trigger a restart operation (stop & start) just after the creation or the deletion of the resource

Hidden Properties
createOrder : INTEGER = 60 Create Order
createScript : STRING = wls/resources/create-file-persistence-store.py Create Script
createVerb : STRING = Create Create Verb
destroyOrder : INTEGER = 40 Destroy Order
destroyScript : STRING = wls/resources/destroy-file-persistence-store.py Destroy Script
destroyVerb : STRING = Destroy Destroy Verb
modifyOrder : INTEGER = 40 Modify Order
modifyVerb : STRING = Upgrade Modify Verb
standardPropertiesNotToExpose : STRING = id, name, type, _properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyScript, destroyVerb, destroyOrder, jndiName, restartTarget 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.
modifyScript : STRING Python script invoked to upgrade this resource

### wls.FilePersistentStoreSpec

Hierarchy | wls.PersistentStoreSpec >> wls.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Description unavailable (deployable)

Public Properties
directory : STRING Directory (string)
restartTarget : STRING trigger a restart operation (stop & start) just after the creation or the deletion of the resource (boolean)
synchronousWritePolicy : STRING Synchronous Write Policy (string)
tags : SET_OF_STRING If set, this deployable will only be mapped automatically to containers with the same tag.

### wls.Folder

Hierarchy | generic.Folder >> udm.BaseDeployableFolderArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FolderArtifact

Folder that is deployed to the server lib directory

Public Properties
createTargetDirectory : STRING Create the target directory on the wls server if it does not exist. (boolean)
excludeFileNamesRegex : STRING Regular expression that matches file names that must be excluded from scanning
placeholders : SET_OF_STRING Placeholders detected in this artifact
restartTarget : STRING Restart the target container (boolean)
scanPlaceholders : BOOLEAN = true Scan Placeholders
tags : SET_OF_STRING If set, this deployable will only be mapped automatically to containers with the same tag.
targetDirectory : STRING Target Directory (string)
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)
targetFile : STRING Name of the artifact on the wls 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

### wls.JmsDestination

Hierarchy | wls.JmsResource >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.Deployed, udm.ConfigurationItem

Base class for all JMS destinations, which can have a error destination property defined on them

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
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.
errorDestination : CI<wls.JmsDestination> 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
createOrder : INTEGER = 60 Create Order
createVerb : STRING = Create Create Verb
destroyOrder : INTEGER = 40 Destroy Order
destroyVerb : STRING = Destroy Destroy Verb
modifyOrder : INTEGER = 40 Modify Order
modifyVerb : STRING = Upgrade Modify Verb
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 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.
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

Hierarchy | wls.JmsPersistentStore >> wls.Resource >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.Deployed, udm.ConfigurationItem

Description unavailable

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
directory : STRING Directory
synchronousWritePolicy : STRING = Cache-Flush Synchronous Write Policy
deployable : CI<udm.Deployable> The deployable that this deployed is derived from.
restartTarget : BOOLEAN = false trigger a restart operation (stop & start) just after the creation or the deletion of the resource

Hidden Properties
createOrder : INTEGER = 60 Create Order
createScript : STRING = wls/jms/create-jms-file-persistence-store.py Create Script
createVerb : STRING = Create Create Verb
destroyOrder : INTEGER = 40 Destroy Order
destroyScript : STRING = wls/jms/destroy-jms-file-persistence-store.py Destroy Script
destroyVerb : STRING = Destroy Destroy Verb
modifyOrder : INTEGER = 40 Modify Order
modifyVerb : STRING = Upgrade Modify Verb
standardPropertiesNotToExpose : STRING = id, name, type, _properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyScript, destroyVerb, destroyOrder, jndiName, restartTarget 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.
modifyScript : STRING Python script invoked to upgrade this resource

### wls.JmsFilePersistentStoreSpec

Hierarchy | wls.JmsPersistentStoreSpec >> wls.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Description unavailable (deployable)

Public Properties
directory : STRING Directory (string)
restartTarget : STRING trigger a restart operation (stop & start) just after the creation or the deletion of the resource (boolean)
synchronousWritePolicy : STRING Synchronous Write Policy (string)
tags : SET_OF_STRING If set, this deployable will only be mapped automatically to containers with the same tag.

### wls.JmsJdbcPersistentStore

Hierarchy | wls.JmsPersistentStore >> wls.Resource >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.Deployed, udm.ConfigurationItem

Description unavailable

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
dataSource : CI<wls.DataSource> Data Source
prefixName : STRING = Prefix Name
deployable : CI<udm.Deployable> The deployable that this deployed is derived from.
restartTarget : BOOLEAN = false trigger a restart operation (stop & start) just after the creation or the deletion of the resource

Hidden Properties
createOrder : INTEGER = 62 Create Order
createScript : STRING = wls/jms/create-jms-jdbc-persistence-store.py Create Script
createVerb : STRING = Create Create Verb
destroyOrder : INTEGER = 38 Destroy Order
destroyScript : STRING = wls/jms/destroy-jms-jdbc-persistence-store.py Destroy Script
destroyVerb : STRING = Destroy Destroy Verb
modifyOrder : INTEGER = 40 Modify Order
modifyVerb : STRING = Upgrade Modify Verb
standardPropertiesNotToExpose : STRING = id, name, type, _properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyScript, destroyVerb, destroyOrder, jndiName, restartTarget 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.
modifyScript : STRING Python script invoked to upgrade this resource

### wls.JmsJdbcPersistentStoreSpec

Hierarchy | wls.JmsPersistentStoreSpec >> wls.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Description unavailable (deployable)

Public Properties
prefixName : STRING Prefix Name (string)
restartTarget : STRING trigger a restart operation (stop & start) just after the creation or the deletion of the resource (boolean)
tags : SET_OF_STRING If set, this deployable will only be mapped automatically to containers with the same tag.

### wls.JmsPersistentStore

Hierarchy | wls.Resource >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.Deployed, udm.ConfigurationItem

Description unavailable

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
deployable : CI<udm.Deployable> The deployable that this deployed is derived from.
restartTarget : BOOLEAN = false trigger a restart operation (stop & start) just after the creation or the deletion of the resource

Hidden Properties
createOrder : INTEGER = 60 Create Order
createVerb : STRING = Create Create Verb
destroyOrder : INTEGER = 40 Destroy Order
destroyVerb : STRING = Destroy Destroy Verb
modifyOrder : INTEGER = 40 Modify Order
modifyVerb : STRING = Upgrade Modify Verb
standardPropertiesNotToExpose : STRING = id, name, type, _properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyScript, destroyVerb, destroyOrder, jndiName, restartTarget 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.
modifyScript : STRING Python script invoked to upgrade this resource

### wls.JmsPersistentStoreSpec

Hierarchy | wls.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Description unavailable (deployable)

Public Properties
restartTarget : STRING trigger a restart operation (stop & start) just after the creation or the deletion of the resource (boolean)
tags : SET_OF_STRING If set, this deployable will only be mapped automatically to containers with the same tag.

### wls.JmsResource

Hierarchy | python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.Deployed, udm.ConfigurationItem

Base deployed type for all JMS related resources

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
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
createOrder : INTEGER = 60 Create Order
createVerb : STRING = Create Create Verb
destroyOrder : INTEGER = 40 Destroy Order
destroyVerb : STRING = Destroy Destroy Verb
modifyOrder : INTEGER = 40 Modify Order
modifyVerb : STRING = Upgrade Modify Verb
standardPropertiesNotToExpose : STRING = id, name, type, properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, destroyOrder, jndiName, jmsModuleName, subDeploymentName 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.
modifyScript : STRING Python script invoked to upgrade this resource

### wls.JmsResourceSpec

Hierarchy | udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

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

Hierarchy | udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, python.PythonManagedContainer, udm.ConfigurationItem, wls.JmsTarget, udm.Container

WebLogic JMS server, that act as management containers for the queues and topics in JMS modules that are targeted to them

Public Properties
server : CI<wls.Server> A server instance or migratable target this JMS server is deployed to. 'asContainment'=true, means a JmsServer is 'contained' under a Server
tags : SET_OF_STRING The tags to map deployables to containers.

### wls.MailSession

Hierarchy | wls.Resource >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | 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

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
jndiName : STRING The JNDI name that modules use to access this mail session
deployable : CI<udm.Deployable> The deployable that this deployed is derived from.
javaMailProperties : MAP_STRING_STRING Java Mail Properties
restartTarget : BOOLEAN = false trigger a restart operation (stop & start) just after the creation or the deletion of the resource

Hidden Properties
additionalPropertiesNotToExpose : STRING = jndiName,javaMailProperties Additional Properties Not To Expose
createOrder : INTEGER = 60 Create Order
createScript : STRING = wls/resources/create-mail-session.py Create Script
createVerb : STRING = Create Create Verb
destroyOrder : INTEGER = 40 Destroy Order
destroyScript : STRING = wls/resources/destroy-mail-session.py Destroy Script
destroyVerb : STRING = Destroy Destroy Verb
modifyOrder : INTEGER = 40 Modify Order
modifyVerb : STRING = Upgrade Modify Verb
standardPropertiesNotToExpose : STRING = id, name, type, _properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyScript, destroyVerb, destroyOrder, jndiName, restartTarget 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.
modifyScript : STRING Python script invoked to upgrade this resource

### wls.MailSessionSpec

Hierarchy | wls.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification for a mail session

Public Properties
javaMailProperties : MAP_STRING_STRING Java Mail Properties (map_string_string)
jndiName : STRING The JNDI name that modules use to access this mail session (string)
restartTarget : STRING trigger a restart operation (stop & start) just after the creation or the deletion of the resource (boolean)
tags : SET_OF_STRING If set, this deployable will only be mapped automatically to containers with the same tag.

### wls.PersistentStore

Hierarchy | wls.Resource >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.Deployed, udm.ConfigurationItem

Description unavailable

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
deployable : CI<udm.Deployable> The deployable that this deployed is derived from.
restartTarget : BOOLEAN = false trigger a restart operation (stop & start) just after the creation or the deletion of the resource

Hidden Properties
createOrder : INTEGER = 60 Create Order
createVerb : STRING = Create Create Verb
destroyOrder : INTEGER = 40 Destroy Order
destroyVerb : STRING = Destroy Destroy Verb
modifyOrder : INTEGER = 40 Modify Order
modifyVerb : STRING = Upgrade Modify Verb
standardPropertiesNotToExpose : STRING = id, name, type, _properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyScript, destroyVerb, destroyOrder, jndiName, restartTarget 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.
modifyScript : STRING Python script invoked to upgrade this resource

### wls.PersistentStoreSpec

Hierarchy | wls.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Description unavailable (deployable)

Public Properties
restartTarget : STRING trigger a restart operation (stop & start) just after the creation or the deletion of the resource (boolean)
tags : SET_OF_STRING If set, this deployable will only be mapped automatically to containers with the same tag.

### wls.Queue

Hierarchy | wls.AbstractQueue >> wls.JmsDestination >> wls.JmsResource >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | 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

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
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.
errorDestination : CI<wls.JmsDestination> 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
createOrder : INTEGER = 60 Create Order
createScript : STRING = wls/jms/create-queue.py Create Script
createVerb : STRING = Create Create Verb
destroyOrder : INTEGER = 40 Destroy Order
destroyScript : STRING = wls/jms/destroy-queue.py Destroy Script
destroyVerb : STRING = Destroy Destroy Verb
modifyOrder : INTEGER = 40 Modify Order
modifyVerb : STRING = Upgrade Modify Verb
setErrorDestinationOrder : INTEGER = 61 Set Error Destination Order
setErrorDestinationScript : STRING = wls/jms/set-error-queue.py Set Error Destination Script
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 Standard Properties Not To Expose
unsetErrorDestinationOrder : INTEGER = 37 Unset Error Destination Order
unsetErrorDestinationScript : STRING = wls/jms/unset-error-queue.py Unset Error Destination Script
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

Hierarchy | wls.JmsResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

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)
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

Hierarchy | python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.Deployed, udm.ConfigurationItem

Base deployed of all Resources

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
deployable : CI<udm.Deployable> The deployable that this deployed is derived from.
restartTarget : BOOLEAN = false trigger a restart operation (stop & start) just after the creation or the deletion of the resource

Hidden Properties
createOrder : INTEGER = 60 Create Order
createVerb : STRING = Create Create Verb
destroyOrder : INTEGER = 40 Destroy Order
destroyVerb : STRING = Destroy Destroy Verb
modifyOrder : INTEGER = 40 Modify Order
modifyVerb : STRING = Upgrade Modify Verb
standardPropertiesNotToExpose : STRING = id, name, type, _properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyScript, destroyVerb, destroyOrder, jndiName, restartTarget 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.
modifyScript : STRING Python script invoked to upgrade this resource

### wls.ResourceSpec

Hierarchy | udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

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

Hierarchy | udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, wls.WlsContainer, python.PythonManagedContainer, wls.JmsTarget, udm.ConfigurationItem, udm.Container

WebLogic Server that runs in its own Java Virtual Machine (JVM) and has its own configuration

Public Properties
domain : CI<wls.Domain> WebLogic domain to which this server belongs. 'asContainment'=true, means a Server is 'contained' under a Domain
maxRetries : INTEGER = 10 Number of times to attempt executing the test, in case the step fails
port : INTEGER 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
stopOrder : INTEGER = 20 Stop Order
stopScript : STRING = wls/server/stop-script Stop Script

Control Tasks
start No description.
stop No description.

### wls.SharedLibraryWar

Hierarchy | jee.War >> udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.ArchiveArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

A JEE library archive

Public Properties
block : STRING boolean value specifying whether the deployment should block user interaction until the command complete (boolean)
deploymentOrder : STRING By default, new applications and modules are configured with a Deployment Order value of 100 (integer)
excludeFileNamesRegex : STRING Regular expression that matches file names that must be excluded from scanning
placeholders : SET_OF_STRING Placeholders detected in this artifact
redeploymentStrategy : STRING Indicates what redeployment strategy to use for upgrading the application (enum)
retireTimeout : STRING Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy (integer)
scanPlaceholders : BOOLEAN = true Scan Placeholders
stageMode : STRING Indicates whether the artifact will be deployed as staged or nostage mode (enum)
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)

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

### wls.SharedLibraryWarModule

Hierarchy | wls.ExtensibleDeployedArtifact >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

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

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
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
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>
retireTimeout : INTEGER = -1 Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy
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 Indicates wither this artifact is to be deployed as a versioned application

Hidden Properties
createOrder : INTEGER = 70 Create Order
createScript : STRING = wls/application/deploy-application.py Create Script
createVerb : STRING = Deploy Create Verb
destroyOrder : INTEGER = 30 Destroy Order
destroyScript : STRING = wls/application/undeploy-application.py Destroy Script
destroyVerb : STRING = Undeploy Destroy Verb
isRunningRetryWaitInterval : INTEGER = 500 Time in milliseconds to wait before next retry to check if the deployment is still running
libraryModule : STRING = true Library Module
modifyOrder : INTEGER = 60 Modify Order
modifyVerb : STRING = Upgrade Modify Verb
standardPropertiesNotToExpose : STRING = id, name, type, deployable, properties, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, startScript, startVerb, startOrder, stopScript, stopVerb, stopOrder, deploymentStrategy, placeholders, file, redeploymentStrategy, securityPermissions, inheritPermissions, exposeDeployedApplication, stopRetiredApplicationOrder, undeployRetiredApplicationOrder, isRunningRetryWaitInterval, wlstPath Standard Properties Not To Expose
startOrder : INTEGER = 90 Start Order
startScript : STRING = wls/application/start-application.py Start Script
startVerb : STRING = Start Start Verb
stopOrder : INTEGER = 10 Stop Order
stopRetiredApplicationOrder : INTEGER = 95 Stop Retired Application Order
stopScript : STRING = wls/application/stop-application.py Stop Script
stopVerb : STRING = Stop Stop Verb
undeployRetiredApplicationOrder : INTEGER = 98 Undeploy Retired Application Order
wlstPath : STRING = Libraries Wlst Path
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 Java EE artifact

### wls.Topic

Hierarchy | wls.AbstractTopic >> wls.JmsDestination >> wls.JmsResource >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | 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

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
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.
errorDestination : CI<wls.JmsDestination> 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
createOrder : INTEGER = 60 Create Order
createScript : STRING = wls/jms/create-topic.py Create Script
createVerb : STRING = Create Create Verb
destroyOrder : INTEGER = 40 Destroy Order
destroyScript : STRING = wls/jms/destroy-topic.py Destroy Script
destroyVerb : STRING = Destroy Destroy Verb
modifyOrder : INTEGER = 40 Modify Order
modifyVerb : STRING = Upgrade Modify Verb
setErrorDestinationOrder : INTEGER = 61 Set Error Destination Order
setErrorDestinationScript : STRING = wls/jms/set-error-topic.py Set Error Destination Script
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 Standard Properties Not To Expose
unsetErrorDestinationOrder : INTEGER = 37 Unset Error Destination Order
unsetErrorDestinationScript : STRING = wls/jms/unset-error-topic.py Unset Error Destination Script
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.TopicSpec

Hierarchy | wls.JmsResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

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)
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

Hierarchy | wls.AbstractUniformDistributedQueue >> wls.JmsDestination >> wls.JmsResource >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | 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

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
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.
errorDestination : CI<wls.JmsDestination> 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
createOrder : INTEGER = 60 Create Order
createScript : STRING = wls/jms/create-udd-queue.py Create Script
createVerb : STRING = Create Create Verb
destroyOrder : INTEGER = 40 Destroy Order
destroyScript : STRING = wls/jms/destroy-udd-queue.py Destroy Script
destroyVerb : STRING = Destroy Destroy Verb
modifyOrder : INTEGER = 40 Modify Order
modifyVerb : STRING = Upgrade Modify Verb
setErrorDestinationOrder : INTEGER = 61 Set Error Destination Order
setErrorDestinationScript : STRING = wls/jms/set-udd-error-queue.py Set Error Destination Script
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 Standard Properties Not To Expose
unsetErrorDestinationOrder : INTEGER = 37 Unset Error Destination Order
unsetErrorDestinationScript : STRING = wls/jms/unset-udd-error-queue.py Unset Error Destination Script
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.UniformDistributedQueueSpec

Hierarchy | wls.JmsResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

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)
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

Hierarchy | wls.AbstractUniformDistributedTopic >> wls.JmsDestination >> wls.JmsResource >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | 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

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
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.
errorDestination : CI<wls.JmsDestination> 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
createOrder : INTEGER = 60 Create Order
createScript : STRING = wls/jms/create-udd-topic.py Create Script
createVerb : STRING = Create Create Verb
destroyOrder : INTEGER = 40 Destroy Order
destroyScript : STRING = wls/jms/destroy-udd-topic.py Destroy Script
destroyVerb : STRING = Destroy Destroy Verb
modifyOrder : INTEGER = 40 Modify Order
modifyVerb : STRING = Upgrade Modify Verb
setErrorDestinationOrder : INTEGER = 61 Set Error Destination Order
setErrorDestinationScript : STRING = wls/jms/set-udd-error-topic.py Set Error Destination Script
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 Standard Properties Not To Expose
unsetErrorDestinationOrder : INTEGER = 37 Unset Error Destination Order
unsetErrorDestinationScript : STRING = wls/jms/unset-udd-error-topic.py Unset Error Destination Script
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.UniformDistributedTopicSpec

Hierarchy | wls.JmsResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

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

Hierarchy | jee.War >> udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.ArchiveArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

A JEE WAR archive

Public Properties
block : STRING boolean value specifying whether the deployment should block user interaction until the command complete (boolean)
deploymentOrder : STRING By default, new applications and modules are configured with a Deployment Order value of 100 (integer)
excludeFileNamesRegex : STRING Regular expression that matches file names that must be excluded from scanning
placeholders : SET_OF_STRING Placeholders detected in this artifact
redeploymentStrategy : STRING Indicates what redeployment strategy to use for upgrading the application (enum)
retireTimeout : STRING Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy (integer)
scanPlaceholders : BOOLEAN = true Scan Placeholders
stageMode : STRING Indicates whether the artifact will be deployed as staged or nostage mode (enum)
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)

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

### wls.WarModule

Hierarchy | wls.ExtensibleDeployedArtifact >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

War with values configured for a deployment

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
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
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>
retireTimeout : INTEGER = -1 Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy
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 Indicates wither this artifact is to be deployed as a versioned application

Hidden Properties
createOrder : INTEGER = 70 Create Order
createScript : STRING = wls/application/deploy-application.py Create Script
createVerb : STRING = Deploy Create Verb
destroyOrder : INTEGER = 30 Destroy Order
destroyScript : STRING = wls/application/undeploy-application.py Destroy Script
destroyVerb : STRING = Undeploy Destroy Verb
isRunningRetryWaitInterval : INTEGER = 500 Time in milliseconds to wait before next retry to check if the deployment is still running
modifyOrder : INTEGER = 60 Modify Order
modifyVerb : STRING = Upgrade Modify Verb
standardPropertiesNotToExpose : STRING = id, name, type, deployable, properties, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, startScript, startVerb, startOrder, stopScript, stopVerb, stopOrder, deploymentStrategy, placeholders, file, redeploymentStrategy, securityPermissions, inheritPermissions, exposeDeployedApplication, stopRetiredApplicationOrder, undeployRetiredApplicationOrder, isRunningRetryWaitInterval, wlstPath Standard Properties Not To Expose
startOrder : INTEGER = 90 Start Order
startScript : STRING = wls/application/start-application.py Start Script
startVerb : STRING = Start Start Verb
stopOrder : INTEGER = 10 Stop Order
stopRetiredApplicationOrder : INTEGER = 95 Stop Retired Application Order
stopScript : STRING = wls/application/stop-application.py Stop Script
stopVerb : STRING = Stop Stop Verb
undeployRetiredApplicationOrder : INTEGER = 98 Undeploy Retired Application Order
wlstPath : STRING = AppDeployments Wlst Path
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 Java EE artifact