Oracle SOA Plugin Reference 9.7.x
The XL Deploy Oracle Service-Oriented Architecture (SOA) plugin enables XL Deploy to:
- Update technology adapters in Oracle WebLogic with SOA resources
- Import MetaData Services (MDS) to Oracle Fusion
- Deploy SOA composites (SCA) to Oracle Fusion
- Upload SOA extension libraries to Oracle Fusion
Requirements
- XL Deploy 5.0.0
- XL Deploy WebLogic (WLS) plugin 5.0.0
- WebLogic Domain user credentials
- User credentials for accessing the host running the WebLogic Administration Server
- User credentials for accessing the target hosts of managed servers (for NoStage mode)
Using the deployables and deployeds
Deployable vs. container table
The following table describes which deployable/container combinations are possible.
Deployable | Container | Generated deployed |
---|---|---|
soa.CompositeSpec | wls.Domain wls.Server wls.Cluster |
soa.Composite |
soa.CompositeSOADeployableSpec (deprecated) | wls.Domain wls.Server wls.Cluster |
soa.CompositeSOADeployable |
soa.MdsSpec | wls.Domain wls.Server wls.Cluster |
soa.Mds |
soa.MdsSOADeployableSpec (deprecated) | wls.Domain wls.Server wls.Cluster |
soa.MdsSOADeployable |
soa.DBConnectionFactorySpec | wls.Domain wls.Server wls.Cluster |
soa.DBConnectionFactory |
soa.MQConnectionFactorySpec | wls.Domain wls.Server wls.Cluster |
soa.MQConnectionFactory |
soa.FTPConnectionFactorySpec | wls.Domain wls.Server wls.Cluster |
soa.FTPConnectionFactory |
soa.FileConnectionFactorySpec | wls.Domain wls.Server wls.Cluster |
soa.FileConnectionFactory |
soa.JMSConnectionFactorySpec | wls.Domain wls.Server wls.Cluster |
soa.JMSConnectionFactory |
soa.ExtensionLibrarySpec | wls.Domain wls.Server wls.Cluster |
soa.ExtensionLibrary |
soa.XSLResourcesSpec | wls.Domain wls.Server wls.Cluster |
soa.XSLResources |
Deployed actions table
The following table describes the effect a deployed has on its container.
Deployed | Actions performed for operations | ||
---|---|---|---|
Create | Modify | Destroy | |
soa.Composite soa.CompositeSOADeployable |
|
|
Undeploy the composite from the SOA partition |
soa.Mds soa.MdsSOADeployable |
|
|
Remove the specified item (folder) under app from the MDS Storage |
soa.DBConnectionFactory soa.MQConnectionFactory soa.FileConnectionFactory soa.FTPConnectionFactory soa.JMSConnectionFactory |
|
|
Not yet supported |
soa.ExtensionLibrary |
|
|
Not yet supported |
soa.XSLResources |
|
|
Remove the XSL resources from the target location |
soa.UserMessagingdriverEmail |
|
|
Not yet supported |
Release Notes - SOA Plugin
Version 9.7.0
- [XLINT-1442] - Update/Undeployment failed if property retire=True
Version 9.6.0
- [XLINT-1467] - Compatible with XL Deploy 9.6.0 and wls-plugin-9.6.0
Version 5.0.0
XL Deploy 5.0.0 compatibility.
CI Reference
Configuration Item Overview
Deployables
CI | Description |
---|---|
soa.CompositeSOADeployableSpec | Description unavailable (deployable) |
soa.CompositeSpec | Description unavailable (deployable) |
soa.DBConnectionFactorySpec | Specification for a DB connection factory |
soa.ExtensionLibrarySpec | Soa extension lib that is deployed to the server extension directory |
soa.FTPConnectionFactorySpec | Specification for a FTP connection factory |
soa.FileConnectionFactorySpec | Specification for a File connection factory |
soa.JMSConnectionFactorySpec | Specification for a JMS connection factory |
soa.MQConnectionFactorySpec | Specification for a MQ connection factory |
soa.MdsSOADeployableSpec | Description unavailable (deployable) |
soa.MdsSpec | Description unavailable (deployable) |
soa.ResourceSpec | Specification for a SOA Resource |
soa.UserMessagingdriverEmailSpec | Specification for a UserMessagingdriver Email |
soa.XSLResourcesSpec | Description unavailable (deployable) |
Deployeds
CI | Description |
---|---|
soa.Composite | Description unavailable |
soa.CompositeSOADeployable | Description unavailable |
soa.DBConnectionFactory | Description unavailable |
soa.ExtensionLibrary | Description unavailable |
soa.FTPConnectionFactory | Description unavailable |
soa.FileConnectionFactory | Description unavailable |
soa.JMSConnectionFactory | Description unavailable |
soa.MQConnectionFactory | Description unavailable |
soa.Mds | Description unavailable |
soa.MdsSOADeployable | Description unavailable |
soa.Resource | Description unavailable |
soa.UserMessagingdriverEmail | Description unavailable |
soa.XSLResources | Description unavailable |
Configuration Item Details
soa.Composite
Type Hierarchy | soa.CompositeSOADeployable >> wls.ExtensibleDeployedArtifact >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer, python.IPythonManagedDeployed |
Description unavailable
Parent | ||
---|---|---|
|
|
container:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public properties | ||
---|---|---|
|
|
deploymentOrder: INTEGER = 100
|
By default, new applications and modules are configured with a Deployment Order value of 100
|
||
|
|
forcedefault: STRING
|
Forcedefault
|
||
|
|
partition: STRING
|
Partition
|
||
|
|
redeploymentStrategy: ENUM [CLASSIC, STOP_START, SIDE_BY_SIDE] = CLASSIC
|
Indicates what redeployment strategy to use for upgrading the application. Possible values: CLASSIC, STOP_START, SIDE_BY_SIDE
|
||
|
|
retireTimeout: INTEGER = -1
|
Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy
|
||
|
|
automaticVersioning: BOOLEAN = true
|
If set, the 'versionIdentifier' property is managed by the plugin. Any value explicitly set for 'versionIdentifier' is ignored. 'automaticVersioning' is enabled by default, in which case a unique version is created for the deployed module. If the manifest file includes an implementation version, then you must disable 'automaticVersioning'. If your manifest file includes a specification version and you want to use the implementation version that is defined in the manifest file, then you must set 'automaticVersioning' to false and enter the specification version as the 'versionIdentifier' property on the CI.
|
||
|
|
block: BOOLEAN = true
|
boolean value specifying whether the deployment should block user interaction until the command complete
|
||
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
keepInstancesOnRedeploy: STRING = false
|
Works with BPM composites from 12c only. Default: false
|
||
|
|
placeholders: MAP_STRING_STRING
|
A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
|
||
|
|
planPath: STRING
|
Name of the deployment plan file. The filename can be absolute or relative to the application directory.
|
||
|
|
retire: BOOLEAN
|
If True, during undeploy the 'retire' logic will be followed. Default: False
|
||
|
|
revisionVersion: STRING
|
The revision version (will be used in case of undeployment), if not defined revision from jar file name will be used.
|
||
|
|
soaServiceName: STRING
|
Soa Service Name
|
||
|
|
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 | ||
---|---|---|
|
|
createOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
createOrder: INTEGER = 65
|
Create Order
|
||
|
|
createScript: STRING = scripts/soaDeploy.py
|
Python script invoked to deploy this Java EE artifact
|
||
|
|
createVerb: STRING = Deploy
|
Create Verb
|
||
|
|
deleteArtifactOrder: INTEGER = 31
|
Delete Artifact Order
|
||
|
|
deleteRetiredArtifactOrder: INTEGER = 99
|
Delete Retired Artifact Order
|
||
|
|
destroyOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
destroyOrder: INTEGER = 38
|
Destroy Order
|
||
|
|
destroyScript: STRING = scripts/soaUndeploy.py
|
Python script invoked to undeploy this Java EE artifact
|
||
|
|
destroyVerb: STRING = Undeploy
|
Destroy Verb
|
||
|
|
discoverOrder: INTEGER = 50
|
The order in which a discover step will be executed.
|
||
|
|
isRunningRetryWaitInterval: INTEGER = 500
|
Time in milliseconds to wait before next retry to check if the deployment is still running
|
||
|
|
manifestVersionProperty: STRING = Extension-Name
|
Property in the manifest file of the archive indicating that it is a versioned artifact. You can override this property in XLDEPLOY_HOME/conf/deployit-defaults.properties. For example: wls.WarModule.manifestVersionProperty=Weblogic-Application-Version.
|
||
|
|
modifyOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
modifyOrder: INTEGER = 65
|
Modify Order
|
||
|
|
modifyScript: STRING = scripts/soaDeploy.py
|
Python script invoked to upgrade this Java EE artifact
|
||
|
|
modifyVerb: STRING = Upgrade
|
Modify Verb
|
||
|
|
noopOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
order: STRING = 76
|
Order
|
||
|
|
standardPropertiesNotToExpose: STRING = id, name, type, deployable, properties, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, deleteArtifactOrder, startScript, startVerb, startOrder, stopScript, stopVerb, stopOrder, deploymentStrategy, placeholders, file, redeploymentStrategy, securityPermissions, inheritPermissions, exposeDeployedApplication, stopRetiredApplicationOrder, undeployRetiredApplicationOrder, deleteRetiredArtifactOrder, isRunningRetryWaitInterval, wlstPath, libraryScripts, discoverOrder, deploymentOrder, isStartOrStopOperationRequired, automaticVersioning, createOptions, modifyOptions, destroyOptions, noopOptions, manifestVersionProperty, versionTemplateFile, provisioners, ordinal, boundConfigurationItems
|
Standard Properties Not To Expose
|
||
|
|
startOrder: INTEGER = 90
|
Start Order
|
||
|
|
startScript: STRING = wls/application/start-application.py
|
Python script invoked to start this Java EE artifact
|
||
|
|
startVerb: STRING = Start
|
Start Verb
|
||
|
|
stopOrder: INTEGER = 10
|
Stop Order
|
||
|
|
stopRetiredApplicationOrder: INTEGER = 95
|
Stop Retired Application Order
|
||
|
|
stopScript: STRING = wls/application/stop-application.py
|
Python script invoked to stop this Java EE artifact
|
||
|
|
stopVerb: STRING = Stop
|
Stop Verb
|
||
|
|
undeployRetiredApplicationOrder: INTEGER = 98
|
Undeploy Retired Application Order
|
||
|
|
versionExpression: STRING = [#ftl]${manifestAttributes["Specification-Version"]}[#if manifestAttributes["Implementation-Version"]??]@${manifestAttributes["Implementation-Version"]}[/#if]
|
FreeMarker expression used to build the version based on the manifest file (properties are put in a map named 'manifestAttributes'). You can override this property in XLDEPLOY_HOME/conf/deployit-defaults.properties. For example: wls.WarModule.versionExpression=${manifestAttributes['Weblogic-Application-Version']}.
|
||
|
|
wlstPath: STRING = AppDeployments
|
Wlst Path
|
||
|
|
activationTimeout: INTEGER = -10
|
Time (in milliseconds) that WLST waits for the activation of configuration changes to complete before canceling the operation. A value of -1 indicates that the operation will not time out. A value of -10 indicates that this parameter will not be taken into account and server set default will be used. This argument normally defaults to 300,000 ms (or 5 minutes).
|
||
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
||
|
|
exposeDeployedApplication: BOOLEAN
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
isStartOrStopOperationRequired: BOOLEAN
|
Is Start Or Stop Operation Required
|
||
|
|
libraryScripts: LIST_OF_STRING
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
retainRemoteWorkingDirectory: BOOLEAN = true
|
Retain Remote Working Directory
|
||
|
|
scanPlaceholders: BOOLEAN = true
|
Scan Placeholders
|
soa.CompositeSOADeployable
Type Hierarchy | wls.ExtensibleDeployedArtifact >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer, python.IPythonManagedDeployed |
Description unavailable
Parent | ||
---|---|---|
|
|
container:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public properties | ||
---|---|---|
|
|
deploymentOrder: INTEGER = 100
|
By default, new applications and modules are configured with a Deployment Order value of 100
|
||
|
|
forcedefault: STRING
|
Forcedefault
|
||
|
|
partition: STRING
|
Partition
|
||
|
|
redeploymentStrategy: ENUM [CLASSIC, STOP_START, SIDE_BY_SIDE] = CLASSIC
|
Indicates what redeployment strategy to use for upgrading the application. Possible values: CLASSIC, STOP_START, SIDE_BY_SIDE
|
||
|
|
retireTimeout: INTEGER = -1
|
Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy
|
||
|
|
automaticVersioning: BOOLEAN = true
|
If set, the 'versionIdentifier' property is managed by the plugin. Any value explicitly set for 'versionIdentifier' is ignored. 'automaticVersioning' is enabled by default, in which case a unique version is created for the deployed module. If the manifest file includes an implementation version, then you must disable 'automaticVersioning'. If your manifest file includes a specification version and you want to use the implementation version that is defined in the manifest file, then you must set 'automaticVersioning' to false and enter the specification version as the 'versionIdentifier' property on the CI.
|
||
|
|
block: BOOLEAN = true
|
boolean value specifying whether the deployment should block user interaction until the command complete
|
||
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
keepInstancesOnRedeploy: STRING = false
|
Works with BPM composites from 12c only. Default: false
|
||
|
|
placeholders: MAP_STRING_STRING
|
A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
|
||
|
|
planPath: STRING
|
Name of the deployment plan file. The filename can be absolute or relative to the application directory.
|
||
|
|
retire: BOOLEAN
|
If True, during undeploy the 'retire' logic will be followed. Default: False
|
||
|
|
revisionVersion: STRING
|
The revision version (will be used in case of undeployment), if not defined revision from jar file name will be used.
|
||
|
|
soaServiceName: STRING
|
Soa Service Name
|
||
|
|
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 | ||
---|---|---|
|
|
createOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
createOrder: INTEGER = 65
|
Create Order
|
||
|
|
createScript: STRING = scripts/soaDeploy.py
|
Python script invoked to deploy this Java EE artifact
|
||
|
|
createVerb: STRING = Deploy
|
Create Verb
|
||
|
|
deleteArtifactOrder: INTEGER = 31
|
Delete Artifact Order
|
||
|
|
deleteRetiredArtifactOrder: INTEGER = 99
|
Delete Retired Artifact Order
|
||
|
|
destroyOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
destroyOrder: INTEGER = 38
|
Destroy Order
|
||
|
|
destroyScript: STRING = scripts/soaUndeploy.py
|
Python script invoked to undeploy this Java EE artifact
|
||
|
|
destroyVerb: STRING = Undeploy
|
Destroy Verb
|
||
|
|
discoverOrder: INTEGER = 50
|
The order in which a discover step will be executed.
|
||
|
|
isRunningRetryWaitInterval: INTEGER = 500
|
Time in milliseconds to wait before next retry to check if the deployment is still running
|
||
|
|
manifestVersionProperty: STRING = Extension-Name
|
Property in the manifest file of the archive indicating that it is a versioned artifact. You can override this property in XLDEPLOY_HOME/conf/deployit-defaults.properties. For example: wls.WarModule.manifestVersionProperty=Weblogic-Application-Version.
|
||
|
|
modifyOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
modifyOrder: INTEGER = 65
|
Modify Order
|
||
|
|
modifyScript: STRING = scripts/soaDeploy.py
|
Python script invoked to upgrade this Java EE artifact
|
||
|
|
modifyVerb: STRING = Upgrade
|
Modify Verb
|
||
|
|
noopOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
order: STRING = 76
|
Order
|
||
|
|
standardPropertiesNotToExpose: STRING = id, name, type, deployable, properties, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, deleteArtifactOrder, startScript, startVerb, startOrder, stopScript, stopVerb, stopOrder, deploymentStrategy, placeholders, file, redeploymentStrategy, securityPermissions, inheritPermissions, exposeDeployedApplication, stopRetiredApplicationOrder, undeployRetiredApplicationOrder, deleteRetiredArtifactOrder, isRunningRetryWaitInterval, wlstPath, libraryScripts, discoverOrder, deploymentOrder, isStartOrStopOperationRequired, automaticVersioning, createOptions, modifyOptions, destroyOptions, noopOptions, manifestVersionProperty, versionTemplateFile, provisioners, ordinal, boundConfigurationItems
|
Standard Properties Not To Expose
|
||
|
|
startOrder: INTEGER = 90
|
Start Order
|
||
|
|
startScript: STRING = wls/application/start-application.py
|
Python script invoked to start this Java EE artifact
|
||
|
|
startVerb: STRING = Start
|
Start Verb
|
||
|
|
stopOrder: INTEGER = 10
|
Stop Order
|
||
|
|
stopRetiredApplicationOrder: INTEGER = 95
|
Stop Retired Application Order
|
||
|
|
stopScript: STRING = wls/application/stop-application.py
|
Python script invoked to stop this Java EE artifact
|
||
|
|
stopVerb: STRING = Stop
|
Stop Verb
|
||
|
|
undeployRetiredApplicationOrder: INTEGER = 98
|
Undeploy Retired Application Order
|
||
|
|
versionExpression: STRING = [#ftl]${manifestAttributes["Specification-Version"]}[#if manifestAttributes["Implementation-Version"]??]@${manifestAttributes["Implementation-Version"]}[/#if]
|
FreeMarker expression used to build the version based on the manifest file (properties are put in a map named 'manifestAttributes'). You can override this property in XLDEPLOY_HOME/conf/deployit-defaults.properties. For example: wls.WarModule.versionExpression=${manifestAttributes['Weblogic-Application-Version']}.
|
||
|
|
wlstPath: STRING = AppDeployments
|
Wlst Path
|
||
|
|
activationTimeout: INTEGER = -10
|
Time (in milliseconds) that WLST waits for the activation of configuration changes to complete before canceling the operation. A value of -1 indicates that the operation will not time out. A value of -10 indicates that this parameter will not be taken into account and server set default will be used. This argument normally defaults to 300,000 ms (or 5 minutes).
|
||
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
||
|
|
exposeDeployedApplication: BOOLEAN
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
isStartOrStopOperationRequired: BOOLEAN
|
Is Start Or Stop Operation Required
|
||
|
|
libraryScripts: LIST_OF_STRING
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
retainRemoteWorkingDirectory: BOOLEAN = true
|
Retain Remote Working Directory
|
||
|
|
scanPlaceholders: BOOLEAN = true
|
Scan Placeholders
|
soa.CompositeSOADeployableSpec
Type Hierarchy | udm.BaseDeployableFolderArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FolderArtifact, udm.SourceArtifact, udm.Taggable |
Description unavailable (deployable)
Public properties | ||
---|---|---|
|
|
automaticVersioning: STRING
|
If set, the 'versionIdentifier' property is managed by the plugin. Any value explicitly set for 'versionIdentifier' is ignored. 'automaticVersioning' is enabled by default, in which case a unique version is created for the deployed module. If the manifest file includes an implementation version, then you must disable 'automaticVersioning'. If your manifest file includes a specification version and you want to use the implementation version that is defined in the manifest file, then you must set 'automaticVersioning' to false and enter the specification version as the 'versionIdentifier' property on the CI. (boolean) default(true)
|
||
|
|
block: STRING
|
boolean value specifying whether the deployment should block user interaction until the command complete (boolean) default(true)
|
||
|
|
checksum: STRING
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
credentials:
CI<credentials.Credentials>
|
Credentials of the URI.
|
||
|
|
deploymentOrder: STRING
|
By default, new applications and modules are configured with a Deployment Order value of 100 (integer) default(100)
|
||
|
|
excludeFileNamesRegex: STRING
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
|
A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
|
||
|
|
fileUri: STRING
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
forcedefault: STRING
|
Forcedefault (string)
|
||
|
|
keepInstancesOnRedeploy: STRING
|
Works with BPM composites from 12c only. Default: false (string) default(false)
|
||
|
|
partition: STRING
|
Partition (string)
|
||
|
|
placeholders: SET_OF_STRING
|
Placeholders detected in this artifact
|
||
|
|
planPath: STRING
|
Name of the deployment plan file. The filename can be absolute or relative to the application directory. (string)
|
||
|
|
preScannedPlaceholders: BOOLEAN
|
Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
|
||
|
|
proxySettings:
CI<credentials.ProxySettings>
|
Proxy Settings for artifact location
|
||
|
|
redeploymentStrategy: STRING
|
Indicates what redeployment strategy to use for upgrading the application. Possible values: CLASSIC, STOP_START, SIDE_BY_SIDE (enum) values(CLASSIC, STOP_START, SIDE_BY_SIDE) default(CLASSIC)
|
||
|
|
retire: STRING
|
If True, during undeploy the 'retire' logic will be followed. Default: False (boolean) default(false)
|
||
|
|
retireTimeout: STRING
|
Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy (integer) default(-1)
|
||
|
|
revisionVersion: STRING
|
The revision version (will be used in case of undeployment), if not defined revision from jar file name will be used. (string)
|
||
|
|
scanPlaceholders: BOOLEAN = true
|
Whether to scan this artifact to replace placeholders when it is imported
|
||
|
|
soaServiceName: STRING
|
Soa Service Name (string) default()
|
||
|
|
stageMode: STRING
|
Indicates whether the artifact will be deployed as staged or nostage mode (enum) values(Stage, NoStage) default(Stage)
|
||
|
|
stagingDirectory: STRING
|
Absolute directory path where the artifact will be uploaded and used by the servers for nostage deployment mode (string)
|
||
|
|
tags: SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
versionIdentifier: STRING
|
Version Identifier (string)
|
||
|
|
versioned: STRING
|
Indicates wither this artifact is to be deployed as a versioned application (boolean) default(false)
|
Hidden properties | ||
---|---|---|
|
|
textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|
Regular expression that matches file names of text files
|
||
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
The set of CI templates.
|
||
|
|
delimiters: STRING = {{ }}
|
The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|
soa.CompositeSpec
Type Hierarchy | soa.CompositeSOADeployableSpec >> udm.BaseDeployableFolderArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FolderArtifact, udm.SourceArtifact, udm.Taggable |
Description unavailable (deployable)
Public properties | ||
---|---|---|
|
|
automaticVersioning: STRING
|
If set, the 'versionIdentifier' property is managed by the plugin. Any value explicitly set for 'versionIdentifier' is ignored. 'automaticVersioning' is enabled by default, in which case a unique version is created for the deployed module. If the manifest file includes an implementation version, then you must disable 'automaticVersioning'. If your manifest file includes a specification version and you want to use the implementation version that is defined in the manifest file, then you must set 'automaticVersioning' to false and enter the specification version as the 'versionIdentifier' property on the CI. (boolean) default(true)
|
||
|
|
block: STRING
|
boolean value specifying whether the deployment should block user interaction until the command complete (boolean) default(true)
|
||
|
|
checksum: STRING
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
credentials:
CI<credentials.Credentials>
|
Credentials of the URI.
|
||
|
|
deploymentOrder: STRING
|
By default, new applications and modules are configured with a Deployment Order value of 100 (integer) default(100)
|
||
|
|
excludeFileNamesRegex: STRING
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
|
A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
|
||
|
|
fileUri: STRING
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
forcedefault: STRING
|
Forcedefault (string)
|
||
|
|
keepInstancesOnRedeploy: STRING
|
Works with BPM composites from 12c only. Default: false (string) default(false)
|
||
|
|
partition: STRING
|
Partition (string)
|
||
|
|
placeholders: SET_OF_STRING
|
Placeholders detected in this artifact
|
||
|
|
planPath: STRING
|
Name of the deployment plan file. The filename can be absolute or relative to the application directory. (string)
|
||
|
|
preScannedPlaceholders: BOOLEAN
|
Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
|
||
|
|
proxySettings:
CI<credentials.ProxySettings>
|
Proxy Settings for artifact location
|
||
|
|
redeploymentStrategy: STRING
|
Indicates what redeployment strategy to use for upgrading the application. Possible values: CLASSIC, STOP_START, SIDE_BY_SIDE (enum) values(CLASSIC, STOP_START, SIDE_BY_SIDE) default(CLASSIC)
|
||
|
|
retire: STRING
|
If True, during undeploy the 'retire' logic will be followed. Default: False (boolean) default(false)
|
||
|
|
retireTimeout: STRING
|
Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy (integer) default(-1)
|
||
|
|
revisionVersion: STRING
|
The revision version (will be used in case of undeployment), if not defined revision from jar file name will be used. (string)
|
||
|
|
scanPlaceholders: BOOLEAN = true
|
Whether to scan this artifact to replace placeholders when it is imported
|
||
|
|
soaServiceName: STRING
|
Soa Service Name (string) default()
|
||
|
|
stageMode: STRING
|
Indicates whether the artifact will be deployed as staged or nostage mode (enum) values(Stage, NoStage) default(Stage)
|
||
|
|
stagingDirectory: STRING
|
Absolute directory path where the artifact will be uploaded and used by the servers for nostage deployment mode (string)
|
||
|
|
tags: SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
versionIdentifier: STRING
|
Version Identifier (string)
|
||
|
|
versioned: STRING
|
Indicates wither this artifact is to be deployed as a versioned application (boolean) default(false)
|
Hidden properties | ||
---|---|---|
|
|
textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|
Regular expression that matches file names of text files
|
||
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
The set of CI templates.
|
||
|
|
delimiters: STRING = {{ }}
|
The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|
soa.DBConnectionFactory
Type Hierarchy | soa.Resource >> wls.Resource >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployed, udm.EmbeddedDeployedContainer, python.IPythonManagedDeployed |
Description unavailable
Parent | ||
---|---|---|
|
|
container:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public properties | ||
---|---|---|
|
|
AppPath: STRING
|
App Path
|
||
|
|
PlanPath: STRING
|
Plan Path
|
||
|
|
appName: STRING
|
App Name
|
||
|
|
dataSourceType: STRING
|
Data Source Type
|
||
|
|
dsJndiName: STRING
|
Ds Jndi Name
|
||
|
|
jndiName: STRING
|
Jndi Name
|
||
|
|
targetRestartPolicy: ENUM [RESTART, STOP_START] = RESTART
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true'
|
||
|
|
SoaId: STRING
|
Makes the deployment plan variables unique. If not defined the name of the ConnectionFactory will be used.
|
||
|
|
Target: STRING
|
The target container to map the SOA Resource to. If not defined, the mapped container name will be used.
|
||
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
restartTarget: BOOLEAN
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource
|
Hidden properties | ||
---|---|---|
|
|
createOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
createOrder: INTEGER = 62
|
Create Order
|
||
|
|
createScript: STRING = scripts/create-dbConnectionFactory.py
|
Python script invoked to create this resource
|
||
|
|
createVerb: STRING = Create
|
Create Verb
|
||
|
|
destroyOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
destroyOrder: INTEGER = 39
|
Destroy Order
|
||
|
|
destroyScript: STRING = scripts/destroy-dbConnectionFactory.py
|
Python script invoked to destroy this resource
|
||
|
|
destroyVerb: STRING = Destroy
|
Destroy Verb
|
||
|
|
discoverOrder: INTEGER = 50
|
The order in which a discover step will be executed.
|
||
|
|
libraryScripts: LIST_OF_STRING = [soa/runtime/ConnectionFactory.py]
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
modifyOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
modifyOrder: INTEGER = 62
|
Modify Order
|
||
|
|
modifyVerb: STRING = Upgrade
|
Modify Verb
|
||
|
|
noopOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
standardPropertiesNotToExpose: STRING = id, name, type, _properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyScript, destroyVerb, destroyOrder, jndiName, restartTarget, libraryScripts, discoverOrder, targetRestartPolicy, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
Standard Properties Not To Expose
|
||
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
||
|
|
exposeDeployedApplication: BOOLEAN
|
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
|
||
|
|
retainRemoteWorkingDirectory: BOOLEAN = true
|
Retain Remote Working Directory
|
soa.DBConnectionFactorySpec
Type Hierarchy | soa.ResourceSpec >> wls.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployable, udm.Taggable |
Specification for a DB connection factory
Public properties | ||
---|---|---|
|
|
AppPath: STRING
|
App Path (string)
|
||
|
|
PlanPath: STRING
|
Plan Path (string)
|
||
|
|
SoaId: STRING
|
Makes the deployment plan variables unique. If not defined the name of the ConnectionFactory will be used. (string)
|
||
|
|
Target: STRING
|
The target container to map the SOA Resource to. If not defined, the mapped container name will be used. (string)
|
||
|
|
appName: STRING
|
App Name (string)
|
||
|
|
dataSourceType: STRING
|
Data Source Type (string)
|
||
|
|
dsJndiName: STRING
|
Ds Jndi Name (string)
|
||
|
|
jndiName: STRING
|
Jndi Name (string)
|
||
|
|
restartTarget: STRING
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource (boolean) default(false)
|
||
|
|
tags: SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
targetRestartPolicy: STRING
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true' (enum) values(RESTART, STOP_START) default(RESTART)
|
Hidden properties | ||
---|---|---|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
The set of CI templates.
|
soa.ExtensionLibrary
Type Hierarchy | wls.DeployedFile >> wls.CopiedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
Description unavailable
Parent | ||
---|---|---|
|
|
container:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public properties | ||
---|---|---|
|
|
AntHomeDirectory: STRING
|
Ant Home Directory
|
||
|
|
targetDirectory: STRING = ${deployed.container.domain.domainHome}/lib
|
Path to which artifact must be copied to on the wls server.
|
||
|
|
targetRestartPolicy: ENUM [RESTART, STOP_START] = RESTART
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true'
|
||
|
|
createTargetDirectory: BOOLEAN
|
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
|
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.
|
||
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
soa.ExtensionLibrarySpec
Type Hierarchy | wls.File >> generic.File >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable |
Soa extension lib that is deployed to the server extension directory
Public properties | ||
---|---|---|
|
|
AntHomeDirectory: STRING
|
Ant Home Directory (string)
|
||
|
|
checksum: STRING
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
createTargetDirectory: STRING
|
Create the target directory on the wls server if it does not exist. (boolean) default(false)
|
||
|
|
credentials:
CI<credentials.Credentials>
|
Credentials of the URI.
|
||
|
|
excludeFileNamesRegex: STRING
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
|
A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
|
||
|
|
fileUri: STRING
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
placeholders: SET_OF_STRING
|
Placeholders detected in this artifact
|
||
|
|
preScannedPlaceholders: BOOLEAN
|
Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
|
||
|
|
proxySettings:
CI<credentials.ProxySettings>
|
Proxy Settings for artifact location
|
||
|
|
restartTarget: STRING
|
Restart the target container (boolean) default(false)
|
||
|
|
scanPlaceholders: BOOLEAN = true
|
Whether to scan this artifact to replace placeholders when it is imported
|
||
|
|
tags: SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
targetDirectory: STRING
|
Path to which artifact must be copied to on the wls server. (string) default(${deployed.container.domain.domainHome}/lib)
|
||
|
|
targetDirectoryShared: STRING
|
Is the target directory shared by others on the wls server. When true, the target directory is not deleted during a destroy operation; only the artifacts copied to it. (boolean) default(true)
|
||
|
|
targetFile: STRING
|
Name of the artifact on the wls server. (string)
|
||
|
|
targetRestartPolicy: STRING
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true' (enum) values(RESTART, STOP_START) default(RESTART)
|
Hidden properties | ||
---|---|---|
|
|
textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|
Regular expression that matches file names of text files
|
||
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
The set of CI templates.
|
||
|
|
delimiters: STRING = {{ }}
|
The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|
soa.FTPConnectionFactory
Type Hierarchy | soa.Resource >> wls.Resource >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployed, udm.EmbeddedDeployedContainer, python.IPythonManagedDeployed |
Description unavailable
Parent | ||
---|---|---|
|
|
container:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public properties | ||
---|---|---|
|
|
AppPath: STRING
|
App Path
|
||
|
|
HostName: STRING
|
Host Name
|
||
|
|
PlanPath: STRING
|
Plan Path
|
||
|
|
appName: STRING
|
App Name
|
||
|
|
jndiName: STRING
|
Jndi Name
|
||
|
|
targetRestartPolicy: ENUM [RESTART, STOP_START] = RESTART
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true'
|
||
|
|
username: STRING
|
Username
|
||
|
|
SoaId: STRING
|
Makes the deployment plan variables unique. If not defined the name of the ConnectionFactory will be used.
|
||
|
|
Target: STRING
|
The target container to map the SOA Resource to. If not defined, the mapped container name will be used.
|
||
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
password: STRING
|
Password
|
||
|
|
restartTarget: BOOLEAN
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource
|
Hidden properties | ||
---|---|---|
|
|
createOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
createOrder: INTEGER = 62
|
Create Order
|
||
|
|
createScript: STRING = scripts/create-ftpConnectionFactory.py
|
Python script invoked to create this resource
|
||
|
|
createVerb: STRING = Create
|
Create Verb
|
||
|
|
destroyOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
destroyOrder: INTEGER = 39
|
Destroy Order
|
||
|
|
destroyScript: STRING = scripts/destroy-ftpConnectionFactory.py
|
Python script invoked to destroy this resource
|
||
|
|
destroyVerb: STRING = Destroy
|
Destroy Verb
|
||
|
|
discoverOrder: INTEGER = 50
|
The order in which a discover step will be executed.
|
||
|
|
libraryScripts: LIST_OF_STRING = [soa/runtime/ConnectionFactory.py]
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
modifyOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
modifyOrder: INTEGER = 62
|
Modify Order
|
||
|
|
modifyVerb: STRING = Upgrade
|
Modify Verb
|
||
|
|
noopOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
standardPropertiesNotToExpose: STRING = id, name, type, _properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyScript, destroyVerb, destroyOrder, jndiName, restartTarget, libraryScripts, discoverOrder, targetRestartPolicy, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
Standard Properties Not To Expose
|
||
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
||
|
|
exposeDeployedApplication: BOOLEAN
|
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
|
||
|
|
retainRemoteWorkingDirectory: BOOLEAN = true
|
Retain Remote Working Directory
|
soa.FTPConnectionFactorySpec
Type Hierarchy | soa.ResourceSpec >> wls.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployable, udm.Taggable |
Specification for a FTP connection factory
Public properties | ||
---|---|---|
|
|
AppPath: STRING
|
App Path (string)
|
||
|
|
HostName: STRING
|
Host Name (string)
|
||
|
|
PlanPath: STRING
|
Plan Path (string)
|
||
|
|
SoaId: STRING
|
Makes the deployment plan variables unique. If not defined the name of the ConnectionFactory will be used. (string)
|
||
|
|
Target: STRING
|
The target container to map the SOA Resource to. If not defined, the mapped container name will be used. (string)
|
||
|
|
appName: STRING
|
App Name (string)
|
||
|
|
jndiName: STRING
|
Jndi Name (string)
|
||
|
|
password: STRING
|
Password (string) default()
|
||
|
|
restartTarget: STRING
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource (boolean) default(false)
|
||
|
|
tags: SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
targetRestartPolicy: STRING
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true' (enum) values(RESTART, STOP_START) default(RESTART)
|
||
|
|
username: STRING
|
Username (string)
|
Hidden properties | ||
---|---|---|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
The set of CI templates.
|
soa.FileConnectionFactory
Type Hierarchy | soa.Resource >> wls.Resource >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployed, udm.EmbeddedDeployedContainer, python.IPythonManagedDeployed |
Description unavailable
Parent | ||
---|---|---|
|
|
container:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public properties | ||
---|---|---|
|
|
AppPath: STRING
|
App Path
|
||
|
|
PlanPath: STRING
|
Plan Path
|
||
|
|
appName: STRING
|
App Name
|
||
|
|
controlDir: STRING
|
Control Dir
|
||
|
|
jndiName: STRING
|
Jndi Name
|
||
|
|
targetRestartPolicy: ENUM [RESTART, STOP_START] = RESTART
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true'
|
||
|
|
SoaId: STRING
|
Makes the deployment plan variables unique. If not defined the name of the ConnectionFactory will be used.
|
||
|
|
Target: STRING
|
The target container to map the SOA Resource to. If not defined, the mapped container name will be used.
|
||
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
restartTarget: BOOLEAN
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource
|
Hidden properties | ||
---|---|---|
|
|
createOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
createOrder: INTEGER = 62
|
Create Order
|
||
|
|
createScript: STRING = scripts/create-fileConnectionFactory.py
|
Python script invoked to create this resource
|
||
|
|
createVerb: STRING = Create
|
Create Verb
|
||
|
|
destroyOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
destroyOrder: INTEGER = 39
|
Destroy Order
|
||
|
|
destroyScript: STRING = scripts/destroy-fileConnectionFactory.py
|
Python script invoked to destroy this resource
|
||
|
|
destroyVerb: STRING = Destroy
|
Destroy Verb
|
||
|
|
discoverOrder: INTEGER = 50
|
The order in which a discover step will be executed.
|
||
|
|
libraryScripts: LIST_OF_STRING = [soa/runtime/ConnectionFactory.py]
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
modifyOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
modifyOrder: INTEGER = 62
|
Modify Order
|
||
|
|
modifyVerb: STRING = Upgrade
|
Modify Verb
|
||
|
|
noopOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
standardPropertiesNotToExpose: STRING = id, name, type, _properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyScript, destroyVerb, destroyOrder, jndiName, restartTarget, libraryScripts, discoverOrder, targetRestartPolicy, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
Standard Properties Not To Expose
|
||
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
||
|
|
exposeDeployedApplication: BOOLEAN
|
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
|
||
|
|
retainRemoteWorkingDirectory: BOOLEAN = true
|
Retain Remote Working Directory
|
soa.FileConnectionFactorySpec
Type Hierarchy | soa.ResourceSpec >> wls.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployable, udm.Taggable |
Specification for a File connection factory
Public properties | ||
---|---|---|
|
|
AppPath: STRING
|
App Path (string)
|
||
|
|
PlanPath: STRING
|
Plan Path (string)
|
||
|
|
SoaId: STRING
|
Makes the deployment plan variables unique. If not defined the name of the ConnectionFactory will be used. (string)
|
||
|
|
Target: STRING
|
The target container to map the SOA Resource to. If not defined, the mapped container name will be used. (string)
|
||
|
|
appName: STRING
|
App Name (string)
|
||
|
|
controlDir: STRING
|
Control Dir (string)
|
||
|
|
jndiName: STRING
|
Jndi Name (string)
|
||
|
|
restartTarget: STRING
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource (boolean) default(false)
|
||
|
|
tags: SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
targetRestartPolicy: STRING
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true' (enum) values(RESTART, STOP_START) default(RESTART)
|
Hidden properties | ||
---|---|---|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
The set of CI templates.
|
soa.JMSConnectionFactory
Type Hierarchy | soa.Resource >> wls.Resource >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployed, udm.EmbeddedDeployedContainer, python.IPythonManagedDeployed |
Description unavailable
Parent | ||
---|---|---|
|
|
container:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public properties | ||
---|---|---|
|
|
AppPath: STRING
|
App Path
|
||
|
|
PlanPath: STRING
|
Plan Path
|
||
|
|
appName: STRING
|
App Name
|
||
|
|
dataSourceType: STRING
|
Data Source Type
|
||
|
|
dsJndiName: STRING
|
Ds Jndi Name
|
||
|
|
jndiName: STRING
|
Jndi Name
|
||
|
|
targetRestartPolicy: ENUM [RESTART, STOP_START] = RESTART
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true'
|
||
|
|
SoaId: STRING
|
Makes the deployment plan variables unique. If not defined the name of the ConnectionFactory will be used.
|
||
|
|
Target: STRING
|
The target container to map the SOA Resource to. If not defined, the mapped container name will be used.
|
||
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
restartTarget: BOOLEAN
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource
|
Hidden properties | ||
---|---|---|
|
|
createOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
createOrder: INTEGER = 62
|
Create Order
|
||
|
|
createScript: STRING = scripts/create-jmsConnectionFactory.py
|
Python script invoked to create this resource
|
||
|
|
createVerb: STRING = Create
|
Create Verb
|
||
|
|
destroyOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
destroyOrder: INTEGER = 39
|
Destroy Order
|
||
|
|
destroyScript: STRING = scripts/destroy-jmsConnectionFactory.py
|
Python script invoked to destroy this resource
|
||
|
|
destroyVerb: STRING = Destroy
|
Destroy Verb
|
||
|
|
discoverOrder: INTEGER = 50
|
The order in which a discover step will be executed.
|
||
|
|
libraryScripts: LIST_OF_STRING = [soa/runtime/ConnectionFactory.py]
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
modifyOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
modifyOrder: INTEGER = 62
|
Modify Order
|
||
|
|
modifyVerb: STRING = Upgrade
|
Modify Verb
|
||
|
|
noopOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
standardPropertiesNotToExpose: STRING = id, name, type, _properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyScript, destroyVerb, destroyOrder, jndiName, restartTarget, libraryScripts, discoverOrder, targetRestartPolicy, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
Standard Properties Not To Expose
|
||
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
||
|
|
exposeDeployedApplication: BOOLEAN
|
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
|
||
|
|
retainRemoteWorkingDirectory: BOOLEAN = true
|
Retain Remote Working Directory
|
soa.JMSConnectionFactorySpec
Type Hierarchy | soa.ResourceSpec >> wls.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployable, udm.Taggable |
Specification for a JMS connection factory
Public properties | ||
---|---|---|
|
|
AppPath: STRING
|
App Path (string)
|
||
|
|
PlanPath: STRING
|
Plan Path (string)
|
||
|
|
SoaId: STRING
|
Makes the deployment plan variables unique. If not defined the name of the ConnectionFactory will be used. (string)
|
||
|
|
Target: STRING
|
The target container to map the SOA Resource to. If not defined, the mapped container name will be used. (string)
|
||
|
|
appName: STRING
|
App Name (string)
|
||
|
|
dataSourceType: STRING
|
Data Source Type (string)
|
||
|
|
dsJndiName: STRING
|
Ds Jndi Name (string)
|
||
|
|
jndiName: STRING
|
Jndi Name (string)
|
||
|
|
restartTarget: STRING
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource (boolean) default(false)
|
||
|
|
tags: SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
targetRestartPolicy: STRING
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true' (enum) values(RESTART, STOP_START) default(RESTART)
|
Hidden properties | ||
---|---|---|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
The set of CI templates.
|
soa.MQConnectionFactory
Type Hierarchy | soa.Resource >> wls.Resource >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployed, udm.EmbeddedDeployedContainer, python.IPythonManagedDeployed |
Description unavailable
Parent | ||
---|---|---|
|
|
container:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public properties | ||
---|---|---|
|
|
AppPath: STRING
|
App Path
|
||
|
|
Channel: STRING
|
Channel
|
||
|
|
HostName: STRING
|
Host Name
|
||
|
|
PlanPath: STRING
|
Plan Path
|
||
|
|
PortNumber: STRING
|
Port Number
|
||
|
|
QueueManagerName: STRING
|
Queue Manager Name
|
||
|
|
appName: STRING
|
App Name
|
||
|
|
jndiName: STRING
|
Jndi Name
|
||
|
|
targetRestartPolicy: ENUM [RESTART, STOP_START] = RESTART
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true'
|
||
|
|
SoaId: STRING
|
Makes the deployment plan variables unique. If not defined the name of the ConnectionFactory will be used.
|
||
|
|
Target: STRING
|
The target container to map the SOA Resource to. If not defined, the mapped container name will be used.
|
||
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
restartTarget: BOOLEAN
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource
|
Hidden properties | ||
---|---|---|
|
|
createOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
createOrder: INTEGER = 62
|
Create Order
|
||
|
|
createScript: STRING = scripts/create-mqConnectionFactory.py
|
Python script invoked to create this resource
|
||
|
|
createVerb: STRING = Create
|
Create Verb
|
||
|
|
destroyOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
destroyOrder: INTEGER = 39
|
Destroy Order
|
||
|
|
destroyScript: STRING = scripts/destroy-mqConnectionFactory.py
|
Python script invoked to destroy this resource
|
||
|
|
destroyVerb: STRING = Destroy
|
Destroy Verb
|
||
|
|
discoverOrder: INTEGER = 50
|
The order in which a discover step will be executed.
|
||
|
|
libraryScripts: LIST_OF_STRING = [soa/runtime/ConnectionFactory.py]
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
modifyOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
modifyOrder: INTEGER = 62
|
Modify Order
|
||
|
|
modifyVerb: STRING = Upgrade
|
Modify Verb
|
||
|
|
noopOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
standardPropertiesNotToExpose: STRING = id, name, type, _properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyScript, destroyVerb, destroyOrder, jndiName, restartTarget, libraryScripts, discoverOrder, targetRestartPolicy, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
Standard Properties Not To Expose
|
||
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
||
|
|
exposeDeployedApplication: BOOLEAN
|
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
|
||
|
|
retainRemoteWorkingDirectory: BOOLEAN = true
|
Retain Remote Working Directory
|
soa.MQConnectionFactorySpec
Type Hierarchy | soa.ResourceSpec >> wls.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployable, udm.Taggable |
Specification for a MQ connection factory
Public properties | ||
---|---|---|
|
|
AppPath: STRING
|
App Path (string)
|
||
|
|
Channel: STRING
|
Channel (string)
|
||
|
|
HostName: STRING
|
Host Name (string)
|
||
|
|
PlanPath: STRING
|
Plan Path (string)
|
||
|
|
PortNumber: STRING
|
Port Number (string)
|
||
|
|
QueueManagerName: STRING
|
Queue Manager Name (string)
|
||
|
|
SoaId: STRING
|
Makes the deployment plan variables unique. If not defined the name of the ConnectionFactory will be used. (string)
|
||
|
|
Target: STRING
|
The target container to map the SOA Resource to. If not defined, the mapped container name will be used. (string)
|
||
|
|
appName: STRING
|
App Name (string)
|
||
|
|
jndiName: STRING
|
Jndi Name (string)
|
||
|
|
restartTarget: STRING
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource (boolean) default(false)
|
||
|
|
tags: SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
targetRestartPolicy: STRING
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true' (enum) values(RESTART, STOP_START) default(RESTART)
|
Hidden properties | ||
---|---|---|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
The set of CI templates.
|
soa.Mds
Type Hierarchy | soa.MdsSOADeployable >> wls.ExtensibleDeployedArtifact >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer, python.IPythonManagedDeployed |
Description unavailable
Parent | ||
---|---|---|
|
|
container:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public properties | ||
---|---|---|
|
|
deploymentOrder: INTEGER = 100
|
By default, new applications and modules are configured with a Deployment Order value of 100
|
||
|
|
forcedefault: STRING = true
|
Forcedefault
|
||
|
|
redeploymentStrategy: ENUM [CLASSIC, STOP_START, SIDE_BY_SIDE] = CLASSIC
|
Indicates what redeployment strategy to use for upgrading the application. Possible values: CLASSIC, STOP_START, SIDE_BY_SIDE
|
||
|
|
retireTimeout: INTEGER = -1
|
Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy
|
||
|
|
automaticVersioning: BOOLEAN = true
|
If set, the 'versionIdentifier' property is managed by the plugin. Any value explicitly set for 'versionIdentifier' is ignored. 'automaticVersioning' is enabled by default, in which case a unique version is created for the deployed module. If the manifest file includes an implementation version, then you must disable 'automaticVersioning'. If your manifest file includes a specification version and you want to use the implementation version that is defined in the manifest file, then you must set 'automaticVersioning' to false and enter the specification version as the 'versionIdentifier' property on the CI.
|
||
|
|
block: BOOLEAN = true
|
boolean value specifying whether the deployment should block user interaction until the command complete
|
||
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
folderNameToRemove: STRING
|
The MDS folder name (below /apps) to remove.
|
||
|
|
placeholders: MAP_STRING_STRING
|
A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
|
||
|
|
planPath: STRING
|
Name of the deployment plan file. The filename can be absolute or relative to the application directory.
|
||
|
|
removeDataBeforeDeployment: BOOLEAN = true
|
Remove data in Oracle MDS before deployment.
|
||
|
|
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 | ||
---|---|---|
|
|
createOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
createOrder: INTEGER = 60
|
Create Order
|
||
|
|
createScript: STRING = scripts/mdsDeploy.py
|
Python script invoked to deploy this Java EE artifact
|
||
|
|
createVerb: STRING = Deploy
|
Create Verb
|
||
|
|
deleteArtifactOrder: INTEGER = 31
|
Delete Artifact Order
|
||
|
|
deleteRetiredArtifactOrder: INTEGER = 99
|
Delete Retired Artifact Order
|
||
|
|
destroyOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
destroyOrder: INTEGER = 40
|
Destroy Order
|
||
|
|
destroyScript: STRING = scripts/mdsUndeploy.py
|
Python script invoked to undeploy this Java EE artifact
|
||
|
|
destroyVerb: STRING = Undeploy
|
Destroy Verb
|
||
|
|
discoverOrder: INTEGER = 50
|
The order in which a discover step will be executed.
|
||
|
|
isRunningRetryWaitInterval: INTEGER = 500
|
Time in milliseconds to wait before next retry to check if the deployment is still running
|
||
|
|
manifestVersionProperty: STRING = Extension-Name
|
Property in the manifest file of the archive indicating that it is a versioned artifact. You can override this property in XLDEPLOY_HOME/conf/deployit-defaults.properties. For example: wls.WarModule.manifestVersionProperty=Weblogic-Application-Version.
|
||
|
|
modifyOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
modifyOrder: INTEGER = 60
|
Modify Order
|
||
|
|
modifyScript: STRING = scripts/mdsDeploy.py
|
Python script invoked to upgrade this Java EE artifact
|
||
|
|
modifyVerb: STRING = Upgrade
|
Modify Verb
|
||
|
|
noopOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
order: STRING = 75
|
Order
|
||
|
|
standardPropertiesNotToExpose: STRING = id, name, type, deployable, properties, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, deleteArtifactOrder, startScript, startVerb, startOrder, stopScript, stopVerb, stopOrder, deploymentStrategy, placeholders, file, redeploymentStrategy, securityPermissions, inheritPermissions, exposeDeployedApplication, stopRetiredApplicationOrder, undeployRetiredApplicationOrder, deleteRetiredArtifactOrder, isRunningRetryWaitInterval, wlstPath, libraryScripts, discoverOrder, deploymentOrder, isStartOrStopOperationRequired, automaticVersioning, createOptions, modifyOptions, destroyOptions, noopOptions, manifestVersionProperty, versionTemplateFile, provisioners, ordinal, boundConfigurationItems
|
Standard Properties Not To Expose
|
||
|
|
startOrder: INTEGER = 90
|
Start Order
|
||
|
|
startScript: STRING = wls/application/start-application.py
|
Python script invoked to start this Java EE artifact
|
||
|
|
startVerb: STRING = Start
|
Start Verb
|
||
|
|
stopOrder: INTEGER = 10
|
Stop Order
|
||
|
|
stopRetiredApplicationOrder: INTEGER = 95
|
Stop Retired Application Order
|
||
|
|
stopScript: STRING = wls/application/stop-application.py
|
Python script invoked to stop this Java EE artifact
|
||
|
|
stopVerb: STRING = Stop
|
Stop Verb
|
||
|
|
undeployRetiredApplicationOrder: INTEGER = 98
|
Undeploy Retired Application Order
|
||
|
|
versionExpression: STRING = [#ftl]${manifestAttributes["Specification-Version"]}[#if manifestAttributes["Implementation-Version"]??]@${manifestAttributes["Implementation-Version"]}[/#if]
|
FreeMarker expression used to build the version based on the manifest file (properties are put in a map named 'manifestAttributes'). You can override this property in XLDEPLOY_HOME/conf/deployit-defaults.properties. For example: wls.WarModule.versionExpression=${manifestAttributes['Weblogic-Application-Version']}.
|
||
|
|
wlstPath: STRING = AppDeployments
|
Wlst Path
|
||
|
|
activationTimeout: INTEGER = -10
|
Time (in milliseconds) that WLST waits for the activation of configuration changes to complete before canceling the operation. A value of -1 indicates that the operation will not time out. A value of -10 indicates that this parameter will not be taken into account and server set default will be used. This argument normally defaults to 300,000 ms (or 5 minutes).
|
||
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
||
|
|
exposeDeployedApplication: BOOLEAN
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
isStartOrStopOperationRequired: BOOLEAN
|
Is Start Or Stop Operation Required
|
||
|
|
libraryScripts: LIST_OF_STRING
|
List of scripts to be appended to the deployed's runtime script
|
soa.MdsSOADeployable
Type Hierarchy | wls.ExtensibleDeployedArtifact >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer, python.IPythonManagedDeployed |
Description unavailable
Parent | ||
---|---|---|
|
|
container:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public properties | ||
---|---|---|
|
|
deploymentOrder: INTEGER = 100
|
By default, new applications and modules are configured with a Deployment Order value of 100
|
||
|
|
forcedefault: STRING = true
|
Forcedefault
|
||
|
|
redeploymentStrategy: ENUM [CLASSIC, STOP_START, SIDE_BY_SIDE] = CLASSIC
|
Indicates what redeployment strategy to use for upgrading the application. Possible values: CLASSIC, STOP_START, SIDE_BY_SIDE
|
||
|
|
retireTimeout: INTEGER = -1
|
Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy
|
||
|
|
automaticVersioning: BOOLEAN = true
|
If set, the 'versionIdentifier' property is managed by the plugin. Any value explicitly set for 'versionIdentifier' is ignored. 'automaticVersioning' is enabled by default, in which case a unique version is created for the deployed module. If the manifest file includes an implementation version, then you must disable 'automaticVersioning'. If your manifest file includes a specification version and you want to use the implementation version that is defined in the manifest file, then you must set 'automaticVersioning' to false and enter the specification version as the 'versionIdentifier' property on the CI.
|
||
|
|
block: BOOLEAN = true
|
boolean value specifying whether the deployment should block user interaction until the command complete
|
||
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
folderNameToRemove: STRING
|
The MDS folder name (below /apps) to remove.
|
||
|
|
placeholders: MAP_STRING_STRING
|
A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
|
||
|
|
planPath: STRING
|
Name of the deployment plan file. The filename can be absolute or relative to the application directory.
|
||
|
|
removeDataBeforeDeployment: BOOLEAN = true
|
Remove data in Oracle MDS before deployment.
|
||
|
|
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 | ||
---|---|---|
|
|
createOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
createOrder: INTEGER = 60
|
Create Order
|
||
|
|
createScript: STRING = scripts/mdsDeploy.py
|
Python script invoked to deploy this Java EE artifact
|
||
|
|
createVerb: STRING = Deploy
|
Create Verb
|
||
|
|
deleteArtifactOrder: INTEGER = 31
|
Delete Artifact Order
|
||
|
|
deleteRetiredArtifactOrder: INTEGER = 99
|
Delete Retired Artifact Order
|
||
|
|
destroyOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
destroyOrder: INTEGER = 40
|
Destroy Order
|
||
|
|
destroyScript: STRING = scripts/mdsUndeploy.py
|
Python script invoked to undeploy this Java EE artifact
|
||
|
|
destroyVerb: STRING = Undeploy
|
Destroy Verb
|
||
|
|
discoverOrder: INTEGER = 50
|
The order in which a discover step will be executed.
|
||
|
|
isRunningRetryWaitInterval: INTEGER = 500
|
Time in milliseconds to wait before next retry to check if the deployment is still running
|
||
|
|
manifestVersionProperty: STRING = Extension-Name
|
Property in the manifest file of the archive indicating that it is a versioned artifact. You can override this property in XLDEPLOY_HOME/conf/deployit-defaults.properties. For example: wls.WarModule.manifestVersionProperty=Weblogic-Application-Version.
|
||
|
|
modifyOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
modifyOrder: INTEGER = 60
|
Modify Order
|
||
|
|
modifyScript: STRING = scripts/mdsDeploy.py
|
Python script invoked to upgrade this Java EE artifact
|
||
|
|
modifyVerb: STRING = Upgrade
|
Modify Verb
|
||
|
|
noopOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
order: STRING = 75
|
Order
|
||
|
|
standardPropertiesNotToExpose: STRING = id, name, type, deployable, properties, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, deleteArtifactOrder, startScript, startVerb, startOrder, stopScript, stopVerb, stopOrder, deploymentStrategy, placeholders, file, redeploymentStrategy, securityPermissions, inheritPermissions, exposeDeployedApplication, stopRetiredApplicationOrder, undeployRetiredApplicationOrder, deleteRetiredArtifactOrder, isRunningRetryWaitInterval, wlstPath, libraryScripts, discoverOrder, deploymentOrder, isStartOrStopOperationRequired, automaticVersioning, createOptions, modifyOptions, destroyOptions, noopOptions, manifestVersionProperty, versionTemplateFile, provisioners, ordinal, boundConfigurationItems
|
Standard Properties Not To Expose
|
||
|
|
startOrder: INTEGER = 90
|
Start Order
|
||
|
|
startScript: STRING = wls/application/start-application.py
|
Python script invoked to start this Java EE artifact
|
||
|
|
startVerb: STRING = Start
|
Start Verb
|
||
|
|
stopOrder: INTEGER = 10
|
Stop Order
|
||
|
|
stopRetiredApplicationOrder: INTEGER = 95
|
Stop Retired Application Order
|
||
|
|
stopScript: STRING = wls/application/stop-application.py
|
Python script invoked to stop this Java EE artifact
|
||
|
|
stopVerb: STRING = Stop
|
Stop Verb
|
||
|
|
undeployRetiredApplicationOrder: INTEGER = 98
|
Undeploy Retired Application Order
|
||
|
|
versionExpression: STRING = [#ftl]${manifestAttributes["Specification-Version"]}[#if manifestAttributes["Implementation-Version"]??]@${manifestAttributes["Implementation-Version"]}[/#if]
|
FreeMarker expression used to build the version based on the manifest file (properties are put in a map named 'manifestAttributes'). You can override this property in XLDEPLOY_HOME/conf/deployit-defaults.properties. For example: wls.WarModule.versionExpression=${manifestAttributes['Weblogic-Application-Version']}.
|
||
|
|
wlstPath: STRING = AppDeployments
|
Wlst Path
|
||
|
|
activationTimeout: INTEGER = -10
|
Time (in milliseconds) that WLST waits for the activation of configuration changes to complete before canceling the operation. A value of -1 indicates that the operation will not time out. A value of -10 indicates that this parameter will not be taken into account and server set default will be used. This argument normally defaults to 300,000 ms (or 5 minutes).
|
||
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
||
|
|
exposeDeployedApplication: BOOLEAN
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
isStartOrStopOperationRequired: BOOLEAN
|
Is Start Or Stop Operation Required
|
||
|
|
libraryScripts: LIST_OF_STRING
|
List of scripts to be appended to the deployed's runtime script
|
soa.MdsSOADeployableSpec
Type Hierarchy | udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.ArchiveArtifact, udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable |
Description unavailable (deployable)
Public properties | ||
---|---|---|
|
|
automaticVersioning: STRING = true
|
If set, the 'versionIdentifier' property is managed by the plugin. Any value explicitly set for 'versionIdentifier' is ignored. 'automaticVersioning' is enabled by default, in which case a unique version is created for the deployed module. If the manifest file includes an implementation version, then you must disable 'automaticVersioning'. If your manifest file includes a specification version and you want to use the implementation version that is defined in the manifest file, then you must set 'automaticVersioning' to false and enter the specification version as the 'versionIdentifier' property on the CI. (boolean) default(true)
|
||
|
|
block: STRING = true
|
boolean value specifying whether the deployment should block user interaction until the command complete (boolean) default(true)
|
||
|
|
checksum: STRING
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
credentials:
CI<credentials.Credentials>
|
Credentials of the URI.
|
||
|
|
deploymentOrder: STRING = 100
|
By default, new applications and modules are configured with a Deployment Order value of 100 (integer) default(100)
|
||
|
|
excludeFileNamesRegex: STRING
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
|
A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
|
||
|
|
fileUri: STRING
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
folderNameToRemove: STRING
|
The MDS folder name (below /apps) to remove. (string)
|
||
|
|
forcedefault: STRING = true
|
Forcedefault (string) default(true)
|
||
|
|
placeholders: SET_OF_STRING
|
Placeholders detected in this artifact
|
||
|
|
planPath: STRING
|
Name of the deployment plan file. The filename can be absolute or relative to the application directory. (string)
|
||
|
|
preScannedPlaceholders: BOOLEAN
|
Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
|
||
|
|
proxySettings:
CI<credentials.ProxySettings>
|
Proxy Settings for artifact location
|
||
|
|
redeploymentStrategy: STRING = CLASSIC
|
Indicates what redeployment strategy to use for upgrading the application. Possible values: CLASSIC, STOP_START, SIDE_BY_SIDE (enum) values(CLASSIC, STOP_START, SIDE_BY_SIDE) default(CLASSIC)
|
||
|
|
removeDataBeforeDeployment: STRING = true
|
Remove data in Oracle MDS before deployment. (boolean) default(true)
|
||
|
|
retireTimeout: STRING = -1
|
Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy (integer) default(-1)
|
||
|
|
scanPlaceholders: BOOLEAN
|
Whether to scan this artifact to replace placeholders when it is imported
|
||
|
|
stageMode: STRING = Stage
|
Indicates whether the artifact will be deployed as staged or nostage mode (enum) values(Stage, NoStage) default(Stage)
|
||
|
|
stagingDirectory: STRING
|
Absolute directory path where the artifact will be uploaded and used by the servers for nostage deployment mode (string)
|
||
|
|
tags: SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
versionIdentifier: STRING
|
Version Identifier (string)
|
||
|
|
versioned: STRING = false
|
Indicates wither this artifact is to be deployed as a versioned application (boolean) default(false)
|
Hidden properties | ||
---|---|---|
|
|
textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|
Regular expression that matches file names of text files
|
||
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
The set of CI templates.
|
||
|
|
delimiters: STRING = {{ }}
|
The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|
soa.MdsSpec
Type Hierarchy | soa.MdsSOADeployableSpec >> udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.ArchiveArtifact, udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable |
Description unavailable (deployable)
Public properties | ||
---|---|---|
|
|
automaticVersioning: STRING = true
|
If set, the 'versionIdentifier' property is managed by the plugin. Any value explicitly set for 'versionIdentifier' is ignored. 'automaticVersioning' is enabled by default, in which case a unique version is created for the deployed module. If the manifest file includes an implementation version, then you must disable 'automaticVersioning'. If your manifest file includes a specification version and you want to use the implementation version that is defined in the manifest file, then you must set 'automaticVersioning' to false and enter the specification version as the 'versionIdentifier' property on the CI. (boolean) default(true)
|
||
|
|
block: STRING = true
|
boolean value specifying whether the deployment should block user interaction until the command complete (boolean) default(true)
|
||
|
|
checksum: STRING
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
credentials:
CI<credentials.Credentials>
|
Credentials of the URI.
|
||
|
|
deploymentOrder: STRING = 100
|
By default, new applications and modules are configured with a Deployment Order value of 100 (integer) default(100)
|
||
|
|
excludeFileNamesRegex: STRING
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
|
A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
|
||
|
|
fileUri: STRING
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
folderNameToRemove: STRING
|
The MDS folder name (below /apps) to remove. (string)
|
||
|
|
forcedefault: STRING = true
|
Forcedefault (string) default(true)
|
||
|
|
placeholders: SET_OF_STRING
|
Placeholders detected in this artifact
|
||
|
|
planPath: STRING
|
Name of the deployment plan file. The filename can be absolute or relative to the application directory. (string)
|
||
|
|
preScannedPlaceholders: BOOLEAN
|
Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
|
||
|
|
proxySettings:
CI<credentials.ProxySettings>
|
Proxy Settings for artifact location
|
||
|
|
redeploymentStrategy: STRING = CLASSIC
|
Indicates what redeployment strategy to use for upgrading the application. Possible values: CLASSIC, STOP_START, SIDE_BY_SIDE (enum) values(CLASSIC, STOP_START, SIDE_BY_SIDE) default(CLASSIC)
|
||
|
|
removeDataBeforeDeployment: STRING = true
|
Remove data in Oracle MDS before deployment. (boolean) default(true)
|
||
|
|
retireTimeout: STRING = -1
|
Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy (integer) default(-1)
|
||
|
|
scanPlaceholders: BOOLEAN = true
|
Whether to scan this artifact to replace placeholders when it is imported
|
||
|
|
stageMode: STRING = Stage
|
Indicates whether the artifact will be deployed as staged or nostage mode (enum) values(Stage, NoStage) default(Stage)
|
||
|
|
stagingDirectory: STRING
|
Absolute directory path where the artifact will be uploaded and used by the servers for nostage deployment mode (string)
|
||
|
|
tags: SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
versionIdentifier: STRING
|
Version Identifier (string)
|
||
|
|
versioned: STRING = false
|
Indicates wither this artifact is to be deployed as a versioned application (boolean) default(false)
|
Hidden properties | ||
---|---|---|
|
|
textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|
Regular expression that matches file names of text files
|
||
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
The set of CI templates.
|
||
|
|
delimiters: STRING = {{ }}
|
The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|
soa.Resource
Virtual Type | |
---|---|
Type Hierarchy | wls.Resource >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
Interfaces | udm.Deployed, udm.EmbeddedDeployedContainer, python.IPythonManagedDeployed |
Description unavailable
Parent | ||
---|---|---|
|
|
container:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public properties | ||
---|---|---|
|
|
targetRestartPolicy: ENUM [RESTART, STOP_START] = RESTART
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true'
|
||
|
|
SoaId: STRING
|
Makes the deployment plan variables unique. If not defined the name of the ConnectionFactory will be used.
|
||
|
|
Target: STRING
|
The target container to map the SOA Resource to. If not defined, the mapped container name will be used.
|
||
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
restartTarget: BOOLEAN
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource
|
Hidden properties | ||
---|---|---|
|
|
createOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
createOrder: INTEGER = 62
|
Create Order
|
||
|
|
createVerb: STRING = Create
|
Create Verb
|
||
|
|
destroyOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
destroyOrder: INTEGER = 39
|
Destroy Order
|
||
|
|
destroyVerb: STRING = Destroy
|
Destroy Verb
|
||
|
|
discoverOrder: INTEGER = 50
|
The order in which a discover step will be executed.
|
||
|
|
libraryScripts: LIST_OF_STRING = [soa/runtime/ConnectionFactory.py]
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
modifyOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
modifyOrder: INTEGER = 62
|
Modify Order
|
||
|
|
modifyVerb: STRING = Upgrade
|
Modify Verb
|
||
|
|
noopOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
standardPropertiesNotToExpose: STRING = id, name, type, _properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyScript, destroyVerb, destroyOrder, jndiName, restartTarget, libraryScripts, discoverOrder, targetRestartPolicy, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
Standard Properties Not To Expose
|
||
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
||
|
|
createScript: STRING
|
Python script invoked to create this resource
|
||
|
|
destroyScript: STRING
|
Python script invoked to destroy this resource
|
||
|
|
exposeDeployedApplication: BOOLEAN
|
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
|
soa.ResourceSpec
Type Hierarchy | wls.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployable, udm.Taggable |
Specification for a SOA Resource
Public properties | ||
---|---|---|
|
|
SoaId: STRING
|
Makes the deployment plan variables unique. If not defined the name of the ConnectionFactory will be used. (string)
|
||
|
|
Target: STRING
|
The target container to map the SOA Resource to. If not defined, the mapped container name will be used. (string)
|
||
|
|
restartTarget: STRING
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource (boolean) default(false)
|
||
|
|
tags: SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
targetRestartPolicy: STRING
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true' (enum) values(RESTART, STOP_START) default(RESTART)
|
Hidden properties | ||
---|---|---|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
The set of CI templates.
|
soa.UserMessagingdriverEmail
Type Hierarchy | wls.Resource >> wls.BaseWlsDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployed, udm.EmbeddedDeployedContainer, python.IPythonManagedDeployed |
Description unavailable
Parent | ||
---|---|---|
|
|
container:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public properties | ||
---|---|---|
|
|
ASNSDriverDriverName: STRING
|
A S N S Driver Driver Name
|
||
|
|
ASNSDriverEmailFromAddress: STRING
|
A S N S Driver Email From Address
|
||
|
|
ASNSDriverEmailReplyAddress: STRING
|
A S N S Driver Email Reply Address
|
||
|
|
ASNSDriverEmailRespondAddress: STRING
|
A S N S Driver Email Respond Address
|
||
|
|
ASNSDriverPropertyName: STRING
|
A S N S Driver Property Name
|
||
|
|
ASNSDriverPropertyValue: STRING
|
A S N S Driver Property Value
|
||
|
|
EINTAKEEmailFromAddress: STRING
|
E I N T A K E Email From Address
|
||
|
|
HWFMailerNotificationMode: STRING
|
H W F Mailer Notification Mode
|
||
|
|
OutgoingMailServer: STRING
|
Outgoing Mail Server
|
||
|
|
OutgoingMailServerPort: STRING
|
Outgoing Mail Server Port
|
||
|
|
OutgoingMailServerSecurity: STRING
|
Outgoing Mail Server Security
|
||
|
|
WNLEmailFromAddress: STRING
|
W N L Email From Address
|
||
|
|
targetRestartPolicy: ENUM [RESTART, STOP_START] = RESTART
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true'
|
||
|
|
OutgoingDefaultFromAddress: STRING
|
Outgoing Default From Address
|
||
|
|
OutgoingPassword: STRING
|
Outgoing Password
|
||
|
|
OutgoingUsername: STRING
|
Outgoing Username
|
||
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
restartTarget: BOOLEAN
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource
|
Hidden properties | ||
---|---|---|
|
|
createOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the create step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
createOrder: INTEGER = 60
|
Create Order
|
||
|
|
createScript: STRING = scripts/create-messagingDriverEmail.py
|
Python script invoked to create this resource
|
||
|
|
createVerb: STRING = Create
|
Create Verb
|
||
|
|
destroyOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
destroyOrder: INTEGER = 40
|
Destroy Order
|
||
|
|
destroyScript: STRING = scripts/destroy-messagingDriverEmail.py
|
Python script invoked to destroy this resource
|
||
|
|
destroyVerb: STRING = Destroy
|
Destroy Verb
|
||
|
|
discoverOrder: INTEGER = 50
|
The order in which a discover step will be executed.
|
||
|
|
modifyOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
modifyOrder: INTEGER = 40
|
Modify Order
|
||
|
|
modifyVerb: STRING = Upgrade
|
Modify Verb
|
||
|
|
noopOptions: SET_OF_STRING = [uploadArtifactData]
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
standardPropertiesNotToExpose: STRING = id, name, type, _properties, deployable, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyScript, destroyVerb, destroyOrder, jndiName, restartTarget, libraryScripts, discoverOrder, targetRestartPolicy, createOptions, modifyOptions, destroyOptions, noopOptions, provisioners, ordinal, boundConfigurationItems
|
Standard Properties Not To Expose
|
||
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
||
|
|
exposeDeployedApplication: BOOLEAN
|
Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
|
||
|
|
libraryScripts: LIST_OF_STRING
|
List of scripts to be appended to the deployed's runtime script
|
||
|
|
modifyScript: STRING
|
Python script invoked to upgrade this resource
|
||
|
|
retainRemoteWorkingDirectory: BOOLEAN = true
|
Retain Remote Working Directory
|
soa.UserMessagingdriverEmailSpec
Type Hierarchy | wls.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployable, udm.Taggable |
Specification for a UserMessagingdriver Email
Public properties | ||
---|---|---|
|
|
ASNSDriverDriverName: STRING
|
A S N S Driver Driver Name (string)
|
||
|
|
ASNSDriverEmailFromAddress: STRING
|
A S N S Driver Email From Address (string)
|
||
|
|
ASNSDriverEmailReplyAddress: STRING
|
A S N S Driver Email Reply Address (string)
|
||
|
|
ASNSDriverEmailRespondAddress: STRING
|
A S N S Driver Email Respond Address (string)
|
||
|
|
ASNSDriverPropertyName: STRING
|
A S N S Driver Property Name (string)
|
||
|
|
ASNSDriverPropertyValue: STRING
|
A S N S Driver Property Value (string)
|
||
|
|
EINTAKEEmailFromAddress: STRING
|
E I N T A K E Email From Address (string)
|
||
|
|
HWFMailerNotificationMode: STRING
|
H W F Mailer Notification Mode (string)
|
||
|
|
OutgoingDefaultFromAddress: STRING
|
Outgoing Default From Address (string)
|
||
|
|
OutgoingMailServer: STRING
|
Outgoing Mail Server (string)
|
||
|
|
OutgoingMailServerPort: STRING
|
Outgoing Mail Server Port (string)
|
||
|
|
OutgoingMailServerSecurity: STRING
|
Outgoing Mail Server Security (string)
|
||
|
|
OutgoingPassword: STRING
|
Outgoing Password (string)
|
||
|
|
OutgoingUsername: STRING
|
Outgoing Username (string)
|
||
|
|
WNLEmailFromAddress: STRING
|
W N L Email From Address (string)
|
||
|
|
restartTarget: STRING
|
If set to true, a restart operation (stop & start) will be triggered just after the creation or the deletion of the resource (boolean) default(false)
|
||
|
|
tags: SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
targetRestartPolicy: STRING
|
Indicates the policy used to stop/start the target container when resource restartTarget property is 'true' (enum) values(RESTART, STOP_START) default(RESTART)
|
Hidden properties | ||
---|---|---|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
The set of CI templates.
|
soa.XSLResources
Type Hierarchy | generic.ExecutedScript >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployed, udm.EmbeddedDeployedContainer |
Description unavailable
Parent | ||
---|---|---|
|
|
container:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public properties | ||
---|---|---|
|
|
classpathResources: SET_OF_STRING = [scripts/createDirectory.sh, scripts/unzipResources.sh]
|
Additional classpath resources that should be uploaded to the working directory before executing the script.
|
||
|
|
createTargetPath: STRING = true
|
Create Target Path
|
||
|
|
targetPath: STRING
|
Target Path
|
||
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
Hidden properties | ||
---|---|---|
|
|
createOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
createOrder: INTEGER = 50
|
The order of the step in the step list for the create operation.
|
||
|
|
createScript: STRING = scripts/create-XslResources.sh
|
Classpath to the script that is uploaded and executed on the generic container for the create operation.
|
||
|
|
createVerb: STRING = Create
|
Create Verb
|
||
|
|
destroyOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
destroyOrder: INTEGER = 40
|
The order of the step in the step list for the destroy operation.
|
||
|
|
destroyScript: STRING = scripts/destroy-XslResources.sh
|
Classpath to the script that is uploaded and executed on the generic container for the destroy operation.
|
||
|
|
destroyVerb: STRING = Destroy
|
Destroy Verb
|
||
|
|
modifyOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
modifyOrder: INTEGER = 50
|
The order of the step in the step list for the modify operation.
|
||
|
|
modifyScript: STRING = scripts/modify-XslResources.sh
|
Classpath to the script that is uploaded and executed on the generic container for the modify operation.
|
||
|
|
modifyVerb: STRING = Modify
|
Modify Verb
|
||
|
|
noopOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
noopOrder: INTEGER = 50
|
The order of the step in the step list for the noop operation.
|
||
|
|
noopVerb: STRING = Modify
|
Noop Verb
|
||
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
||
|
|
inspectClasspathResources: SET_OF_STRING
|
Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
|
||
|
|
inspectScript: STRING
|
Classpath to the script used to inspect the generic container.
|
||
|
|
inspectTemplateClasspathResources: SET_OF_STRING
|
Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
|
||
|
|
noopScript: STRING
|
Classpath to the script that is uploaded and executed on the generic container for the noop operation.
|
||
|
|
remoteWorkingDirectoryPath: STRING
|
Name of working directory on target host. Default is to create a temporary directory which is deleted when connection is closed.
|
||
|
|
restartRequired: BOOLEAN
|
The generic container requires a restart for the action performed by this deployed.
|
||
|
|
restartRequiredForNoop: BOOLEAN
|
The generic container requires a restart for the NOOP action performed by this deployed.
|
||
|
|
retainRemoteWorkingDirectory: BOOLEAN
|
Retain the specified working directory on target host after completion.
|
||
|
|
templateClasspathResources: SET_OF_STRING
|
Additional template classpath resources that should be uploaded to the working directory before executing the script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
|
soa.XSLResourcesSpec
Type Hierarchy | udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.ArchiveArtifact, udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable |
Description unavailable (deployable)
Public properties | ||
---|---|---|
|
|
checksum: STRING
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
classpathResources: SET_OF_STRING
|
Additional classpath resources that should be uploaded to the working directory before executing the script. (set_of_string)
|
||
|
|
createTargetPath: STRING
|
Create Target Path (string) default(true)
|
||
|
|
credentials:
CI<credentials.Credentials>
|
Credentials of the URI.
|
||
|
|
excludeFileNamesRegex: STRING
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
|
A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
|
||
|
|
fileUri: STRING
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
placeholders: SET_OF_STRING
|
Placeholders detected in this artifact
|
||
|
|
preScannedPlaceholders: BOOLEAN
|
Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
|
||
|
|
proxySettings:
CI<credentials.ProxySettings>
|
Proxy Settings for artifact location
|
||
|
|
scanPlaceholders: BOOLEAN
|
Whether to scan this artifact to replace placeholders when it is imported
|
||
|
|
tags: SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
targetPath: STRING
|
Target Path (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
|
||
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
The set of CI templates.
|
||
|
|
delimiters: STRING = {{ }}
|
The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|