WebSphere Liberty Profile Plugin Manual 10.0.x

    The XL Deploy WebSphere Liberty profile server (WLP) plugin adds capability for managing deployments and resources on Liberty profile server.

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

    Requirements

    • XL Deploy 5.1.0 or later
    • Liberty Profile AS 8.5.5.6 or 16.0.0.3
    • Liberty profile server configured with access to management features through secured JMX REST connectors
    • User credentials for accessing the host running the Liberty profile application server

    Setup

    The plugin manages the Liberty profile server through the secure Java Management Extensions (JMX) REST connector. To enable the REST connector, include the restConnector-1.0 feature in the server.xml file on the Liberty server. The instructions for configuring REST connector are available at Configuring secure JMX connection to the Liberty profile.

    To keep communication confidential, configure SSL certificates on the Liberty profile and on the XL Deploy instance connecting to the server. For information about configuring certificates on the Liberty profile server, refer to Enabling SSL communication for the Liberty profile.

    Limitations

    1. The plugin does not currently support deployments on Microsoft Windows-based hosts.
    2. The plugin only supports deployment on a single server container. Collectives are not supported.
    3. Application deployments using dropins directory is not supported.
    4. Deployment of OSGi applications is not supported.
    5. Restart strategy is applied on single application.
    6. Only configuration changes made directly to server.xml are supported, included files and configuration files in the configDropins directory are not considered.

    Release notes

    WLP plugin 6.0.1

    Improvements

    • [DEPL-10739] - Support for Websphere Liberty 16.0

    WLP plugin 5.1.0

    Initial release.

    CI Reference

    Configuration Item Overview

    Deployables

    CIDescription
    wlp.ConnectionManagerSpec Connection Manager configuration.
    wlp.DB2DataSourceSpec Defines DB2 data source configuration (IBM Data Server Driver for JDBC and SQLJ for DB2).
    wlp.DataSourceSpec Defines a data source configuration
    wlp.EjbApplicationSpec Java EE EJB archive.
    wlp.EnterpriseApplicationSpec Java EE EAR archive.
    wlp.FeatureSpec WebSphere Liberty Profile enterprise subsystem.
    wlp.FilesetSpec Specifies a set of files starting from a base directory and matching a set of patterns.
    wlp.GenericDataSourceSpec Defines generic data source configuration.
    wlp.JdbcDriverSpec JDBC driver.
    wlp.JmsConnectionFactorySpec Defines a Base JMS connection factory configuration.
    wlp.JmsResourceSpec Defines a JMS configuration.
    wlp.LibrarySpec WAS Liberty Shared Library
    wlp.MicrosoftSQLServerDataSourceSpec Defines Microsoft SQL Server data source configuration (Microsoft JDBC driver).
    wlp.OracleDataSourceSpec Defines Oracle data source configuration.
    wlp.ResourceSpec WAS Liberty resource.
    wlp.SybaseDataSourceSpec Defines Sybase data source configuration.
    wlp.VariableSpec Declare a new variable by specifying the name and value for the variable.
    wlp.WebApplicationSpec Java EE WAR archive.
    wlp.WmqConnectionFactorySpec Defines a Base WMQ connection factory configuration.
    wlp.WmqDestinationSpec Defines a WMQ JMS specific configuration.
    wlp.WmqJmsClientSpec WebSphere MQ messaging.
    wlp.WmqQueueConnectionFactorySpec Defines a JMS queue connection factory configuration.
    wlp.WmqQueueSpec Defines a JMS queue configuration.
    wlp.WmqTopicConnectionFactorySpec Defines a JMS topic connection factory configuration
    wlp.WmqTopicSpec Defines a JMS topic configuration

    Deployeds

    CIDescription
    wlp.Application Application installed to Liberty server
    wlp.ConnectionManager Connection Manager configuration.
    wlp.DB2DataSource Defines DB2 data source configuration (IBM Data Server Driver for JDBC and SQLJ for DB2).
    wlp.DataSource Defines a data source configuration.
    wlp.EjbApplication Java EE EJB archive.
    wlp.EnterpriseApplication Java EE EAR archive.
    wlp.Feature WebSphere Liberty Profile enterprise subsystem.
    wlp.Fileset Specifies a set of files starting from a base directory and matching a set of patterns.
    wlp.GenericDataSource Defines generic data source configuration.
    wlp.JdbcDriver JDBC driver.
    wlp.JmsConnectionFactory Defines a Base JMS connection factory configuration.
    wlp.JmsResource Defines a JMS configuration.
    wlp.Library WAS Liberty Shared Library
    wlp.MicrosoftSQLServerDataSource Defines Microsoft SQL Server data source configuration (Microsoft JDBC driver).
    wlp.OracleDataSource Defines Oracle data source configuration.
    wlp.Resource WAS Liberty resource.
    wlp.SybaseDataSource Defines Sybase data source configuration.
    wlp.Variable Declare a new variable by specifying the name and value for the variable.
    wlp.WebApplication Java EE WAR archive.
    wlp.WmqConnectionFactory Defines a Base WMQ connection factory configuration.
    wlp.WmqDestination Defines a WMQ JMS specific configuration.
    wlp.WmqJmsClient WebSphere MQ messaging.
    wlp.WmqQueue Defines a JMS queue configuration.
    wlp.WmqQueueConnectionFactory Defines a JMS queue connection factory configuration.
    wlp.WmqTopic Defines a JMS topic configuration
    wlp.WmqTopicConnectionFactory Defines a JMS topic connection factory configuration

    Containers

    CIDescription
    wlp.Server An standalone WebSphere Liberty Profile server

    Other Configuration Items

    CIDescription
    wlp.ApplicationBnd Binds general deployment information included in the application to specific resources.
    wlp.ApplicationBndSpec Binds general deployment information included in the application to specific resources.
    wlp.Classloader Defines the settings for an application classloader.
    wlp.ClassloaderSpec Defines the settings for an application classloader.
    wlp.GroupRole A group possessing a security role.
    wlp.GroupRoleSpec A group possessing a security role.
    wlp.RunAsUserRole ID and password of a user required to access a bean from another bean.
    wlp.RunAsUserRoleSpec ID and password of a user required to access a bean from another bean.
    wlp.SecurityRole A role that is mapped to users and groups in a domain user registry.
    wlp.SecurityRoleSpec A role that is mapped to users and groups in a domain user registry.
    wlp.Server_create Generated type for method create.
    wlp.SpecialSubjectRole Name of a special-subject possessing a security role.
    wlp.SpecialSubjectRoleSpec Name of a special-subject possessing a security role.
    wlp.UserRole A user possessing a security role.
    wlp.UserRoleSpec A user possessing a security role.

    Configuration Item Details

    wlp.Application

    Virtual Type
    Type Hierarchy udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer

    Application installed to Liberty server

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Children
     
     
    applicationBindings: SET_OF_CI<wlp.ApplicationBnd>
    Binds general deployment information included in the application to specific resources.
     
     
    classloader: SET_OF_CI<wlp.Classloader>
    Defines the settings for an application classloader.
      Public properties
     
     
    location: STRING
    Location of an application expressed as an absolute path or a path relative to the server-level apps directory. Example: /opt/wlp/usr/servers/defaultServer/apps/{applicationName} or {applicationName}.
     
     
    restartStrategy: ENUM [NONE, STOP_START] = NONE
    Application restart strategy.
     
     
    autoStart: BOOLEAN = true
    Indicates whether or not the server should start the application automatically when the server starts.
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    placeholders: MAP_STRING_STRING
    A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
      Hidden properties
     
     
    archiveType: STRING
    Type of application archive.
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.
    Control taskParameter CIAttributesDescription
    start

    delegate = jythonScript, script = wlp/scripts/application/start-application.py

    Start application

    status

    delegate = jythonScript, script = wlp/scripts/application/check-application-status.py

    Status of the application

    stop

    delegate = jythonScript, script = wlp/scripts/application/stop-application.py

    Start application


    wlp.ApplicationBnd

    Type Hierarchy udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
    Interfaces udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

    Binds general deployment information included in the application to specific resources.

      Parent
     
     
    container: CI<udm.EmbeddedDeployedContainer>
    The (embedded) deployed which contains this embedded deployed.
      Children
     
     
    securityRoles: SET_OF_CI<wlp.SecurityRole>
    Roles that are mapped to users and groups in a domain user registry.
      Public properties
     
     
    deployable: CI<udm.EmbeddedDeployable>
    The embedded deployable that this embedded deployed is derived from.
     
     
    version: STRING
    Version of the application bindings specification.
      Hidden properties
     
     
    propertyMapping: MAP_STRING_STRING = { version=, security-role=securityRoles }
    Property Mapping

    wlp.ApplicationBndSpec

    Type Hierarchy udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
    Interfaces udm.EmbeddedDeployable

    Binds general deployment information included in the application to specific resources.

      Children
     
     
    securityRoles: SET_OF_CI<wlp.SecurityRoleSpec>
    Roles that are mapped to users and groups in a domain user registry.
      Public properties
     
     
    version: STRING
    Version of the application bindings specification. (string)

    wlp.Classloader

    Type Hierarchy udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
    Interfaces udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

    Defines the settings for an application classloader.

      Parent
     
     
    container: CI<udm.EmbeddedDeployedContainer>
    The (embedded) deployed which contains this embedded deployed.
      Public properties
     
     
    apiTypeVisibility: STRING
    The types of API package this class loader will be able to see, as a comma-separated list of any combination of the following: spec, ibm-api, api, third-party. Default server value: spec,ibm-api,api.
     
     
    classProviderRef: STRING
    List of class provider references. When searching for classes or resources, this class loader will delegate to the specified class providers after searching its own class path, List of configuration IDs of type library (comma-separated string).
     
     
    commonLibraryRef: STRING
    List of library references. Library class instances are shared with other classloaders, List of configuration IDs of type library (comma-separated string).
     
     
    delegation: ENUM [parentFirst, parentLast]
    Controls whether parent classloader is used before or after this classloader. Default server value: parentFirst.
     
     
    deployable: CI<udm.EmbeddedDeployable>
    The embedded deployable that this embedded deployed is derived from.
     
     
    privateLibraryRef: STRING
    List of library references. Library class instances are unique to this classloader, independent of class instances from other classloaders, List of configuration IDs of type library (comma-separated string).
      Hidden properties
     
     
    propertyMapping: MAP_STRING_STRING = { delegation=, apiTypeVisibility=, privateLibraryRef=, commonLibraryRef=, classProviderRef= }
    Property Mapping

    wlp.ClassloaderSpec

    Type Hierarchy udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
    Interfaces udm.EmbeddedDeployable

    Defines the settings for an application classloader.

      Public properties
     
     
    apiTypeVisibility: STRING
    The types of API package this class loader will be able to see, as a comma-separated list of any combination of the following: spec, ibm-api, api, third-party. Default server value: spec,ibm-api,api. (string)
     
     
    classProviderRef: STRING
    List of class provider references. When searching for classes or resources, this class loader will delegate to the specified class providers after searching its own class path, List of configuration IDs of type library (comma-separated string). (string)
     
     
    commonLibraryRef: STRING
    List of library references. Library class instances are shared with other classloaders, List of configuration IDs of type library (comma-separated string). (string)
     
     
    delegation: STRING
    Controls whether parent classloader is used before or after this classloader. Default server value: parentFirst. (enum) values(parentFirst, parentLast)
     
     
    privateLibraryRef: STRING
    List of library references. Library class instances are unique to this classloader, independent of class instances from other classloaders, List of configuration IDs of type library (comma-separated string). (string)

    wlp.ConnectionManager

    Type Hierarchy wlp.Resource >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    Connection Manager configuration.

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    agedTimeout: STRING
    Amount of time before a physical connection can be discarded by pool maintenance. A value of -1 disables this timeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
     
     
    connectionTimeout: STRING
    Amount of time after which a connection request times out. A value of -1 disables this timeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    maxConnectionsPerThread: INTEGER
    Limits the number of open connections on each thread.
     
     
    maxIdleTime: STRING
    Amount of time after which an unused or idle connection can be discarded during pool maintenance, if doing so does not reduce the pool below the minimum size. A value of -1 disables this timeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
     
     
    maxPoolSize: INTEGER
    Maximum number of physical connections for a pool. A value of 0 means unlimited.
     
     
    minPoolSize: INTEGER
    Minimum number of physical connections to maintain in the pool. The pool is not pre-populated. Aged timeout can override the minimum.
     
     
    numConnectionsPerThreadLocal: INTEGER
    Caches the specified number of connections for each thread.
     
     
    purgePolicy: ENUM [EntirePool, FailingConnectionOnly, ValidateAllConnections]
    Specifies which connections to destroy when a stale connection is detected in a pool.
     
     
    reapTime: STRING
    Amount of time between runs of the pool maintenance thread. A value of -1 disables pool maintenance. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
      Hidden properties
     
     
    createOrder: INTEGER = 66
    Create Order
     
     
    destroyOrder: INTEGER = 43
    Destroy Order
     
     
    propertyMapping: MAP_STRING_STRING = { id=name, agedTimeout=, connectionTimeout=, maxIdleTime=, maxPoolSize=, minPoolSize=, purgePolicy=, reapTime=, maxConnectionsPerThread=, numConnectionsPerThreadLocal= }
    Property Mapping
     
     
    propertyMappingElementName: STRING = connectionManager
    Property Mapping Element Name
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.

    wlp.ConnectionManagerSpec

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

    Connection Manager configuration.

      Public properties
     
     
    agedTimeout: STRING
    Amount of time before a physical connection can be discarded by pool maintenance. A value of -1 disables this timeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds. (string)
     
     
    connectionTimeout: STRING
    Amount of time after which a connection request times out. A value of -1 disables this timeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds. (string)
     
     
    maxConnectionsPerThread: STRING
    Limits the number of open connections on each thread. (integer)
     
     
    maxIdleTime: STRING
    Amount of time after which an unused or idle connection can be discarded during pool maintenance, if doing so does not reduce the pool below the minimum size. A value of -1 disables this timeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds. (string)
     
     
    maxPoolSize: STRING
    Maximum number of physical connections for a pool. A value of 0 means unlimited. (integer)
     
     
    minPoolSize: STRING
    Minimum number of physical connections to maintain in the pool. The pool is not pre-populated. Aged timeout can override the minimum. (integer)
     
     
    numConnectionsPerThreadLocal: STRING
    Caches the specified number of connections for each thread. (integer)
     
     
    purgePolicy: STRING
    Specifies which connections to destroy when a stale connection is detected in a pool. (enum) values(EntirePool, FailingConnectionOnly, ValidateAllConnections)
     
     
    reapTime: STRING
    Amount of time between runs of the pool maintenance thread. A value of -1 disables pool maintenance. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds. (string)
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    wlp.DB2DataSource

    Type Hierarchy wlp.DataSource >> wlp.Resource >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    Defines DB2 data source configuration (IBM Data Server Driver for JDBC and SQLJ for DB2).

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    jndiName: STRING
    JNDI name for a data source.
     
     
    beginTranForResultSetScrollingAPIs: BOOLEAN = true
    Attempt transaction enlistment when result set scrolling interfaces are used.
     
     
    beginTranForVendorAPIs: BOOLEAN = true
    Attempt transaction enlistment when vendor interfaces are used.
     
     
    commitOrRollbackOnCleanup: ENUM [commit, rollback]
    Determines how to clean up connections that might be in a database unit of work (AutoCommit=false) when the connection is closed or returned to the pool.
     
     
    connectionManagerRef: STRING
    Connection manager for a data source.
     
     
    connectionSharing: ENUM [MatchOriginalRequest, MatchCurrentState]
    Specifies how connections are matched for sharing. Default server value: MatchOriginalRequest.
     
     
    containerAuthDataRef: STRING
    Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER.
     
     
    customProperties: MAP_STRING_STRING
    Specifies additional custom datasource properties that you can configure for properties.db2.jcc element.
     
     
    databaseName: STRING
    Specifies the name for the database server. This name is used as the database portion of the connection URL.
     
     
    datasourceType: ENUM [javax.sql.XADataSource, javax.sql.ConnectionPoolDataSource, javax.sql.DataSource]
    Type of data source.
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    driverType: ENUM [4, 2]
    For the DataSource interface, determines which JDBC driver type to use for connections. The data type of this property is int. Possible values are 2 or 4. Server default value: 4.
     
     
    isolationLevel: ENUM [TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE, TRANSACTION_SNAPSHOT]
    Default transaction isolation level.
     
     
    jdbcDriverRef: STRING
    JDBC driver for a data source.
     
     
    password: STRING
    It is recommended to use a container managed authentication alias instead of configuring this property.
     
     
    portNumber: STRING
    Port on which to obtain database connections. Server default value: 50000
     
     
    queryTimeout: STRING
    Default query timeout for SQL statements. In a JTA transaction, syncQueryTimeoutWithTransactionTimeout can override this default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
     
     
    recoveryAuthDataRef: STRING
    Authentication data for transaction recovery.
     
     
    serverName: STRING
    The host name or the TCP/IP address of the data source. Server default value: localhost.
     
     
    statementCacheSize: INTEGER
    Maximum number of cached statements per connection.
     
     
    supplementalJDBCTrace: BOOLEAN
    Supplements the JDBC driver trace that is logged when JDBC driver trace is enabled in bootstrap.properties. JDBC driver trace specifications include: com.ibm.ws.database.logwriter, com.ibm.ws.db2.logwriter, com.ibm.ws.derby.logwriter, com.ibm.ws.informix.logwriter, com.ibm.ws.oracle.logwriter, com.ibm.ws.sqlserver.logwriter, com.ibm.ws.sybase.logwriter.
     
     
    syncQueryTimeoutWithTransactionTimeout: BOOLEAN
    Use the time remaining (if any) in a JTA transaction as the default query timeout for SQL statements.
     
     
    transactional: BOOLEAN = true
    Enable participation in transactions that are managed by the application server.
     
     
    user: STRING
    It is recommended to use a container managed authentication alias instead of configuring this property.
      Hidden properties
     
     
    additionalPropertyMapping: MAP_STRING_STRING = { properties.db2.jcc/driverType=driverType, properties.db2.jcc/databaseName=databaseName, properties.db2.jcc/serverName=serverName, properties.db2.jcc/portNumber=portNumber, properties.db2.jcc/user=user, properties.db2.jcc/password=password }
    Additional Property Mapping
     
     
    createOrder: INTEGER = 67
    Create Order
     
     
    customPropertiesElementName: STRING = properties.db2.jcc
    Element name for custom properties.
     
     
    destroyOrder: INTEGER = 42
    Destroy Order
     
     
    propertyMapping: MAP_STRING_STRING = { id=name, jndiName=, jdbcDriverRef=, connectionManagerRef=, containerAuthDataRef=, recoveryAuthDataRef=, datasourceType=, connectionSharing=, isolationLevel=, statementCacheSize=, transactional=, beginTranForResultSetScrollingAPIs=, beginTranForVendorAPIs=, syncQueryTimeoutWithTransactionTimeout=, supplementalJDBCTrace=, commitOrRollbackOnCleanup=, queryTimeout= }
    Property Mapping
     
     
    propertyMappingElementName: STRING = dataSource
    Property Mapping Element Name
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.

    wlp.DB2DataSourceSpec

    Type Hierarchy wlp.DataSourceSpec >> wlp.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.Deployable, udm.Taggable

    Defines DB2 data source configuration (IBM Data Server Driver for JDBC and SQLJ for DB2).

      Public properties
     
     
    beginTranForResultSetScrollingAPIs: STRING
    Attempt transaction enlistment when result set scrolling interfaces are used. (boolean) default(true)
     
     
    beginTranForVendorAPIs: STRING
    Attempt transaction enlistment when vendor interfaces are used. (boolean) default(true)
     
     
    commitOrRollbackOnCleanup: STRING
    Determines how to clean up connections that might be in a database unit of work (AutoCommit=false) when the connection is closed or returned to the pool. (enum) values(commit, rollback)
     
     
    connectionManagerRef: STRING
    Connection manager for a data source. (string)
     
     
    connectionSharing: STRING
    Specifies how connections are matched for sharing. Default server value: MatchOriginalRequest. (enum) values(MatchOriginalRequest, MatchCurrentState)
     
     
    containerAuthDataRef: STRING
    Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER. (string)
     
     
    customProperties: MAP_STRING_STRING
    Specifies additional custom datasource properties that you can configure for properties.db2.jcc element. (map_string_string)
     
     
    databaseName: STRING
    Specifies the name for the database server. This name is used as the database portion of the connection URL. (string)
     
     
    datasourceType: STRING
    Type of data source. (enum) values(javax.sql.XADataSource, javax.sql.ConnectionPoolDataSource, javax.sql.DataSource)
     
     
    driverType: STRING
    For the DataSource interface, determines which JDBC driver type to use for connections. The data type of this property is int. Possible values are 2 or 4. Server default value: 4. (enum) values(4, 2)
     
     
    isolationLevel: STRING
    Default transaction isolation level. (enum) values(TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE, TRANSACTION_SNAPSHOT)
     
     
    jdbcDriverRef: STRING
    JDBC driver for a data source. (string)
     
     
    jndiName: STRING
    JNDI name for a data source. (string)
     
     
    password: STRING
    It is recommended to use a container managed authentication alias instead of configuring this property. (string)
     
     
    portNumber: STRING
    Port on which to obtain database connections. Server default value: 50000 (string)
     
     
    queryTimeout: STRING
    Default query timeout for SQL statements. In a JTA transaction, syncQueryTimeoutWithTransactionTimeout can override this default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds. (string)
     
     
    recoveryAuthDataRef: STRING
    Authentication data for transaction recovery. (string)
     
     
    serverName: STRING
    The host name or the TCP/IP address of the data source. Server default value: localhost. (string)
     
     
    statementCacheSize: STRING
    Maximum number of cached statements per connection. (integer)
     
     
    supplementalJDBCTrace: STRING
    Supplements the JDBC driver trace that is logged when JDBC driver trace is enabled in bootstrap.properties. JDBC driver trace specifications include: com.ibm.ws.database.logwriter, com.ibm.ws.db2.logwriter, com.ibm.ws.derby.logwriter, com.ibm.ws.informix.logwriter, com.ibm.ws.oracle.logwriter, com.ibm.ws.sqlserver.logwriter, com.ibm.ws.sybase.logwriter. (boolean) default(false)
     
     
    syncQueryTimeoutWithTransactionTimeout: STRING
    Use the time remaining (if any) in a JTA transaction as the default query timeout for SQL statements. (boolean) default(false)
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
     
     
    transactional: STRING
    Enable participation in transactions that are managed by the application server. (boolean) default(true)
     
     
    user: STRING
    It is recommended to use a container managed authentication alias instead of configuring this property. (string)
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    wlp.DataSource

    Virtual Type
    Type Hierarchy wlp.Resource >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    Defines a data source configuration.

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    jndiName: STRING
    JNDI name for a data source.
     
     
    beginTranForResultSetScrollingAPIs: BOOLEAN = true
    Attempt transaction enlistment when result set scrolling interfaces are used.
     
     
    beginTranForVendorAPIs: BOOLEAN = true
    Attempt transaction enlistment when vendor interfaces are used.
     
     
    commitOrRollbackOnCleanup: ENUM [commit, rollback]
    Determines how to clean up connections that might be in a database unit of work (AutoCommit=false) when the connection is closed or returned to the pool.
     
     
    connectionManagerRef: STRING
    Connection manager for a data source.
     
     
    connectionSharing: ENUM [MatchOriginalRequest, MatchCurrentState]
    Specifies how connections are matched for sharing. Default server value: MatchOriginalRequest.
     
     
    containerAuthDataRef: STRING
    Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER.
     
     
    datasourceType: ENUM [javax.sql.XADataSource, javax.sql.ConnectionPoolDataSource, javax.sql.DataSource]
    Type of data source.
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    isolationLevel: ENUM [TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE, TRANSACTION_SNAPSHOT]
    Default transaction isolation level.
     
     
    jdbcDriverRef: STRING
    JDBC driver for a data source.
     
     
    queryTimeout: STRING
    Default query timeout for SQL statements. In a JTA transaction, syncQueryTimeoutWithTransactionTimeout can override this default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
     
     
    recoveryAuthDataRef: STRING
    Authentication data for transaction recovery.
     
     
    statementCacheSize: INTEGER
    Maximum number of cached statements per connection.
     
     
    supplementalJDBCTrace: BOOLEAN
    Supplements the JDBC driver trace that is logged when JDBC driver trace is enabled in bootstrap.properties. JDBC driver trace specifications include: com.ibm.ws.database.logwriter, com.ibm.ws.db2.logwriter, com.ibm.ws.derby.logwriter, com.ibm.ws.informix.logwriter, com.ibm.ws.oracle.logwriter, com.ibm.ws.sqlserver.logwriter, com.ibm.ws.sybase.logwriter.
     
     
    syncQueryTimeoutWithTransactionTimeout: BOOLEAN
    Use the time remaining (if any) in a JTA transaction as the default query timeout for SQL statements.
     
     
    transactional: BOOLEAN = true
    Enable participation in transactions that are managed by the application server.
      Hidden properties
     
     
    createOrder: INTEGER = 67
    Create Order
     
     
    destroyOrder: INTEGER = 42
    Destroy Order
     
     
    propertyMapping: MAP_STRING_STRING = { id=name, jndiName=, jdbcDriverRef=, connectionManagerRef=, containerAuthDataRef=, recoveryAuthDataRef=, datasourceType=, connectionSharing=, isolationLevel=, statementCacheSize=, transactional=, beginTranForResultSetScrollingAPIs=, beginTranForVendorAPIs=, syncQueryTimeoutWithTransactionTimeout=, supplementalJDBCTrace=, commitOrRollbackOnCleanup=, queryTimeout= }
    Property Mapping
     
     
    propertyMappingElementName: STRING = dataSource
    Property Mapping Element Name
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.

    wlp.DataSourceSpec

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

    Defines a data source configuration

      Public properties
     
     
    beginTranForResultSetScrollingAPIs: STRING
    Attempt transaction enlistment when result set scrolling interfaces are used. (boolean) default(true)
     
     
    beginTranForVendorAPIs: STRING
    Attempt transaction enlistment when vendor interfaces are used. (boolean) default(true)
     
     
    commitOrRollbackOnCleanup: STRING
    Determines how to clean up connections that might be in a database unit of work (AutoCommit=false) when the connection is closed or returned to the pool. (enum) values(commit, rollback)
     
     
    connectionManagerRef: STRING
    Connection manager for a data source. (string)
     
     
    connectionSharing: STRING
    Specifies how connections are matched for sharing. Default server value: MatchOriginalRequest. (enum) values(MatchOriginalRequest, MatchCurrentState)
     
     
    containerAuthDataRef: STRING
    Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER. (string)
     
     
    datasourceType: STRING
    Type of data source. (enum) values(javax.sql.XADataSource, javax.sql.ConnectionPoolDataSource, javax.sql.DataSource)
     
     
    isolationLevel: STRING
    Default transaction isolation level. (enum) values(TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE, TRANSACTION_SNAPSHOT)
     
     
    jdbcDriverRef: STRING
    JDBC driver for a data source. (string)
     
     
    jndiName: STRING
    JNDI name for a data source. (string)
     
     
    queryTimeout: STRING
    Default query timeout for SQL statements. In a JTA transaction, syncQueryTimeoutWithTransactionTimeout can override this default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds. (string)
     
     
    recoveryAuthDataRef: STRING
    Authentication data for transaction recovery. (string)
     
     
    statementCacheSize: STRING
    Maximum number of cached statements per connection. (integer)
     
     
    supplementalJDBCTrace: STRING
    Supplements the JDBC driver trace that is logged when JDBC driver trace is enabled in bootstrap.properties. JDBC driver trace specifications include: com.ibm.ws.database.logwriter, com.ibm.ws.db2.logwriter, com.ibm.ws.derby.logwriter, com.ibm.ws.informix.logwriter, com.ibm.ws.oracle.logwriter, com.ibm.ws.sqlserver.logwriter, com.ibm.ws.sybase.logwriter. (boolean) default(false)
     
     
    syncQueryTimeoutWithTransactionTimeout: STRING
    Use the time remaining (if any) in a JTA transaction as the default query timeout for SQL statements. (boolean) default(false)
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
     
     
    transactional: STRING
    Enable participation in transactions that are managed by the application server. (boolean) default(true)
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    wlp.EjbApplication

    Type Hierarchy wlp.Application >> udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer

    Java EE EJB archive.

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Children
     
     
    applicationBindings: SET_OF_CI<wlp.ApplicationBnd>
    Binds general deployment information included in the application to specific resources.
     
     
    classloader: SET_OF_CI<wlp.Classloader>
    Defines the settings for an application classloader.
      Public properties
     
     
    location: STRING
    Location of an application expressed as an absolute path or a path relative to the server-level apps directory. Example: /opt/wlp/usr/servers/defaultServer/apps/{applicationName} or {applicationName}.
     
     
    restartStrategy: ENUM [NONE, STOP_START] = NONE
    Application restart strategy.
     
     
    autoStart: BOOLEAN = true
    Indicates whether or not the server should start the application automatically when the server starts.
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    placeholders: MAP_STRING_STRING
    A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
      Hidden properties
     
     
    propertyMapping: MAP_STRING_STRING = { id=name, name=, location=, autoStart=, type=archiveType, classloader=, application-bnd=applicationBindings }
    Property Mapping
     
     
    propertyMappingElementName: STRING = ejbApplication
    Property Mapping Element Name
     
     
    archiveType: STRING = ejb
    Type of application archive.
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.
    Control taskParameter CIAttributesDescription
    start

    delegate = jythonScript, script = wlp/scripts/application/start-application.py

    Start application

    status

    delegate = jythonScript, script = wlp/scripts/application/check-application-status.py

    Status of the application

    stop

    delegate = jythonScript, script = wlp/scripts/application/stop-application.py

    Start application


    wlp.EjbApplicationSpec

    Type Hierarchy jee.EjbJar >> 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

    Java EE EJB archive.

      Children
     
     
    applicationBindings: SET_OF_CI<wlp.ApplicationBndSpec>
    Binds general deployment information included in the application to specific resources.
     
     
    classloader: SET_OF_CI<wlp.ClassloaderSpec>
    Defines the settings for an application classloader.
      Public properties
     
     
    autoStart: STRING
    Indicates whether or not the server should start the application automatically when the server starts. (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.
     
     
    excludeFileNamesRegex: STRING
    Regular expression that matches file names that must be excluded from scanning
     
     
    fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
    A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
     
     
    fileUri: STRING
    The URI pointing to the (remote) location of the file this artifact represents
     
     
    isRescanned: BOOLEAN
    Indicates if the artifact has been rescanned
     
     
    location: STRING
    Location of an application expressed as an absolute path or a path relative to the server-level apps directory. Example: /opt/wlp/usr/servers/defaultServer/apps/{applicationName} or {applicationName}. (string)
     
     
    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
     
     
    restartStrategy: STRING
    Application restart strategy. (enum) values(NONE, STOP_START) default(NONE)
     
     
    scanPlaceholders: BOOLEAN
    Whether to scan this artifact to replace placeholders when it is imported
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
      Hidden properties
     
     
    textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
    Regular expression that matches file names of text files
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.
     
     
    delimiters: STRING = {{ }}
    The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter

    wlp.EnterpriseApplication

    Type Hierarchy wlp.Application >> udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer

    Java EE EAR archive.

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Children
     
     
    applicationBindings: SET_OF_CI<wlp.ApplicationBnd>
    Binds general deployment information included in the application to specific resources.
     
     
    classloader: SET_OF_CI<wlp.Classloader>
    Defines the settings for an application classloader.
      Public properties
     
     
    location: STRING
    Location of an application expressed as an absolute path or a path relative to the server-level apps directory. Example: /opt/wlp/usr/servers/defaultServer/apps/{applicationName} or {applicationName}.
     
     
    restartStrategy: ENUM [NONE, STOP_START] = NONE
    Application restart strategy.
     
     
    autoStart: BOOLEAN = true
    Indicates whether or not the server should start the application automatically when the server starts.
     
     
    defaultClientModule: STRING
    Default client module of an enterprise application.
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    placeholders: MAP_STRING_STRING
    A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
      Hidden properties
     
     
    propertyMapping: MAP_STRING_STRING = { id=name, name=, location=, autoStart=, type=archiveType, defaultClientModule=, classloader=, application-bnd=applicationBindings }
    Property Mapping
     
     
    propertyMappingElementName: STRING = enterpriseApplication
    Property Mapping Element Name
     
     
    archiveType: STRING = ear
    Type of application archive.
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.
    Control taskParameter CIAttributesDescription
    start

    delegate = jythonScript, script = wlp/scripts/application/start-application.py

    Start application

    status

    delegate = jythonScript, script = wlp/scripts/application/check-application-status.py

    Status of the application

    stop

    delegate = jythonScript, script = wlp/scripts/application/stop-application.py

    Start application


    wlp.EnterpriseApplicationSpec

    Type Hierarchy jee.Ear >> 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

    Java EE EAR archive.

      Children
     
     
    applicationBindings: SET_OF_CI<wlp.ApplicationBndSpec>
    Binds general deployment information included in the application to specific resources.
     
     
    classloader: SET_OF_CI<wlp.ClassloaderSpec>
    Defines the settings for an application classloader.
      Public properties
     
     
    autoStart: STRING
    Indicates whether or not the server should start the application automatically when the server starts. (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.
     
     
    defaultClientModule: STRING
    Default client module of an enterprise application. (string)
     
     
    excludeFileNamesRegex: STRING
    Regular expression that matches file names that must be excluded from scanning
     
     
    fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
    A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
     
     
    fileUri: STRING
    The URI pointing to the (remote) location of the file this artifact represents
     
     
    isRescanned: BOOLEAN
    Indicates if the artifact has been rescanned
     
     
    location: STRING
    Location of an application expressed as an absolute path or a path relative to the server-level apps directory. Example: /opt/wlp/usr/servers/defaultServer/apps/{applicationName} or {applicationName}. (string)
     
     
    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
     
     
    restartStrategy: STRING
    Application restart strategy. (enum) values(NONE, STOP_START) default(NONE)
     
     
    scanPlaceholders: BOOLEAN
    Whether to scan this artifact to replace placeholders when it is imported
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
      Hidden properties
     
     
    textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
    Regular expression that matches file names of text files
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.
     
     
    delimiters: STRING = {{ }}
    The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter

    wlp.Feature

    Type Hierarchy udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    WebSphere Liberty Profile enterprise subsystem.

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    installFeature: BOOLEAN = true
    Install a feature or an enterprise subsystem archive (ESA) file to the runtime environment.
     
     
    installOptions: STRING = --acceptLicense --when-file-exists=replace
    Specify additional options for the featureManager install command (e.g. --offlineOnly,--to=usr).
      Hidden properties
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.

    wlp.FeatureSpec

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

    WebSphere Liberty Profile enterprise subsystem.

      Public properties
     
     
    installFeature: STRING
    Install a feature or an enterprise subsystem archive (ESA) file to the runtime environment. (boolean) default(true)
     
     
    installOptions: STRING
    Specify additional options for the featureManager install command (e.g. --offlineOnly,--to=usr). (string) default(--acceptLicense --when-file-exists=replace)
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    wlp.Fileset

    Type Hierarchy wlp.Resource >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    Specifies a set of files starting from a base directory and matching a set of patterns.

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    dir: STRING
    The base directory to search for files. Default server value: ${server.config.dir}.
     
     
    caseSensitive: BOOLEAN = true
    Boolean to indicate whether or not the search should be case sensitive.
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    excludes: STRING
    The comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded.
     
     
    includes: STRING
    The comma or space separated list of file name patterns to include in the search results. Default server value: *
     
     
    scanInterval: STRING
    Scanning interval to check the fileset for changes as a long with a time unit suffix h-hour, m-minute, s-second, ms-millisecond (e.g. 2ms or 5s). Default server value: 0.
      Hidden properties
     
     
    createOrder: INTEGER = 63
    Create Order
     
     
    destroyOrder: INTEGER = 46
    Destroy Order
     
     
    propertyMapping: MAP_STRING_STRING = { id=name, name=, dir=, caseSensitive=, includes=, excludes=, scanInterval= }
    Property Mapping
     
     
    propertyMappingElementName: STRING = fileset
    Property Mapping Element Name
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.

    wlp.FilesetSpec

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

    Specifies a set of files starting from a base directory and matching a set of patterns.

      Public properties
     
     
    caseSensitive: STRING
    Boolean to indicate whether or not the search should be case sensitive. (boolean) default(true)
     
     
    dir: STRING
    The base directory to search for files. Default server value: ${server.config.dir}. (string)
     
     
    excludes: STRING
    The comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded. (string)
     
     
    includes: STRING
    The comma or space separated list of file name patterns to include in the search results. Default server value: * (string)
     
     
    scanInterval: STRING
    Scanning interval to check the fileset for changes as a long with a time unit suffix h-hour, m-minute, s-second, ms-millisecond (e.g. 2ms or 5s). Default server value: 0. (string)
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    wlp.GenericDataSource

    Type Hierarchy wlp.DataSource >> wlp.Resource >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    Defines generic data source configuration.

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    jndiName: STRING
    JNDI name for a data source.
     
     
    beginTranForResultSetScrollingAPIs: BOOLEAN = true
    Attempt transaction enlistment when result set scrolling interfaces are used.
     
     
    beginTranForVendorAPIs: BOOLEAN = true
    Attempt transaction enlistment when vendor interfaces are used.
     
     
    commitOrRollbackOnCleanup: ENUM [commit, rollback]
    Determines how to clean up connections that might be in a database unit of work (AutoCommit=false) when the connection is closed or returned to the pool.
     
     
    connectionManagerRef: STRING
    Connection manager for a data source.
     
     
    connectionSharing: ENUM [MatchOriginalRequest, MatchCurrentState]
    Specifies how connections are matched for sharing. Default server value: MatchOriginalRequest.
     
     
    containerAuthDataRef: STRING
    Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER.
     
     
    databaseName: STRING
    JDBC driver property: databaseName.
     
     
    datasourceType: ENUM [javax.sql.XADataSource, javax.sql.ConnectionPoolDataSource, javax.sql.DataSource]
    Type of data source.
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    isolationLevel: ENUM [TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE, TRANSACTION_SNAPSHOT]
    Default transaction isolation level.
     
     
    jdbcDriverRef: STRING
    JDBC driver for a data source.
     
     
    password: STRING
    It is recommended to use a container managed authentication alias instead of configuring this property.
     
     
    portNumber: INTEGER
    Port on which to obtain database connections.
     
     
    queryTimeout: STRING
    Default query timeout for SQL statements. In a JTA transaction, syncQueryTimeoutWithTransactionTimeout can override this default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
     
     
    recoveryAuthDataRef: STRING
    Authentication data for transaction recovery.
     
     
    serverName: STRING
    Server where the database is running.
     
     
    statementCacheSize: INTEGER
    Maximum number of cached statements per connection.
     
     
    supplementalJDBCTrace: BOOLEAN
    Supplements the JDBC driver trace that is logged when JDBC driver trace is enabled in bootstrap.properties. JDBC driver trace specifications include: com.ibm.ws.database.logwriter, com.ibm.ws.db2.logwriter, com.ibm.ws.derby.logwriter, com.ibm.ws.informix.logwriter, com.ibm.ws.oracle.logwriter, com.ibm.ws.sqlserver.logwriter, com.ibm.ws.sybase.logwriter.
     
     
    syncQueryTimeoutWithTransactionTimeout: BOOLEAN
    Use the time remaining (if any) in a JTA transaction as the default query timeout for SQL statements.
     
     
    transactional: BOOLEAN = true
    Enable participation in transactions that are managed by the application server.
     
     
    url: STRING
    URL for connecting to the database.
     
     
    user: STRING
    It is recommended to use a container managed authentication alias instead of configuring this property.
      Hidden properties
     
     
    additionalPropertyMapping: MAP_STRING_STRING = { properties/databaseName=databaseName, properties/serverName=serverName, properties/portNumber=portNumber, properties/URL=url, properties/user=user, properties/password=password }
    Additional Property Mapping
     
     
    createOrder: INTEGER = 67
    Create Order
     
     
    destroyOrder: INTEGER = 42
    Destroy Order
     
     
    propertyMapping: MAP_STRING_STRING = { id=name, jndiName=, jdbcDriverRef=, connectionManagerRef=, containerAuthDataRef=, recoveryAuthDataRef=, datasourceType=, connectionSharing=, isolationLevel=, statementCacheSize=, transactional=, beginTranForResultSetScrollingAPIs=, beginTranForVendorAPIs=, syncQueryTimeoutWithTransactionTimeout=, supplementalJDBCTrace=, commitOrRollbackOnCleanup=, queryTimeout= }
    Property Mapping
     
     
    propertyMappingElementName: STRING = dataSource
    Property Mapping Element Name
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.

    wlp.GenericDataSourceSpec

    Type Hierarchy wlp.DataSourceSpec >> wlp.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.Deployable, udm.Taggable

    Defines generic data source configuration.

      Public properties
     
     
    beginTranForResultSetScrollingAPIs: STRING
    Attempt transaction enlistment when result set scrolling interfaces are used. (boolean) default(true)
     
     
    beginTranForVendorAPIs: STRING
    Attempt transaction enlistment when vendor interfaces are used. (boolean) default(true)
     
     
    commitOrRollbackOnCleanup: STRING
    Determines how to clean up connections that might be in a database unit of work (AutoCommit=false) when the connection is closed or returned to the pool. (enum) values(commit, rollback)
     
     
    connectionManagerRef: STRING
    Connection manager for a data source. (string)
     
     
    connectionSharing: STRING
    Specifies how connections are matched for sharing. Default server value: MatchOriginalRequest. (enum) values(MatchOriginalRequest, MatchCurrentState)
     
     
    containerAuthDataRef: STRING
    Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER. (string)
     
     
    databaseName: STRING
    JDBC driver property: databaseName. (string)
     
     
    datasourceType: STRING
    Type of data source. (enum) values(javax.sql.XADataSource, javax.sql.ConnectionPoolDataSource, javax.sql.DataSource)
     
     
    isolationLevel: STRING
    Default transaction isolation level. (enum) values(TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE, TRANSACTION_SNAPSHOT)
     
     
    jdbcDriverRef: STRING
    JDBC driver for a data source. (string)
     
     
    jndiName: STRING
    JNDI name for a data source. (string)
     
     
    password: STRING
    It is recommended to use a container managed authentication alias instead of configuring this property. (string)
     
     
    portNumber: STRING
    Port on which to obtain database connections. (integer)
     
     
    queryTimeout: STRING
    Default query timeout for SQL statements. In a JTA transaction, syncQueryTimeoutWithTransactionTimeout can override this default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds. (string)
     
     
    recoveryAuthDataRef: STRING
    Authentication data for transaction recovery. (string)
     
     
    serverName: STRING
    Server where the database is running. (string)
     
     
    statementCacheSize: STRING
    Maximum number of cached statements per connection. (integer)
     
     
    supplementalJDBCTrace: STRING
    Supplements the JDBC driver trace that is logged when JDBC driver trace is enabled in bootstrap.properties. JDBC driver trace specifications include: com.ibm.ws.database.logwriter, com.ibm.ws.db2.logwriter, com.ibm.ws.derby.logwriter, com.ibm.ws.informix.logwriter, com.ibm.ws.oracle.logwriter, com.ibm.ws.sqlserver.logwriter, com.ibm.ws.sybase.logwriter. (boolean) default(false)
     
     
    syncQueryTimeoutWithTransactionTimeout: STRING
    Use the time remaining (if any) in a JTA transaction as the default query timeout for SQL statements. (boolean) default(false)
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
     
     
    transactional: STRING
    Enable participation in transactions that are managed by the application server. (boolean) default(true)
     
     
    url: STRING
    URL for connecting to the database. (string)
     
     
    user: STRING
    It is recommended to use a container managed authentication alias instead of configuring this property. (string)
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    wlp.GroupRole

    Type Hierarchy udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
    Interfaces udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

    A group possessing a security role.

      Parent
     
     
    container: CI<udm.EmbeddedDeployedContainer>
    The (embedded) deployed which contains this embedded deployed.
      Public properties
     
     
    groupName: STRING
    Name of a group possessing a security role.
     
     
    accessId: STRING
    Group access ID.
     
     
    deployable: CI<udm.EmbeddedDeployable>
    The embedded deployable that this embedded deployed is derived from.
      Hidden properties
     
     
    propertyMapping: MAP_STRING_STRING = { id=name, name=groupName, access-id=accessId }
    Property Mapping

    wlp.GroupRoleSpec

    Type Hierarchy udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
    Interfaces udm.EmbeddedDeployable

    A group possessing a security role.

      Public properties
     
     
    accessId: STRING
    Group access ID. (string)
     
     
    groupName: STRING
    Name of a group possessing a security role. (string)

    wlp.JdbcDriver

    Type Hierarchy wlp.Resource >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    JDBC driver.

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    libraryRef: STRING
    Identifies JDBC driver JARs and native files.
     
     
    connectionPoolDataSource: STRING
    JDBC driver implementation of javax.sql.ConnectionPoolDataSource.
     
     
    dataSource: STRING
    JDBC driver implementation of javax.sql.DataSource.
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    xaDataSource: STRING
    JDBC driver implementation of javax.sql.XADataSource.
      Hidden properties
     
     
    createOrder: INTEGER = 65
    Create Order
     
     
    destroyOrder: INTEGER = 44
    Destroy Order
     
     
    propertyMapping: MAP_STRING_STRING = { id=name, libraryRef=, javax.sql.XADataSource=xaDataSource, javax.sql.ConnectionPoolDataSource=connectionPoolDataSource, javax.sql.DataSource=dataSource }
    Property Mapping
     
     
    propertyMappingElementName: STRING = jdbcDriver
    Property Mapping Element Name
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.

    wlp.JdbcDriverSpec

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

    JDBC driver.

      Public properties
     
     
    connectionPoolDataSource: STRING
    JDBC driver implementation of javax.sql.ConnectionPoolDataSource. (string)
     
     
    dataSource: STRING
    JDBC driver implementation of javax.sql.DataSource. (string)
     
     
    libraryRef: STRING
    Identifies JDBC driver JARs and native files. (string)
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
     
     
    xaDataSource: STRING
    JDBC driver implementation of javax.sql.XADataSource. (string)
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    wlp.JmsConnectionFactory

    Virtual Type
    Type Hierarchy wlp.Resource >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    Defines a Base JMS connection factory configuration.

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    connectionManagerRef: STRING
    Connection manager for a connection factory.
     
     
    containerAuthDataRef: STRING
    Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER.
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    jndiName: STRING
    JNDI name for a resource.
     
     
    recoveryAuthDataRef: STRING
    Authentication data for transaction recovery.
      Hidden properties
     
     
    createOrder: INTEGER = 60
    Create Order
     
     
    destroyOrder: INTEGER = 40
    Destroy Order
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.

    wlp.JmsConnectionFactorySpec

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

    Defines a Base JMS connection factory configuration.

      Public properties
     
     
    connectionManagerRef: STRING
    Connection manager for a connection factory. (string)
     
     
    containerAuthDataRef: STRING
    Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER. (string)
     
     
    jndiName: STRING
    JNDI name for a resource. (string)
     
     
    recoveryAuthDataRef: STRING
    Authentication data for transaction recovery. (string)
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    wlp.JmsResource

    Virtual Type
    Type Hierarchy wlp.Resource >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    Defines a JMS configuration.

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    jndiName: STRING
    JNDI name for a resource.
      Hidden properties
     
     
    createOrder: INTEGER = 60
    Create Order
     
     
    destroyOrder: INTEGER = 40
    Destroy Order
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.

    wlp.JmsResourceSpec

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

    Defines a JMS configuration.

      Public properties
     
     
    jndiName: STRING
    JNDI name for a resource. (string)
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    wlp.Library

    Type Hierarchy wlp.Resource >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    WAS Liberty Shared Library

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    apiTypeVisibility: STRING
    The types of API package this library's class loader will be able to see, as a comma-separated list of any combination of the following: spec, ibm-api, api, third-party. Default server value: spec,ibm-api,api.
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    filesetRef: STRING
    List of library references, List of configuration IDs of type library (comma-separated string).
      Hidden properties
     
     
    createOrder: INTEGER = 64
    Create Order
     
     
    destroyOrder: INTEGER = 45
    Destroy Order
     
     
    propertyMapping: MAP_STRING_STRING = { id=name, name=, filesetRef=, apiTypeVisibility= }
    Property Mapping
     
     
    propertyMappingElementName: STRING = library
    Property Mapping Element Name
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.

    wlp.LibrarySpec

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

    WAS Liberty Shared Library

      Public properties
     
     
    apiTypeVisibility: STRING
    The types of API package this library's class loader will be able to see, as a comma-separated list of any combination of the following: spec, ibm-api, api, third-party. Default server value: spec,ibm-api,api. (string)
     
     
    filesetRef: STRING
    List of library references, List of configuration IDs of type library (comma-separated string). (string)
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    wlp.MicrosoftSQLServerDataSource

    Type Hierarchy wlp.DataSource >> wlp.Resource >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    Defines Microsoft SQL Server data source configuration (Microsoft JDBC driver).

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    jndiName: STRING
    JNDI name for a data source.
     
     
    beginTranForResultSetScrollingAPIs: BOOLEAN = true
    Attempt transaction enlistment when result set scrolling interfaces are used.
     
     
    beginTranForVendorAPIs: BOOLEAN = true
    Attempt transaction enlistment when vendor interfaces are used.
     
     
    commitOrRollbackOnCleanup: ENUM [commit, rollback]
    Determines how to clean up connections that might be in a database unit of work (AutoCommit=false) when the connection is closed or returned to the pool.
     
     
    connectionManagerRef: STRING
    Connection manager for a data source.
     
     
    connectionSharing: ENUM [MatchOriginalRequest, MatchCurrentState]
    Specifies how connections are matched for sharing. Default server value: MatchOriginalRequest.
     
     
    containerAuthDataRef: STRING
    Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER.
     
     
    customProperties: MAP_STRING_STRING
    Specifies additional custom datasource properties that you can configure for properties.microsoft.sqlserver element.
     
     
    databaseName: STRING
    The name of the database to connect to. If not stated, a connection is made to the default database.
     
     
    datasourceType: ENUM [javax.sql.XADataSource, javax.sql.ConnectionPoolDataSource, javax.sql.DataSource]
    Type of data source.
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    instanceName: STRING
    The SQL Server instance name to connect to. When it is not specified, a connection is made to the default instance.
     
     
    isolationLevel: ENUM [TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE, TRANSACTION_SNAPSHOT]
    Default transaction isolation level.
     
     
    jdbcDriverRef: STRING
    JDBC driver for a data source.
     
     
    password: STRING
    It is recommended to use a container managed authentication alias instead of configuring this property.
     
     
    portNumber: INTEGER
    Port on which to obtain database connections. Server default value: 1433.
     
     
    queryTimeout: STRING
    Default query timeout for SQL statements. In a JTA transaction, syncQueryTimeoutWithTransactionTimeout can override this default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
     
     
    recoveryAuthDataRef: STRING
    Authentication data for transaction recovery.
     
     
    serverName: STRING
    Server where the database is running. Server default value: localhost.
     
     
    statementCacheSize: INTEGER
    Maximum number of cached statements per connection.
     
     
    supplementalJDBCTrace: BOOLEAN
    Supplements the JDBC driver trace that is logged when JDBC driver trace is enabled in bootstrap.properties. JDBC driver trace specifications include: com.ibm.ws.database.logwriter, com.ibm.ws.db2.logwriter, com.ibm.ws.derby.logwriter, com.ibm.ws.informix.logwriter, com.ibm.ws.oracle.logwriter, com.ibm.ws.sqlserver.logwriter, com.ibm.ws.sybase.logwriter.
     
     
    syncQueryTimeoutWithTransactionTimeout: BOOLEAN
    Use the time remaining (if any) in a JTA transaction as the default query timeout for SQL statements.
     
     
    transactional: BOOLEAN = true
    Enable participation in transactions that are managed by the application server.
     
     
    url: STRING
    URL for connecting to the database. Example: jdbc:sqlserver://localhost:1433;databaseName=myDB.
     
     
    user: STRING
    It is recommended to use a container managed authentication alias instead of configuring this property.
      Hidden properties
     
     
    additionalPropertyMapping: MAP_STRING_STRING = { properties.microsoft.sqlserver/databaseName=databaseName, properties.microsoft.sqlserver/instanceName=instanceName, properties.microsoft.sqlserver/serverName=serverName, properties.microsoft.sqlserver/portNumber=portNumber, properties.microsoft.sqlserver/URL=url, properties.microsoft.sqlserver/user=user, properties.microsoft.sqlserver/password=password }
    Additional Property Mapping
     
     
    createOrder: INTEGER = 67
    Create Order
     
     
    customPropertiesElementName: STRING = properties.microsoft.sqlserver
    Element name for custom properties.
     
     
    destroyOrder: INTEGER = 42
    Destroy Order
     
     
    propertyMapping: MAP_STRING_STRING = { id=name, jndiName=, jdbcDriverRef=, connectionManagerRef=, containerAuthDataRef=, recoveryAuthDataRef=, datasourceType=, connectionSharing=, isolationLevel=, statementCacheSize=, transactional=, beginTranForResultSetScrollingAPIs=, beginTranForVendorAPIs=, syncQueryTimeoutWithTransactionTimeout=, supplementalJDBCTrace=, commitOrRollbackOnCleanup=, queryTimeout= }
    Property Mapping
     
     
    propertyMappingElementName: STRING = dataSource
    Property Mapping Element Name
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.

    wlp.MicrosoftSQLServerDataSourceSpec

    Type Hierarchy wlp.DataSourceSpec >> wlp.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.Deployable, udm.Taggable

    Defines Microsoft SQL Server data source configuration (Microsoft JDBC driver).

      Public properties
     
     
    beginTranForResultSetScrollingAPIs: STRING
    Attempt transaction enlistment when result set scrolling interfaces are used. (boolean) default(true)
     
     
    beginTranForVendorAPIs: STRING
    Attempt transaction enlistment when vendor interfaces are used. (boolean) default(true)
     
     
    commitOrRollbackOnCleanup: STRING
    Determines how to clean up connections that might be in a database unit of work (AutoCommit=false) when the connection is closed or returned to the pool. (enum) values(commit, rollback)
     
     
    connectionManagerRef: STRING
    Connection manager for a data source. (string)
     
     
    connectionSharing: STRING
    Specifies how connections are matched for sharing. Default server value: MatchOriginalRequest. (enum) values(MatchOriginalRequest, MatchCurrentState)
     
     
    containerAuthDataRef: STRING
    Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER. (string)
     
     
    customProperties: MAP_STRING_STRING
    Specifies additional custom datasource properties that you can configure for properties.microsoft.sqlserver element. (map_string_string)
     
     
    databaseName: STRING
    The name of the database to connect to. If not stated, a connection is made to the default database. (string)
     
     
    datasourceType: STRING
    Type of data source. (enum) values(javax.sql.XADataSource, javax.sql.ConnectionPoolDataSource, javax.sql.DataSource)
     
     
    instanceName: STRING
    The SQL Server instance name to connect to. When it is not specified, a connection is made to the default instance. (string)
     
     
    isolationLevel: STRING
    Default transaction isolation level. (enum) values(TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE, TRANSACTION_SNAPSHOT)
     
     
    jdbcDriverRef: STRING
    JDBC driver for a data source. (string)
     
     
    jndiName: STRING
    JNDI name for a data source. (string)
     
     
    password: STRING
    It is recommended to use a container managed authentication alias instead of configuring this property. (string)
     
     
    portNumber: STRING
    Port on which to obtain database connections. Server default value: 1433. (integer)
     
     
    queryTimeout: STRING
    Default query timeout for SQL statements. In a JTA transaction, syncQueryTimeoutWithTransactionTimeout can override this default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds. (string)
     
     
    recoveryAuthDataRef: STRING
    Authentication data for transaction recovery. (string)
     
     
    serverName: STRING
    Server where the database is running. Server default value: localhost. (string)
     
     
    statementCacheSize: STRING
    Maximum number of cached statements per connection. (integer)
     
     
    supplementalJDBCTrace: STRING
    Supplements the JDBC driver trace that is logged when JDBC driver trace is enabled in bootstrap.properties. JDBC driver trace specifications include: com.ibm.ws.database.logwriter, com.ibm.ws.db2.logwriter, com.ibm.ws.derby.logwriter, com.ibm.ws.informix.logwriter, com.ibm.ws.oracle.logwriter, com.ibm.ws.sqlserver.logwriter, com.ibm.ws.sybase.logwriter. (boolean) default(false)
     
     
    syncQueryTimeoutWithTransactionTimeout: STRING
    Use the time remaining (if any) in a JTA transaction as the default query timeout for SQL statements. (boolean) default(false)
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
     
     
    transactional: STRING
    Enable participation in transactions that are managed by the application server. (boolean) default(true)
     
     
    url: STRING
    URL for connecting to the database. Example: jdbc:sqlserver://localhost:1433;databaseName=myDB. (string)
     
     
    user: STRING
    It is recommended to use a container managed authentication alias instead of configuring this property. (string)
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    wlp.OracleDataSource

    Type Hierarchy wlp.DataSource >> wlp.Resource >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    Defines Oracle data source configuration.

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    jndiName: STRING
    JNDI name for a data source.
     
     
    beginTranForResultSetScrollingAPIs: BOOLEAN = true
    Attempt transaction enlistment when result set scrolling interfaces are used.
     
     
    beginTranForVendorAPIs: BOOLEAN = true
    Attempt transaction enlistment when vendor interfaces are used.
     
     
    commitOrRollbackOnCleanup: ENUM [commit, rollback]
    Determines how to clean up connections that might be in a database unit of work (AutoCommit=false) when the connection is closed or returned to the pool.
     
     
    connectionManagerRef: STRING
    Connection manager for a data source.
     
     
    connectionProperties: STRING
    JDBC driver property: connectionProperties.
     
     
    connectionSharing: ENUM [MatchOriginalRequest, MatchCurrentState]
    Specifies how connections are matched for sharing. Default server value: MatchOriginalRequest.
     
     
    containerAuthDataRef: STRING
    Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER.
     
     
    customProperties: MAP_STRING_STRING
    Specifies additional custom datasource properties that you can configure for properties.oracle element.
     
     
    databaseName: STRING
    JDBC driver property: databaseName.
     
     
    datasourceType: ENUM [javax.sql.XADataSource, javax.sql.ConnectionPoolDataSource, javax.sql.DataSource]
    Type of data source.
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    driverType: ENUM [thin, oci]
    JDBC driver property: driverType. Server default value: thin.
     
     
    isolationLevel: ENUM [TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE, TRANSACTION_SNAPSHOT]
    Default transaction isolation level.
     
     
    jdbcDriverRef: STRING
    JDBC driver for a data source.
     
     
    loginTimeout: STRING
    JDBC driver property: loginTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
     
     
    networkProtocol: STRING
    JDBC driver property: networkProtocol.
     
     
    onsConfiguration: STRING
    JDBC driver property: ONSConfiguration.
     
     
    password: STRING
    It is recommended to use a container managed authentication alias instead of configuring this property.
     
     
    portNumber: INTEGER
    Port on which to obtain database connections. Server default value: 1521.
     
     
    queryTimeout: STRING
    Default query timeout for SQL statements. In a JTA transaction, syncQueryTimeoutWithTransactionTimeout can override this default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
     
     
    recoveryAuthDataRef: STRING
    Authentication data for transaction recovery.
     
     
    serverName: STRING
    Server where the database is running. Server default value: localhost.
     
     
    serviceName: STRING
    JDBC driver property: serviceName.
     
     
    statementCacheSize: INTEGER
    Maximum number of cached statements per connection.
     
     
    supplementalJDBCTrace: BOOLEAN
    Supplements the JDBC driver trace that is logged when JDBC driver trace is enabled in bootstrap.properties. JDBC driver trace specifications include: com.ibm.ws.database.logwriter, com.ibm.ws.db2.logwriter, com.ibm.ws.derby.logwriter, com.ibm.ws.informix.logwriter, com.ibm.ws.oracle.logwriter, com.ibm.ws.sqlserver.logwriter, com.ibm.ws.sybase.logwriter.
     
     
    syncQueryTimeoutWithTransactionTimeout: BOOLEAN
    Use the time remaining (if any) in a JTA transaction as the default query timeout for SQL statements.
     
     
    tnsEntryName: STRING
    JDBC driver property: TNSEntryName.
     
     
    transactional: BOOLEAN = true
    Enable participation in transactions that are managed by the application server.
     
     
    url: STRING
    URL for connecting to the database. Examples: jdbc:oracle:thin:@//localhost:1521/sample or jdbc:oracle:oci:@//localhost:1521/sample.
     
     
    user: STRING
    It is recommended to use a container managed authentication alias instead of configuring this property.
      Hidden properties
     
     
    additionalPropertyMapping: MAP_STRING_STRING = { properties.oracle/databaseName=databaseName, properties.oracle/serverName=serverName, properties.oracle/portNumber=portNumber, properties.oracle/URL=url, properties.oracle/user=user, properties.oracle/password=password, properties.oracle/connectionProperties=connectionProperties, properties.oracle/loginTimout=loginTimeout, properties.oracle/networkProtocol=networkProtocol, properties.oracle/ONSConfiguration=onsConfiguration, properties.oracle/serviceName=serviceName, properties.oracle/TNSEntryName=tnsEntryName }
    Additional Property Mapping
     
     
    createOrder: INTEGER = 67
    Create Order
     
     
    customPropertiesElementName: STRING = properties.oracle
    Element name for custom properties.
     
     
    destroyOrder: INTEGER = 42
    Destroy Order
     
     
    propertyMapping: MAP_STRING_STRING = { id=name, jndiName=, jdbcDriverRef=, connectionManagerRef=, containerAuthDataRef=, recoveryAuthDataRef=, datasourceType=, connectionSharing=, isolationLevel=, statementCacheSize=, transactional=, beginTranForResultSetScrollingAPIs=, beginTranForVendorAPIs=, syncQueryTimeoutWithTransactionTimeout=, supplementalJDBCTrace=, commitOrRollbackOnCleanup=, queryTimeout= }
    Property Mapping
     
     
    propertyMappingElementName: STRING = dataSource
    Property Mapping Element Name
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.

    wlp.OracleDataSourceSpec

    Type Hierarchy wlp.DataSourceSpec >> wlp.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.Deployable, udm.Taggable

    Defines Oracle data source configuration.

      Public properties
     
     
    beginTranForResultSetScrollingAPIs: STRING
    Attempt transaction enlistment when result set scrolling interfaces are used. (boolean) default(true)
     
     
    beginTranForVendorAPIs: STRING
    Attempt transaction enlistment when vendor interfaces are used. (boolean) default(true)
     
     
    commitOrRollbackOnCleanup: STRING
    Determines how to clean up connections that might be in a database unit of work (AutoCommit=false) when the connection is closed or returned to the pool. (enum) values(commit, rollback)
     
     
    connectionManagerRef: STRING
    Connection manager for a data source. (string)
     
     
    connectionProperties: STRING
    JDBC driver property: connectionProperties. (string)
     
     
    connectionSharing: STRING
    Specifies how connections are matched for sharing. Default server value: MatchOriginalRequest. (enum) values(MatchOriginalRequest, MatchCurrentState)
     
     
    containerAuthDataRef: STRING
    Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER. (string)
     
     
    customProperties: MAP_STRING_STRING
    Specifies additional custom datasource properties that you can configure for properties.oracle element. (map_string_string)
     
     
    databaseName: STRING
    JDBC driver property: databaseName. (string)
     
     
    datasourceType: STRING
    Type of data source. (enum) values(javax.sql.XADataSource, javax.sql.ConnectionPoolDataSource, javax.sql.DataSource)
     
     
    driverType: STRING
    JDBC driver property: driverType. Server default value: thin. (enum) values(thin, oci)
     
     
    isolationLevel: STRING
    Default transaction isolation level. (enum) values(TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE, TRANSACTION_SNAPSHOT)
     
     
    jdbcDriverRef: STRING
    JDBC driver for a data source. (string)
     
     
    jndiName: STRING
    JNDI name for a data source. (string)
     
     
    loginTimeout: STRING
    JDBC driver property: loginTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds. (string)
     
     
    networkProtocol: STRING
    JDBC driver property: networkProtocol. (string)
     
     
    onsConfiguration: STRING
    JDBC driver property: ONSConfiguration. (string)
     
     
    password: STRING
    It is recommended to use a container managed authentication alias instead of configuring this property. (string)
     
     
    portNumber: STRING
    Port on which to obtain database connections. Server default value: 1521. (integer)
     
     
    queryTimeout: STRING
    Default query timeout for SQL statements. In a JTA transaction, syncQueryTimeoutWithTransactionTimeout can override this default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds. (string)
     
     
    recoveryAuthDataRef: STRING
    Authentication data for transaction recovery. (string)
     
     
    serverName: STRING
    Server where the database is running. Server default value: localhost. (string)
     
     
    serviceName: STRING
    JDBC driver property: serviceName. (string)
     
     
    statementCacheSize: STRING
    Maximum number of cached statements per connection. (integer)
     
     
    supplementalJDBCTrace: STRING
    Supplements the JDBC driver trace that is logged when JDBC driver trace is enabled in bootstrap.properties. JDBC driver trace specifications include: com.ibm.ws.database.logwriter, com.ibm.ws.db2.logwriter, com.ibm.ws.derby.logwriter, com.ibm.ws.informix.logwriter, com.ibm.ws.oracle.logwriter, com.ibm.ws.sqlserver.logwriter, com.ibm.ws.sybase.logwriter. (boolean) default(false)
     
     
    syncQueryTimeoutWithTransactionTimeout: STRING
    Use the time remaining (if any) in a JTA transaction as the default query timeout for SQL statements. (boolean) default(false)
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
     
     
    tnsEntryName: STRING
    JDBC driver property: TNSEntryName. (string)
     
     
    transactional: STRING
    Enable participation in transactions that are managed by the application server. (boolean) default(true)
     
     
    url: STRING
    URL for connecting to the database. Examples: jdbc:oracle:thin:@//localhost:1521/sample or jdbc:oracle:oci:@//localhost:1521/sample. (string)
     
     
    user: STRING
    It is recommended to use a container managed authentication alias instead of configuring this property. (string)
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    wlp.Resource

    Virtual Type
    Type Hierarchy udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    WAS Liberty resource.

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
      Hidden properties
     
     
    createOrder: INTEGER = 60
    Create Order
     
     
    destroyOrder: INTEGER = 40
    Destroy Order
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.

    wlp.ResourceSpec

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

    WAS Liberty resource.

      Public properties
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    wlp.RunAsUserRole

    Type Hierarchy udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
    Interfaces udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

    ID and password of a user required to access a bean from another bean.

      Parent
     
     
    container: CI<udm.EmbeddedDeployedContainer>
    The (embedded) deployed which contains this embedded deployed.
      Public properties
     
     
    userid: STRING
    ID of a user required to access a bean from another bean.
     
     
    deployable: CI<udm.EmbeddedDeployable>
    The embedded deployable that this embedded deployed is derived from.
     
     
    password: STRING
    Password of a user required to access a bean from another bean. The value can be stored in clear text or encoded form. To encode the password, use the securityUtility tool with the encode option.
      Hidden properties
     
     
    propertyMapping: MAP_STRING_STRING = { id=name, userid=, password= }
    Property Mapping

    wlp.RunAsUserRoleSpec

    Type Hierarchy udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
    Interfaces udm.EmbeddedDeployable

    ID and password of a user required to access a bean from another bean.

      Public properties
     
     
    password: STRING
    Password of a user required to access a bean from another bean. The value can be stored in clear text or encoded form. To encode the password, use the securityUtility tool with the encode option. (string)
     
     
    userid: STRING
    ID of a user required to access a bean from another bean. (string)

    wlp.SecurityRole

    Type Hierarchy udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
    Interfaces udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

    A role that is mapped to users and groups in a domain user registry.

      Parent
     
     
    container: CI<udm.EmbeddedDeployedContainer>
    The (embedded) deployed which contains this embedded deployed.
      Children
     
     
    groups: SET_OF_CI<wlp.GroupRole>
    Groups possessing the security role.
     
     
    runAsUsers: SET_OF_CI<wlp.RunAsUserRole>
    ID and password of users required to access a bean from another bean.
     
     
    specialSubjects: SET_OF_CI<wlp.SpecialSubjectRole>
    Special subjects possessing the security role.
     
     
    users: SET_OF_CI<wlp.UserRole>
    Users possessing the security role.
      Public properties
     
     
    roleName: STRING
    Name of a user possessing a security role.
     
     
    deployable: CI<udm.EmbeddedDeployable>
    The embedded deployable that this embedded deployed is derived from.
      Hidden properties
     
     
    propertyMapping: MAP_STRING_STRING = { id=name, name=roleName, user=users, group=groups, special-subject=specialSubjects, run-as=runAsUsers }
    Property Mapping

    wlp.SecurityRoleSpec

    Type Hierarchy udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
    Interfaces udm.EmbeddedDeployable

    A role that is mapped to users and groups in a domain user registry.

      Children
     
     
    groups: SET_OF_CI<wlp.GroupRoleSpec>
    Groups possessing the security role.
     
     
    runAsUsers: SET_OF_CI<wlp.RunAsUserRoleSpec>
    ID and password of users required to access a bean from another bean.
     
     
    specialSubjects: SET_OF_CI<wlp.SpecialSubjectRoleSpec>
    Special subjects possessing the security role.
     
     
    users: SET_OF_CI<wlp.UserRoleSpec>
    Users possessing the security role.
      Public properties
     
     
    roleName: STRING
    Name of a user possessing a security role. (string)

    wlp.Server

    Type Hierarchy udm.BaseContainer >> udm.BaseConfigurationItem
    Interfaces udm.Container, overthere.HostContainer, udm.Taggable, wlp.WlpContainer

    An standalone WebSphere Liberty Profile server

      Parent
     
     
    host: CI<overthere.Host>
    Host upon which the container resides
      Public properties
     
     
    wlpInstallDir: STRING
    The base directory for the WebSphere Liberty Profile installation, such as /opt/IBM/WebSphereLiberty/.
     
     
    hostname: STRING
    Host name or IP address of the server.
     
     
    httpsPort: INTEGER
    HTTPS port of the server where the REST JMX connector is exposed.
     
     
    password: STRING
    Password of the user.
     
     
    reloadServerConfiguration: BOOLEAN = true
    Notify the WLP server about server.xml changes after deployments and undeployments.
     
     
    serverConfigDir: STRING
    The configuration directory of the WebSphere Liberty Profile server, such as /opt/IBM/WebSphereLiberty/usr/servers/defaultServer. Defaults to ${deployed.wlpInstallDir}/usr/servers/${deployed.name} if not specified.
     
     
    tags: SET_OF_STRING
    If set, only deployables with the same tag will be automatically mapped to this container.
     
     
    trustStorePassword: STRING
    The password for the trust store file.
     
     
    trustStorePath: STRING
    The trust store file containing authorized certificates.
     
     
    username: STRING
    Name of the user to authenticate agains the REST JMX connector.
      Hidden properties
     
     
    connectTimeout: INTEGER = 60000
    Timeout opening a communications link to the resource, in milliseconds.
     
     
    readTimeout: INTEGER = 60000
    Timeout reading from Input stream when a connection is established, in milliseconds.
     
     
    sslProtocol: STRING = SSL
    The underlying protocol used for communication, e.g. SSL, SSLv3, TLS, TLSv1.2 etc.
     
     
    trustAllCertificates: BOOLEAN
    Ignores certificate verification checks, use in development environments only.
     
     
    trustAllHostnames: BOOLEAN
    Ignores host verification checks, use in development environments only.
    Control taskParameter CIAttributesDescription
    create wlp.Server_create

    delegate = shellScript, script = wlp/scripts/container/server-create

    Create the WebSphere Liberty Profile server if it does not exist.

    delete

    delegate = jythonScript, script = wlp/scripts/container/server-delete.py

    Delete the WebSphere Liberty Profile server directory.

    generateDefaultPluginConfig

    delegate = jythonScript, script = wlp/scripts/container/generate-plugin-config.py

    Generate plugin configuration

    reloadConfig

    delegate = jythonScript, script = wlp/scripts/container/server-reload-configuration.py

    Reload server.xml configuration

    start

    delegate = shellScript, script = wlp/scripts/container/server-start

    Start the WebSphere Liberty Profile server.

    status

    delegate = shellScript, script = wlp/scripts/container/server-status

    Status of the WebSphere Liberty Profile server.

    stop

    delegate = shellScript, script = wlp/scripts/container/server-stop

    Stop the WebSphere Liberty Profile server.


    wlp.Server_create

    Type Hierarchy udm.Parameters >> udm.BaseConfigurationItem

    Generated type for method create.

      Public properties
     
     
    template: STRING
    If set, server template name used to create this server.

    wlp.SpecialSubjectRole

    Type Hierarchy udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
    Interfaces udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

    Name of a special-subject possessing a security role.

      Parent
     
     
    container: CI<udm.EmbeddedDeployedContainer>
    The (embedded) deployed which contains this embedded deployed.
      Public properties
     
     
    subjectType: ENUM [EVERYONE, ALL_AUTHENTICATED_USERS]
    One of the following special subject types: ALL_AUTHENTICATED_USERS, EVERYONE.
     
     
    deployable: CI<udm.EmbeddedDeployable>
    The embedded deployable that this embedded deployed is derived from.
      Hidden properties
     
     
    propertyMapping: MAP_STRING_STRING = { id=name, type=subjectType }
    Property Mapping

    wlp.SpecialSubjectRoleSpec

    Type Hierarchy udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
    Interfaces udm.EmbeddedDeployable

    Name of a special-subject possessing a security role.

      Public properties
     
     
    subjectType: STRING
    One of the following special subject types: ALL_AUTHENTICATED_USERS, EVERYONE. (enum) values(EVERYONE, ALL_AUTHENTICATED_USERS)

    wlp.SybaseDataSource

    Type Hierarchy wlp.DataSource >> wlp.Resource >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    Defines Sybase data source configuration.

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    databaseName: STRING
    JDBC driver property: databaseName.
     
     
    jndiName: STRING
    JNDI name for a data source.
     
     
    beginTranForResultSetScrollingAPIs: BOOLEAN = true
    Attempt transaction enlistment when result set scrolling interfaces are used.
     
     
    beginTranForVendorAPIs: BOOLEAN = true
    Attempt transaction enlistment when vendor interfaces are used.
     
     
    commitOrRollbackOnCleanup: ENUM [commit, rollback]
    Determines how to clean up connections that might be in a database unit of work (AutoCommit=false) when the connection is closed or returned to the pool.
     
     
    connectionManagerRef: STRING
    Connection manager for a data source.
     
     
    connectionProperties: STRING
    JDBC driver property: connectionProperties. Server default value: SELECT_OPENS_CURSOR=true.
     
     
    connectionSharing: ENUM [MatchOriginalRequest, MatchCurrentState]
    Specifies how connections are matched for sharing. Default server value: MatchOriginalRequest.
     
     
    containerAuthDataRef: STRING
    Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER.
     
     
    customProperties: MAP_STRING_STRING
    Specifies additional custom datasource properties that you can configure for properties.sybase element.
     
     
    datasourceType: ENUM [javax.sql.XADataSource, javax.sql.ConnectionPoolDataSource, javax.sql.DataSource]
    Type of data source.
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    isolationLevel: ENUM [TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE, TRANSACTION_SNAPSHOT]
    Default transaction isolation level.
     
     
    jdbcDriverRef: STRING
    JDBC driver for a data source.
     
     
    loginTimeout: STRING
    JDBC driver property: loginTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
     
     
    networkProtocol: ENUM [socket, SSL]
    JDBC driver property: networkProtocol.
     
     
    password: STRING
    It is recommended to use a container managed authentication alias instead of configuring this property.
     
     
    portNumber: INTEGER
    Port on which to obtain database connections. Server default value: 5000.
     
     
    queryTimeout: STRING
    Default query timeout for SQL statements. In a JTA transaction, syncQueryTimeoutWithTransactionTimeout can override this default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
     
     
    recoveryAuthDataRef: STRING
    Authentication data for transaction recovery.
     
     
    resourceManagerName: STRING
    JDBC driver property: resourceManagerName.
     
     
    serverInitiatedTransactions: ENUM [true, false]
    JDBC driver property: SERVER_INITIATED_TRANSACTIONS. Server default value: false.
     
     
    serverName: STRING
    Server where the database is running. Server default value: localhost.
     
     
    statementCacheSize: INTEGER
    Maximum number of cached statements per connection.
     
     
    supplementalJDBCTrace: BOOLEAN
    Supplements the JDBC driver trace that is logged when JDBC driver trace is enabled in bootstrap.properties. JDBC driver trace specifications include: com.ibm.ws.database.logwriter, com.ibm.ws.db2.logwriter, com.ibm.ws.derby.logwriter, com.ibm.ws.informix.logwriter, com.ibm.ws.oracle.logwriter, com.ibm.ws.sqlserver.logwriter, com.ibm.ws.sybase.logwriter.
     
     
    syncQueryTimeoutWithTransactionTimeout: BOOLEAN
    Use the time remaining (if any) in a JTA transaction as the default query timeout for SQL statements.
     
     
    transactional: BOOLEAN = true
    Enable participation in transactions that are managed by the application server.
     
     
    user: STRING
    It is recommended to use a container managed authentication alias instead of configuring this property.
     
     
    version: INTEGER
    JDBC driver property: version.
      Hidden properties
     
     
    additionalPropertyMapping: MAP_STRING_STRING = { properties.sybase/databaseName=databaseName, properties.sybase/serverName=serverName, properties.sybase/portNumber=portNumber, properties.sybase/user=user, properties.sybase/password=password, properties.sybase/connectionProperties=connectionProperties, properties.sybase/loginTimout=loginTimeout, properties.sybase/networkProtocol=networkProtocol, properties.sybase/resourceManagerName=resourceManagerName, properties.sybase/SERVER_INITIATED_TRANSACTIONS=serverInitiatedTransactions, properties.sybase/version=version }
    Additional Property Mapping
     
     
    createOrder: INTEGER = 67
    Create Order
     
     
    customPropertiesElementName: STRING = properties.sybase
    Element name for custom properties.
     
     
    destroyOrder: INTEGER = 42
    Destroy Order
     
     
    propertyMapping: MAP_STRING_STRING = { id=name, jndiName=, jdbcDriverRef=, connectionManagerRef=, containerAuthDataRef=, recoveryAuthDataRef=, datasourceType=, connectionSharing=, isolationLevel=, statementCacheSize=, transactional=, beginTranForResultSetScrollingAPIs=, beginTranForVendorAPIs=, syncQueryTimeoutWithTransactionTimeout=, supplementalJDBCTrace=, commitOrRollbackOnCleanup=, queryTimeout= }
    Property Mapping
     
     
    propertyMappingElementName: STRING = dataSource
    Property Mapping Element Name
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.

    wlp.SybaseDataSourceSpec

    Type Hierarchy wlp.DataSourceSpec >> wlp.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.Deployable, udm.Taggable

    Defines Sybase data source configuration.

      Public properties
     
     
    beginTranForResultSetScrollingAPIs: STRING
    Attempt transaction enlistment when result set scrolling interfaces are used. (boolean) default(true)
     
     
    beginTranForVendorAPIs: STRING
    Attempt transaction enlistment when vendor interfaces are used. (boolean) default(true)
     
     
    commitOrRollbackOnCleanup: STRING
    Determines how to clean up connections that might be in a database unit of work (AutoCommit=false) when the connection is closed or returned to the pool. (enum) values(commit, rollback)
     
     
    connectionManagerRef: STRING
    Connection manager for a data source. (string)
     
     
    connectionProperties: STRING
    JDBC driver property: connectionProperties. Server default value: SELECT_OPENS_CURSOR=true. (string)
     
     
    connectionSharing: STRING
    Specifies how connections are matched for sharing. Default server value: MatchOriginalRequest. (enum) values(MatchOriginalRequest, MatchCurrentState)
     
     
    containerAuthDataRef: STRING
    Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER. (string)
     
     
    customProperties: MAP_STRING_STRING
    Specifies additional custom datasource properties that you can configure for properties.sybase element. (map_string_string)
     
     
    databaseName: STRING
    JDBC driver property: databaseName. (string)
     
     
    datasourceType: STRING
    Type of data source. (enum) values(javax.sql.XADataSource, javax.sql.ConnectionPoolDataSource, javax.sql.DataSource)
     
     
    isolationLevel: STRING
    Default transaction isolation level. (enum) values(TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE, TRANSACTION_SNAPSHOT)
     
     
    jdbcDriverRef: STRING
    JDBC driver for a data source. (string)
     
     
    jndiName: STRING
    JNDI name for a data source. (string)
     
     
    loginTimeout: STRING
    JDBC driver property: loginTimeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds. (string)
     
     
    networkProtocol: STRING
    JDBC driver property: networkProtocol. (enum) values(socket, SSL)
     
     
    password: STRING
    It is recommended to use a container managed authentication alias instead of configuring this property. (string)
     
     
    portNumber: STRING
    Port on which to obtain database connections. Server default value: 5000. (integer)
     
     
    queryTimeout: STRING
    Default query timeout for SQL statements. In a JTA transaction, syncQueryTimeoutWithTransactionTimeout can override this default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds. (string)
     
     
    recoveryAuthDataRef: STRING
    Authentication data for transaction recovery. (string)
     
     
    resourceManagerName: STRING
    JDBC driver property: resourceManagerName. (string)
     
     
    serverInitiatedTransactions: STRING
    JDBC driver property: SERVER_INITIATED_TRANSACTIONS. Server default value: false. (enum) values(true, false)
     
     
    serverName: STRING
    Server where the database is running. Server default value: localhost. (string)
     
     
    statementCacheSize: STRING
    Maximum number of cached statements per connection. (integer)
     
     
    supplementalJDBCTrace: STRING
    Supplements the JDBC driver trace that is logged when JDBC driver trace is enabled in bootstrap.properties. JDBC driver trace specifications include: com.ibm.ws.database.logwriter, com.ibm.ws.db2.logwriter, com.ibm.ws.derby.logwriter, com.ibm.ws.informix.logwriter, com.ibm.ws.oracle.logwriter, com.ibm.ws.sqlserver.logwriter, com.ibm.ws.sybase.logwriter. (boolean) default(false)
     
     
    syncQueryTimeoutWithTransactionTimeout: STRING
    Use the time remaining (if any) in a JTA transaction as the default query timeout for SQL statements. (boolean) default(false)
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
     
     
    transactional: STRING
    Enable participation in transactions that are managed by the application server. (boolean) default(true)
     
     
    user: STRING
    It is recommended to use a container managed authentication alias instead of configuring this property. (string)
     
     
    version: STRING
    JDBC driver property: version. (integer)
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    wlp.UserRole

    Type Hierarchy udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
    Interfaces udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

    A user possessing a security role.

      Parent
     
     
    container: CI<udm.EmbeddedDeployedContainer>
    The (embedded) deployed which contains this embedded deployed.
      Public properties
     
     
    userName: STRING
    Name of a user possessing a security role.
     
     
    accessId: STRING
    A user access ID in the general form user:realmName/userUniqueId. A value will be generated if one is not specified.
     
     
    deployable: CI<udm.EmbeddedDeployable>
    The embedded deployable that this embedded deployed is derived from.
      Hidden properties
     
     
    propertyMapping: MAP_STRING_STRING = { id=name, name=userName, access-id=accessId }
    Property Mapping

    wlp.UserRoleSpec

    Type Hierarchy udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
    Interfaces udm.EmbeddedDeployable

    A user possessing a security role.

      Public properties
     
     
    accessId: STRING
    A user access ID in the general form user:realmName/userUniqueId. A value will be generated if one is not specified. (string)
     
     
    userName: STRING
    Name of a user possessing a security role. (string)

    wlp.Variable

    Type Hierarchy wlp.Resource >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    Declare a new variable by specifying the name and value for the variable.

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    value: STRING
    The value to be assigned to the variable.
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
      Hidden properties
     
     
    createOrder: INTEGER = 62
    Create Order
     
     
    destroyOrder: INTEGER = 47
    Destroy Order
     
     
    propertyMapping: MAP_STRING_STRING = { id=name, name=, value= }
    Property Mapping
     
     
    propertyMappingElementName: STRING = variable
    Property Mapping Element Name
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.

    wlp.VariableSpec

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

    Declare a new variable by specifying the name and value for the variable.

      Public properties
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
     
     
    value: STRING
    The value to be assigned to the variable. (string)
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    wlp.WebApplication

    Type Hierarchy wlp.Application >> udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer

    Java EE WAR archive.

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Children
     
     
    applicationBindings: SET_OF_CI<wlp.ApplicationBnd>
    Binds general deployment information included in the application to specific resources.
     
     
    classloader: SET_OF_CI<wlp.Classloader>
    Defines the settings for an application classloader.
      Public properties
     
     
    location: STRING
    Location of an application expressed as an absolute path or a path relative to the server-level apps directory. Example: /opt/wlp/usr/servers/defaultServer/apps/{applicationName} or {applicationName}.
     
     
    restartStrategy: ENUM [NONE, STOP_START] = NONE
    Application restart strategy.
     
     
    autoStart: BOOLEAN = true
    Indicates whether or not the server should start the application automatically when the server starts.
     
     
    contextRoot: STRING
    Context root of an application.
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    placeholders: MAP_STRING_STRING
    A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
      Hidden properties
     
     
    propertyMapping: MAP_STRING_STRING = { id=name, name=, location=, autoStart=, type=archiveType, contextRoot=, classloader=, application-bnd=applicationBindings }
    Property Mapping
     
     
    propertyMappingElementName: STRING = webApplication
    Property Mapping Element Name
     
     
    archiveType: STRING = war
    Type of application archive.
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.
    Control taskParameter CIAttributesDescription
    start

    delegate = jythonScript, script = wlp/scripts/application/start-application.py

    Start application

    status

    delegate = jythonScript, script = wlp/scripts/application/check-application-status.py

    Status of the application

    stop

    delegate = jythonScript, script = wlp/scripts/application/stop-application.py

    Start application


    wlp.WebApplicationSpec

    Type Hierarchy jee.War >> 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

    Java EE WAR archive.

      Children
     
     
    applicationBindings: SET_OF_CI<wlp.ApplicationBndSpec>
    Binds general deployment information included in the application to specific resources.
     
     
    classloader: SET_OF_CI<wlp.ClassloaderSpec>
    Defines the settings for an application classloader.
      Public properties
     
     
    autoStart: STRING
    Indicates whether or not the server should start the application automatically when the server starts. (boolean) default(true)
     
     
    checksum: STRING
    The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
     
     
    contextRoot: STRING
    Context root of an application. (string)
     
     
    credentials: CI<credentials.Credentials>
    Credentials of the URI.
     
     
    excludeFileNamesRegex: STRING
    Regular expression that matches file names that must be excluded from scanning
     
     
    fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
    A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
     
     
    fileUri: STRING
    The URI pointing to the (remote) location of the file this artifact represents
     
     
    isRescanned: BOOLEAN
    Indicates if the artifact has been rescanned
     
     
    location: STRING
    Location of an application expressed as an absolute path or a path relative to the server-level apps directory. Example: /opt/wlp/usr/servers/defaultServer/apps/{applicationName} or {applicationName}. (string)
     
     
    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
     
     
    restartStrategy: STRING
    Application restart strategy. (enum) values(NONE, STOP_START) default(NONE)
     
     
    scanPlaceholders: BOOLEAN
    Whether to scan this artifact to replace placeholders when it is imported
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
      Hidden properties
     
     
    textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
    Regular expression that matches file names of text files
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.
     
     
    delimiters: STRING = {{ }}
    The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter

    wlp.WmqConnectionFactory

    Virtual Type
    Type Hierarchy wlp.JmsConnectionFactory >> wlp.Resource >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    Defines a Base WMQ connection factory configuration.

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    applicationName: STRING
    The name by which an application is registered with the queue manager.
     
     
    ccdtURL: STRING
    A URL that identifies the name and location of the file containing the client channel definition table (CCDT) and specifies how the file can be accessed.
     
     
    ccsid: STRING
    The coded character set identifier for a connection.
     
     
    channel: STRING
    The name of the MQI channel to use.
     
     
    clientId: STRING
    The client identifier for a connection.
     
     
    connectionManagerRef: STRING
    Connection manager for a connection factory.
     
     
    connectionNameList: STRING
    A list of TCP/IP connection names (hostname(port))used for communications. ConnectionNameList supersedes the hostname and port properties.
     
     
    containerAuthDataRef: STRING
    Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER.
     
     
    customProperties: MAP_STRING_STRING
    Specifies additional custom JMS connection factory properties that you can configure for properties.wmqJms element.
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    hostName: STRING
    The host name or IP address of the system on which the queue manager resides. The hostname and port properties are superseded by the ConnectionNameList property when it is specified.
     
     
    jndiName: STRING
    JNDI name for a resource.
     
     
    password: STRING
    The default password to use when creating a connection to the queue manager.
     
     
    port: INTEGER
    The port on which the queue manager listens. The hostname and port properties are superseded by the ConnectionNameList property when it is specified.
     
     
    providerVersion: STRING
    The version, release, modification level and fix pack of the queue manager to which the application intends to connect. Server default value: unspecified
     
     
    queueManager: STRING
    The name of the queue manager to connect to.
     
     
    recoveryAuthDataRef: STRING
    Authentication data for transaction recovery.
     
     
    transportType: ENUM [CLIENT, BINDINGS]
    Whether a connection to a queue manager uses client mode or bindings mode.
     
     
    userName: STRING
    The default user name to use when creating a connection to a queue manager.
      Hidden properties
     
     
    createOrder: INTEGER = 67
    Create Order
     
     
    customPropertiesElementName: STRING = properties.wmqJms
    Element name for custom properties.
     
     
    destroyOrder: INTEGER = 42
    Destroy Order
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.

    wlp.WmqConnectionFactorySpec

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

    Defines a Base WMQ connection factory configuration.

      Public properties
     
     
    applicationName: STRING
    The name by which an application is registered with the queue manager. (string)
     
     
    ccdtURL: STRING
    A URL that identifies the name and location of the file containing the client channel definition table (CCDT) and specifies how the file can be accessed. (string)
     
     
    ccsid: STRING
    The coded character set identifier for a connection. (string)
     
     
    channel: STRING
    The name of the MQI channel to use. (string)
     
     
    clientId: STRING
    The client identifier for a connection. (string)
     
     
    connectionManagerRef: STRING
    Connection manager for a connection factory. (string)
     
     
    connectionNameList: STRING
    A list of TCP/IP connection names (hostname(port))used for communications. ConnectionNameList supersedes the hostname and port properties. (string)
     
     
    containerAuthDataRef: STRING
    Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER. (string)
     
     
    customProperties: MAP_STRING_STRING
    Specifies additional custom JMS connection factory properties that you can configure for properties.wmqJms element. (map_string_string)
     
     
    hostName: STRING
    The host name or IP address of the system on which the queue manager resides. The hostname and port properties are superseded by the ConnectionNameList property when it is specified. (string)
     
     
    jndiName: STRING
    JNDI name for a resource. (string)
     
     
    password: STRING
    The default password to use when creating a connection to the queue manager. (string)
     
     
    port: STRING
    The port on which the queue manager listens. The hostname and port properties are superseded by the ConnectionNameList property when it is specified. (integer)
     
     
    providerVersion: STRING
    The version, release, modification level and fix pack of the queue manager to which the application intends to connect. Server default value: unspecified (string)
     
     
    queueManager: STRING
    The name of the queue manager to connect to. (string)
     
     
    recoveryAuthDataRef: STRING
    Authentication data for transaction recovery. (string)
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
     
     
    transportType: STRING
    Whether a connection to a queue manager uses client mode or bindings mode. (enum) values(CLIENT, BINDINGS)
     
     
    userName: STRING
    The default user name to use when creating a connection to a queue manager. (string)
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    wlp.WmqDestination

    Virtual Type
    Type Hierarchy wlp.JmsResource >> wlp.Resource >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    Defines a WMQ JMS specific configuration.

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    arbitraryProperties: STRING
    Ability to specify properties not defined elsewhere
     
     
    ccsid: STRING
    The coded character set ID to be used for a connection or destination. Server default value: 1208
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    encoding: STRING
    How numeric data in the body of a message is represented when the message is sent to this destination. The property specifies the representation of binary integers, packed decimal integers, and floating point numbers. Server default value: NATIVE
     
     
    expiry: STRING
    The period after which messages at a destination expire. Server default value: APP
     
     
    failIfQuiesce: STRING
    Whether calls to certain methods fail if the queue manager is in a quiescing state. Server default value: true
     
     
    jndiName: STRING
    JNDI name for a resource.
     
     
    persistence: ENUM [APP, QDEF, PERS, NON, HIGH]
    The persistence of messages sent to a destination. Server default value: APP
     
     
    priority: STRING
    The priority for messages sent to a destination. Server default value: APP
     
     
    putAsyncAllowed: ENUM [DESTINATION, DISABLED, ENABLED]
    Whether message producers are allowed to use asynchronous puts to send messages to this destination. Server default value: DESTINATION
     
     
    readAheadAllowed: ENUM [DESTINATION, DISABLED, ENABLED]
    Whether the MDB is allowed to use read ahead to get nonpersistent messages from the destination into an internal buffer before receiving them. Server default value: DESTINATION
     
     
    readAheadClosePolicy: ENUM [ALL, CURRENT]
    What happens to messages in the internal read ahead buffer when the MDB is stopped by the administrator. Server default value: ALL
     
     
    receiveCcsid: STRING
    Destination property that sets the target Coded character set identifier for queue manager message conversion. The value is ignored unless receiveConversion is set to QMGR.
     
     
    receiveConversion: STRING
    Destination property that determines if data conversion is going to be performed by the queue manager. Server default value: CLIENT_MSG
     
     
    targetClient: ENUM [JMS, MQ]
    Whether the WebSphere MQ RFH2 format is used to exchange information with target applications. Server default value: JMS
      Hidden properties
     
     
    createOrder: INTEGER = 60
    Create Order
     
     
    destroyOrder: INTEGER = 40
    Destroy Order
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.

    wlp.WmqDestinationSpec

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

    Defines a WMQ JMS specific configuration.

      Public properties
     
     
    arbitraryProperties: STRING
    Ability to specify properties not defined elsewhere (string)
     
     
    ccsid: STRING
    The coded character set ID to be used for a connection or destination. Server default value: 1208 (string)
     
     
    encoding: STRING
    How numeric data in the body of a message is represented when the message is sent to this destination. The property specifies the representation of binary integers, packed decimal integers, and floating point numbers. Server default value: NATIVE (string)
     
     
    expiry: STRING
    The period after which messages at a destination expire. Server default value: APP (string)
     
     
    failIfQuiesce: STRING
    Whether calls to certain methods fail if the queue manager is in a quiescing state. Server default value: true (string)
     
     
    jndiName: STRING
    JNDI name for a resource. (string)
     
     
    persistence: STRING
    The persistence of messages sent to a destination. Server default value: APP (enum) values(APP, QDEF, PERS, NON, HIGH)
     
     
    priority: STRING
    The priority for messages sent to a destination. Server default value: APP (string)
     
     
    putAsyncAllowed: STRING
    Whether message producers are allowed to use asynchronous puts to send messages to this destination. Server default value: DESTINATION (enum) values(DESTINATION, DISABLED, ENABLED)
     
     
    readAheadAllowed: STRING
    Whether the MDB is allowed to use read ahead to get nonpersistent messages from the destination into an internal buffer before receiving them. Server default value: DESTINATION (enum) values(DESTINATION, DISABLED, ENABLED)
     
     
    readAheadClosePolicy: STRING
    What happens to messages in the internal read ahead buffer when the MDB is stopped by the administrator. Server default value: ALL (enum) values(ALL, CURRENT)
     
     
    receiveCcsid: STRING
    Destination property that sets the target Coded character set identifier for queue manager message conversion. The value is ignored unless receiveConversion is set to QMGR. (string)
     
     
    receiveConversion: STRING
    Destination property that determines if data conversion is going to be performed by the queue manager. Server default value: CLIENT_MSG (string)
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
     
     
    targetClient: STRING
    Whether the WebSphere MQ RFH2 format is used to exchange information with target applications. Server default value: JMS (enum) values(JMS, MQ)
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    wlp.WmqJmsClient

    Type Hierarchy wlp.Resource >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    WebSphere MQ messaging.

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    connectionConcurrency: INTEGER
    The maximum number of MDBs that can be supplied by each connection. Server default value: 1
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    logWriterEnabled: BOOLEAN = true
    A flag to enable or disable the sending of a diagnostic trace to a LogWriter object provided by the application server. Server default value: true
     
     
    maxConnections: INTEGER
    The maximum number of connections to a WebSphere MQ queue manager. Server default value: 50
     
     
    nativeLibraryPath: STRING
    Absolute path to the location of the WebSphere MQ Java JNI library (mqjbnd.dll or equivalent).
     
     
    reconnectionRetryCount: INTEGER
    The maximum number of attempts made to reconnect to a WebSphere MQ queue manager if a connection fails. Server default value: 5
     
     
    reconnectionRetryInterval: INTEGER
    The time, in milliseconds, that the WebSphere MQ feature waits before making another attempt to reconnect to a WebSphere MQ queue manager. Server default value: 300000
     
     
    startupRetryCount: INTEGER
    Number of times to retry creating a connection on startup. Server default value: 0
     
     
    startupRetryInterval: INTEGER
    The time to wait, in milliseconds, between each retry attempt when connecting on startup. Server default value: 30000
      Hidden properties
     
     
    createOrder: INTEGER = 65
    Create Order
     
     
    destroyOrder: INTEGER = 44
    Destroy Order
     
     
    propertyMapping: MAP_STRING_STRING = { id=name, connectionConcurrency=, logWriterEnabled=, maxConnections=, nativeLibraryPath=, reconnectionRetryCount=, reconnectionRetryInterval=, startupRetryCount=, startupRetryInterval= }
    Property Mapping
     
     
    propertyMappingElementName: STRING = wmqJmsClient
    Property Mapping Element Name
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.

    wlp.WmqJmsClientSpec

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

    WebSphere MQ messaging.

      Public properties
     
     
    connectionConcurrency: STRING
    The maximum number of MDBs that can be supplied by each connection. Server default value: 1 (integer)
     
     
    logWriterEnabled: STRING
    A flag to enable or disable the sending of a diagnostic trace to a LogWriter object provided by the application server. Server default value: true (boolean) default(true)
     
     
    maxConnections: STRING
    The maximum number of connections to a WebSphere MQ queue manager. Server default value: 50 (integer)
     
     
    nativeLibraryPath: STRING
    Absolute path to the location of the WebSphere MQ Java JNI library (mqjbnd.dll or equivalent). (string)
     
     
    reconnectionRetryCount: STRING
    The maximum number of attempts made to reconnect to a WebSphere MQ queue manager if a connection fails. Server default value: 5 (integer)
     
     
    reconnectionRetryInterval: STRING
    The time, in milliseconds, that the WebSphere MQ feature waits before making another attempt to reconnect to a WebSphere MQ queue manager. Server default value: 300000 (integer)
     
     
    startupRetryCount: STRING
    Number of times to retry creating a connection on startup. Server default value: 0 (integer)
     
     
    startupRetryInterval: STRING
    The time to wait, in milliseconds, between each retry attempt when connecting on startup. Server default value: 30000 (integer)
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    wlp.WmqQueue

    Type Hierarchy wlp.WmqDestination >> wlp.JmsResource >> wlp.Resource >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    Defines a JMS queue configuration.

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    arbitraryProperties: STRING
    Ability to specify properties not defined elsewhere
     
     
    baseQueueManagerName: STRING
    Queue Manager name that has this queue defined on it
     
     
    baseQueueName: STRING
    Name of the Queue on the Queue Manager
     
     
    ccsid: STRING
    The coded character set ID to be used for a connection or destination. Server default value: 1208
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    encoding: STRING
    How numeric data in the body of a message is represented when the message is sent to this destination. The property specifies the representation of binary integers, packed decimal integers, and floating point numbers. Server default value: NATIVE
     
     
    expiry: STRING
    The period after which messages at a destination expire. Server default value: APP
     
     
    failIfQuiesce: STRING
    Whether calls to certain methods fail if the queue manager is in a quiescing state. Server default value: true
     
     
    jndiName: STRING
    JNDI name for a resource.
     
     
    persistence: ENUM [APP, QDEF, PERS, NON, HIGH]
    The persistence of messages sent to a destination. Server default value: APP
     
     
    priority: STRING
    The priority for messages sent to a destination. Server default value: APP
     
     
    putAsyncAllowed: ENUM [DESTINATION, DISABLED, ENABLED]
    Whether message producers are allowed to use asynchronous puts to send messages to this destination. Server default value: DESTINATION
     
     
    readAheadAllowed: ENUM [DESTINATION, DISABLED, ENABLED]
    Whether the MDB is allowed to use read ahead to get nonpersistent messages from the destination into an internal buffer before receiving them. Server default value: DESTINATION
     
     
    readAheadClosePolicy: ENUM [ALL, CURRENT]
    What happens to messages in the internal read ahead buffer when the MDB is stopped by the administrator. Server default value: ALL
     
     
    receiveCcsid: STRING
    Destination property that sets the target Coded character set identifier for queue manager message conversion. The value is ignored unless receiveConversion is set to QMGR.
     
     
    receiveConversion: STRING
    Destination property that determines if data conversion is going to be performed by the queue manager. Server default value: CLIENT_MSG
     
     
    targetClient: ENUM [JMS, MQ]
    Whether the WebSphere MQ RFH2 format is used to exchange information with target applications. Server default value: JMS
      Hidden properties
     
     
    createOrder: INTEGER = 68
    Create Order
     
     
    destroyOrder: INTEGER = 41
    Destroy Order
     
     
    propertyMapping: MAP_STRING_STRING = { id=name, jndiName=, properties.wmqJms/baseQueueManagerName=baseQueueManagerName, properties.wmqJms/baseQueueName=baseQueueName, properties.wmqJms/CCSID=ccsid, properties.wmqJms/encoding=encoding, properties.wmqJms/expiry=expiry, properties.wmqJms/failIfQuiesce=failIfQuiesce, properties.wmqJms/persistence=persistence, properties.wmqJms/priority=priority, properties.wmqJms/putAsyncAllowed=putAsyncAllowed, properties.wmqJms/readAheadAllowed=readAheadAllowed, properties.wmqJms/readAheadClosePolicy=readAheadClosePolicy, properties.wmqJms/receiveCCSID=receiveCcsid, properties.wmqJms/receiveConversion=receiveConversion, properties.wmqJms/targetClient=targetClient, properties.wmqJms/arbitraryProperties=arbitraryProperties }
    Property Mapping
     
     
    propertyMappingElementName: STRING = jmsQueue
    Property Mapping Element Name
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.

    wlp.WmqQueueConnectionFactory

    Type Hierarchy wlp.WmqConnectionFactory >> wlp.JmsConnectionFactory >> wlp.Resource >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    Defines a JMS queue connection factory configuration.

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    applicationName: STRING
    The name by which an application is registered with the queue manager.
     
     
    ccdtURL: STRING
    A URL that identifies the name and location of the file containing the client channel definition table (CCDT) and specifies how the file can be accessed.
     
     
    ccsid: STRING
    The coded character set identifier for a connection.
     
     
    channel: STRING
    The name of the MQI channel to use.
     
     
    clientId: STRING
    The client identifier for a connection.
     
     
    connectionManagerRef: STRING
    Connection manager for a connection factory.
     
     
    connectionNameList: STRING
    A list of TCP/IP connection names (hostname(port))used for communications. ConnectionNameList supersedes the hostname and port properties.
     
     
    containerAuthDataRef: STRING
    Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER.
     
     
    customProperties: MAP_STRING_STRING
    Specifies additional custom JMS connection factory properties that you can configure for properties.wmqJms element.
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    hostName: STRING
    The host name or IP address of the system on which the queue manager resides. The hostname and port properties are superseded by the ConnectionNameList property when it is specified.
     
     
    jndiName: STRING
    JNDI name for a resource.
     
     
    password: STRING
    The default password to use when creating a connection to the queue manager.
     
     
    port: INTEGER
    The port on which the queue manager listens. The hostname and port properties are superseded by the ConnectionNameList property when it is specified.
     
     
    providerVersion: STRING
    The version, release, modification level and fix pack of the queue manager to which the application intends to connect. Server default value: unspecified
     
     
    queueManager: STRING
    The name of the queue manager to connect to.
     
     
    recoveryAuthDataRef: STRING
    Authentication data for transaction recovery.
     
     
    transportType: ENUM [CLIENT, BINDINGS]
    Whether a connection to a queue manager uses client mode or bindings mode.
     
     
    userName: STRING
    The default user name to use when creating a connection to a queue manager.
      Hidden properties
     
     
    createOrder: INTEGER = 67
    Create Order
     
     
    customPropertiesElementName: STRING = properties.wmqJms
    Element name for custom properties.
     
     
    destroyOrder: INTEGER = 42
    Destroy Order
     
     
    propertyMapping: MAP_STRING_STRING = { id=name, jndiName=, connectionManagerRef=, containerAuthDataRef=, recoveryAuthDataRef=, properties.wmqJms/applicationName=applicationName, properties.wmqJms/channel=channel, properties.wmqJms/hostName=hostName, properties.wmqJms/port=port, properties.wmqJms/queueManager=queueManager, properties.wmqJms/userName=userName, properties.wmqJms/password=password, properties.wmqJms/transportType=transportType, properties.wmqJms/ccdtURL=ccdtURL, properties.wmqJms/CCSID=ccsid, properties.wmqJms/clientId=clientId, properties.wmqJms/connectionNameList=connectionNameList, properties.wmqJms/providerVersion=providerVersion }
    Property Mapping
     
     
    propertyMappingElementName: STRING = jmsQueueConnectionFactory
    Property Mapping Element Name
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.

    wlp.WmqQueueConnectionFactorySpec

    Type Hierarchy wlp.WmqConnectionFactorySpec >> wlp.JmsConnectionFactorySpec >> wlp.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.Deployable, udm.Taggable

    Defines a JMS queue connection factory configuration.

      Public properties
     
     
    applicationName: STRING
    The name by which an application is registered with the queue manager. (string)
     
     
    ccdtURL: STRING
    A URL that identifies the name and location of the file containing the client channel definition table (CCDT) and specifies how the file can be accessed. (string)
     
     
    ccsid: STRING
    The coded character set identifier for a connection. (string)
     
     
    channel: STRING
    The name of the MQI channel to use. (string)
     
     
    clientId: STRING
    The client identifier for a connection. (string)
     
     
    connectionManagerRef: STRING
    Connection manager for a connection factory. (string)
     
     
    connectionNameList: STRING
    A list of TCP/IP connection names (hostname(port))used for communications. ConnectionNameList supersedes the hostname and port properties. (string)
     
     
    containerAuthDataRef: STRING
    Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER. (string)
     
     
    customProperties: MAP_STRING_STRING
    Specifies additional custom JMS connection factory properties that you can configure for properties.wmqJms element. (map_string_string)
     
     
    hostName: STRING
    The host name or IP address of the system on which the queue manager resides. The hostname and port properties are superseded by the ConnectionNameList property when it is specified. (string)
     
     
    jndiName: STRING
    JNDI name for a resource. (string)
     
     
    password: STRING
    The default password to use when creating a connection to the queue manager. (string)
     
     
    port: STRING
    The port on which the queue manager listens. The hostname and port properties are superseded by the ConnectionNameList property when it is specified. (integer)
     
     
    providerVersion: STRING
    The version, release, modification level and fix pack of the queue manager to which the application intends to connect. Server default value: unspecified (string)
     
     
    queueManager: STRING
    The name of the queue manager to connect to. (string)
     
     
    recoveryAuthDataRef: STRING
    Authentication data for transaction recovery. (string)
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
     
     
    transportType: STRING
    Whether a connection to a queue manager uses client mode or bindings mode. (enum) values(CLIENT, BINDINGS)
     
     
    userName: STRING
    The default user name to use when creating a connection to a queue manager. (string)
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    wlp.WmqQueueSpec

    Type Hierarchy wlp.WmqDestinationSpec >> wlp.JmsResourceSpec >> wlp.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.Deployable, udm.Taggable

    Defines a JMS queue configuration.

      Public properties
     
     
    arbitraryProperties: STRING
    Ability to specify properties not defined elsewhere (string)
     
     
    baseQueueManagerName: STRING
    Queue Manager name that has this queue defined on it (string)
     
     
    baseQueueName: STRING
    Name of the Queue on the Queue Manager (string)
     
     
    ccsid: STRING
    The coded character set ID to be used for a connection or destination. Server default value: 1208 (string)
     
     
    encoding: STRING
    How numeric data in the body of a message is represented when the message is sent to this destination. The property specifies the representation of binary integers, packed decimal integers, and floating point numbers. Server default value: NATIVE (string)
     
     
    expiry: STRING
    The period after which messages at a destination expire. Server default value: APP (string)
     
     
    failIfQuiesce: STRING
    Whether calls to certain methods fail if the queue manager is in a quiescing state. Server default value: true (string)
     
     
    jndiName: STRING
    JNDI name for a resource. (string)
     
     
    persistence: STRING
    The persistence of messages sent to a destination. Server default value: APP (enum) values(APP, QDEF, PERS, NON, HIGH)
     
     
    priority: STRING
    The priority for messages sent to a destination. Server default value: APP (string)
     
     
    putAsyncAllowed: STRING
    Whether message producers are allowed to use asynchronous puts to send messages to this destination. Server default value: DESTINATION (enum) values(DESTINATION, DISABLED, ENABLED)
     
     
    readAheadAllowed: STRING
    Whether the MDB is allowed to use read ahead to get nonpersistent messages from the destination into an internal buffer before receiving them. Server default value: DESTINATION (enum) values(DESTINATION, DISABLED, ENABLED)
     
     
    readAheadClosePolicy: STRING
    What happens to messages in the internal read ahead buffer when the MDB is stopped by the administrator. Server default value: ALL (enum) values(ALL, CURRENT)
     
     
    receiveCcsid: STRING
    Destination property that sets the target Coded character set identifier for queue manager message conversion. The value is ignored unless receiveConversion is set to QMGR. (string)
     
     
    receiveConversion: STRING
    Destination property that determines if data conversion is going to be performed by the queue manager. Server default value: CLIENT_MSG (string)
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
     
     
    targetClient: STRING
    Whether the WebSphere MQ RFH2 format is used to exchange information with target applications. Server default value: JMS (enum) values(JMS, MQ)
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    wlp.WmqTopic

    Type Hierarchy wlp.WmqDestination >> wlp.JmsResource >> wlp.Resource >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    Defines a JMS topic configuration

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    arbitraryProperties: STRING
    Ability to specify properties not defined elsewhere
     
     
    baseTopicName: STRING
    Topic string to open
     
     
    brokerCCDurSubQueue: STRING
    The name of the queue from which non-durable subscription messages are retrieved for a connection consumer. Server default value: SYSTEM.JMS.D.CC.SUBSCRIBER.QUEUE
     
     
    brokerDurSubQueue: STRING
    The name of the queue from which durable subscription messages are retrieved.Server default value: SYSTEM.JMS.D.SUBSCRIBER.QUEUE
     
     
    brokerPubQueue: STRING
    The name of the queue where published messages are sent (the stream queue)
     
     
    brokerPubQueueManager: STRING
    The name of the queue manager that owns the queue where messages published on the topic are sent
     
     
    brokerVersion: ENUM [UNSPECIFIED, V1, V2]
    The version of the broker being used.Server default value: V1
     
     
    ccsid: STRING
    The coded character set ID to be used for a connection or destination. Server default value: 1208
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    encoding: STRING
    How numeric data in the body of a message is represented when the message is sent to this destination. The property specifies the representation of binary integers, packed decimal integers, and floating point numbers. Server default value: NATIVE
     
     
    expiry: STRING
    The period after which messages at a destination expire. Server default value: APP
     
     
    failIfQuiesce: STRING
    Whether calls to certain methods fail if the queue manager is in a quiescing state. Server default value: true
     
     
    jndiName: STRING
    JNDI name for a resource.
     
     
    persistence: ENUM [APP, QDEF, PERS, NON, HIGH]
    The persistence of messages sent to a destination. Server default value: APP
     
     
    priority: STRING
    The priority for messages sent to a destination. Server default value: APP
     
     
    putAsyncAllowed: ENUM [DESTINATION, DISABLED, ENABLED]
    Whether message producers are allowed to use asynchronous puts to send messages to this destination. Server default value: DESTINATION
     
     
    readAheadAllowed: ENUM [DESTINATION, DISABLED, ENABLED]
    Whether the MDB is allowed to use read ahead to get nonpersistent messages from the destination into an internal buffer before receiving them. Server default value: DESTINATION
     
     
    readAheadClosePolicy: ENUM [ALL, CURRENT]
    What happens to messages in the internal read ahead buffer when the MDB is stopped by the administrator. Server default value: ALL
     
     
    receiveCcsid: STRING
    Destination property that sets the target Coded character set identifier for queue manager message conversion. The value is ignored unless receiveConversion is set to QMGR.
     
     
    receiveConversion: STRING
    Destination property that determines if data conversion is going to be performed by the queue manager. Server default value: CLIENT_MSG
     
     
    targetClient: ENUM [JMS, MQ]
    Whether the WebSphere MQ RFH2 format is used to exchange information with target applications. Server default value: JMS
      Hidden properties
     
     
    createOrder: INTEGER = 68
    Create Order
     
     
    destroyOrder: INTEGER = 41
    Destroy Order
     
     
    propertyMapping: MAP_STRING_STRING = { id=name, jndiName=, properties.wmqJms/baseTopicName=baseTopicName, properties.wmqJms/brokerCCDurSubQueue=brokerCCDurSubQueue, properties.wmqJms/brokerDurSubQueue=brokerDurSubQueue, properties.wmqJms/brokerPubQueue=brokerPubQueue, properties.wmqJms/brokerPubQueueManager=brokerPubQueueManager, properties.wmqJms/brokerVersion=brokerVersion, properties.wmqJms/CCSID=ccsid, properties.wmqJms/encoding=encoding, properties.wmqJms/expiry=expiry, properties.wmqJms/failIfQuiesce=failIfQuiesce, properties.wmqJms/persistence=persistence, properties.wmqJms/priority=priority, properties.wmqJms/putAsyncAllowed=putAsyncAllowed, properties.wmqJms/readAheadAllowed=readAheadAllowed, properties.wmqJms/readAheadClosePolicy=readAheadClosePolicy, properties.wmqJms/receiveCCSID=receiveCcsid, properties.wmqJms/receiveConversion=receiveConversion, properties.wmqJms/targetClient=targetClient, properties.wmqJms/arbitraryProperties=arbitraryProperties }
    Property Mapping
     
     
    propertyMappingElementName: STRING = jmsTopic
    Property Mapping Element Name
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.

    wlp.WmqTopicConnectionFactory

    Type Hierarchy wlp.WmqConnectionFactory >> wlp.JmsConnectionFactory >> wlp.Resource >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.Deployed, udm.EmbeddedDeployedContainer

    Defines a JMS topic connection factory configuration

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    applicationName: STRING
    The name by which an application is registered with the queue manager.
     
     
    brokerCCSubQueue: STRING
    The name of the queue from which a connection consumer receives nondurable subscription messages
     
     
    brokerControlQueue: STRING
    The name of the broker control queue
     
     
    brokerPubQueue: STRING
    The name of the queue where published messages are sent (the stream queue).
     
     
    brokerQueueManager: STRING
    The name of the queue manager on which the broker is running
     
     
    brokerSubQueue: STRING
    The name of the queue from which a nondurable message consumer receives messages
     
     
    brokerVersion: ENUM [UNSPECIFIED, V1, V2]
    The version of the broker being used
     
     
    ccdtURL: STRING
    A URL that identifies the name and location of the file containing the client channel definition table (CCDT) and specifies how the file can be accessed.
     
     
    ccsid: STRING
    The coded character set identifier for a connection.
     
     
    channel: STRING
    The name of the MQI channel to use.
     
     
    clientId: STRING
    The client identifier for a connection.
     
     
    connectionManagerRef: STRING
    Connection manager for a connection factory.
     
     
    connectionNameList: STRING
    A list of TCP/IP connection names (hostname(port))used for communications. ConnectionNameList supersedes the hostname and port properties.
     
     
    containerAuthDataRef: STRING
    Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER.
     
     
    customProperties: MAP_STRING_STRING
    Specifies additional custom JMS connection factory properties that you can configure for properties.wmqJms element.
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    hostName: STRING
    The host name or IP address of the system on which the queue manager resides. The hostname and port properties are superseded by the ConnectionNameList property when it is specified.
     
     
    jndiName: STRING
    JNDI name for a resource.
     
     
    password: STRING
    The default password to use when creating a connection to the queue manager.
     
     
    port: INTEGER
    The port on which the queue manager listens. The hostname and port properties are superseded by the ConnectionNameList property when it is specified.
     
     
    providerVersion: STRING
    The version, release, modification level and fix pack of the queue manager to which the application intends to connect. Server default value: unspecified
     
     
    queueManager: STRING
    The name of the queue manager to connect to.
     
     
    recoveryAuthDataRef: STRING
    Authentication data for transaction recovery.
     
     
    transportType: ENUM [CLIENT, BINDINGS]
    Whether a connection to a queue manager uses client mode or bindings mode.
     
     
    userName: STRING
    The default user name to use when creating a connection to a queue manager.
      Hidden properties
     
     
    createOrder: INTEGER = 67
    Create Order
     
     
    customPropertiesElementName: STRING = properties.wmqJms
    Element name for custom properties.
     
     
    destroyOrder: INTEGER = 42
    Destroy Order
     
     
    propertyMapping: MAP_STRING_STRING = { id=name, jndiName=, connectionManagerRef=, containerAuthDataRef=, recoveryAuthDataRef=, properties.wmqJms/applicationName=applicationName, properties.wmqJms/channel=channel, properties.wmqJms/hostName=hostName, properties.wmqJms/port=port, properties.wmqJms/queueManager=queueManager, properties.wmqJms/userName=userName, properties.wmqJms/password=password, properties.wmqJms/transportType=transportType, properties.wmqJms/ccdtURL=ccdtURL, properties.wmqJms/CCSID=ccsid, properties.wmqJms/clientId=clientId, properties.wmqJms/connectionNameList=connectionNameList, properties.wmqJms/providerVersion=providerVersion, properties.wmqJms/brokerCCSubQueue=brokerCCSubQueue, properties.wmqJms/brokerControlQueue=brokerControlQueue, properties.wmqJms/brokerPubQueue=brokerPubQueue, properties.wmqJms/brokerQueueManager=brokerQueueManager, properties.wmqJms/brokerSubQueue=brokerSubQueue, properties.wmqJms/brokerVersion=brokerVersion }
    Property Mapping
     
     
    propertyMappingElementName: STRING = jmsTopicConnectionFactory
    Property Mapping Element Name
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.

    wlp.WmqTopicConnectionFactorySpec

    Type Hierarchy wlp.WmqConnectionFactorySpec >> wlp.JmsConnectionFactorySpec >> wlp.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.Deployable, udm.Taggable

    Defines a JMS topic connection factory configuration

      Public properties
     
     
    applicationName: STRING
    The name by which an application is registered with the queue manager. (string)
     
     
    brokerCCSubQueue: STRING
    The name of the queue from which a connection consumer receives nondurable subscription messages (string)
     
     
    brokerControlQueue: STRING
    The name of the broker control queue (string)
     
     
    brokerPubQueue: STRING
    The name of the queue where published messages are sent (the stream queue). (string)
     
     
    brokerQueueManager: STRING
    The name of the queue manager on which the broker is running (string)
     
     
    brokerSubQueue: STRING
    The name of the queue from which a nondurable message consumer receives messages (string)
     
     
    brokerVersion: STRING
    The version of the broker being used (enum) values(UNSPECIFIED, V1, V2)
     
     
    ccdtURL: STRING
    A URL that identifies the name and location of the file containing the client channel definition table (CCDT) and specifies how the file can be accessed. (string)
     
     
    ccsid: STRING
    The coded character set identifier for a connection. (string)
     
     
    channel: STRING
    The name of the MQI channel to use. (string)
     
     
    clientId: STRING
    The client identifier for a connection. (string)
     
     
    connectionManagerRef: STRING
    Connection manager for a connection factory. (string)
     
     
    connectionNameList: STRING
    A list of TCP/IP connection names (hostname(port))used for communications. ConnectionNameList supersedes the hostname and port properties. (string)
     
     
    containerAuthDataRef: STRING
    Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER. (string)
     
     
    customProperties: MAP_STRING_STRING
    Specifies additional custom JMS connection factory properties that you can configure for properties.wmqJms element. (map_string_string)
     
     
    hostName: STRING
    The host name or IP address of the system on which the queue manager resides. The hostname and port properties are superseded by the ConnectionNameList property when it is specified. (string)
     
     
    jndiName: STRING
    JNDI name for a resource. (string)
     
     
    password: STRING
    The default password to use when creating a connection to the queue manager. (string)
     
     
    port: STRING
    The port on which the queue manager listens. The hostname and port properties are superseded by the ConnectionNameList property when it is specified. (integer)
     
     
    providerVersion: STRING
    The version, release, modification level and fix pack of the queue manager to which the application intends to connect. Server default value: unspecified (string)
     
     
    queueManager: STRING
    The name of the queue manager to connect to. (string)
     
     
    recoveryAuthDataRef: STRING
    Authentication data for transaction recovery. (string)
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
     
     
    transportType: STRING
    Whether a connection to a queue manager uses client mode or bindings mode. (enum) values(CLIENT, BINDINGS)
     
     
    userName: STRING
    The default user name to use when creating a connection to a queue manager. (string)
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.

    wlp.WmqTopicSpec

    Type Hierarchy wlp.WmqDestinationSpec >> wlp.JmsResourceSpec >> wlp.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.Deployable, udm.Taggable

    Defines a JMS topic configuration

      Public properties
     
     
    arbitraryProperties: STRING
    Ability to specify properties not defined elsewhere (string)
     
     
    baseTopicName: STRING
    Topic string to open (string)
     
     
    brokerCCDurSubQueue: STRING
    The name of the queue from which non-durable subscription messages are retrieved for a connection consumer. Server default value: SYSTEM.JMS.D.CC.SUBSCRIBER.QUEUE (string)
     
     
    brokerDurSubQueue: STRING
    The name of the queue from which durable subscription messages are retrieved.Server default value: SYSTEM.JMS.D.SUBSCRIBER.QUEUE (string)
     
     
    brokerPubQueue: STRING
    The name of the queue where published messages are sent (the stream queue) (string)
     
     
    brokerPubQueueManager: STRING
    The name of the queue manager that owns the queue where messages published on the topic are sent (string)
     
     
    brokerVersion: STRING
    The version of the broker being used.Server default value: V1 (enum) values(UNSPECIFIED, V1, V2)
     
     
    ccsid: STRING
    The coded character set ID to be used for a connection or destination. Server default value: 1208 (string)
     
     
    encoding: STRING
    How numeric data in the body of a message is represented when the message is sent to this destination. The property specifies the representation of binary integers, packed decimal integers, and floating point numbers. Server default value: NATIVE (string)
     
     
    expiry: STRING
    The period after which messages at a destination expire. Server default value: APP (string)
     
     
    failIfQuiesce: STRING
    Whether calls to certain methods fail if the queue manager is in a quiescing state. Server default value: true (string)
     
     
    jndiName: STRING
    JNDI name for a resource. (string)
     
     
    persistence: STRING
    The persistence of messages sent to a destination. Server default value: APP (enum) values(APP, QDEF, PERS, NON, HIGH)
     
     
    priority: STRING
    The priority for messages sent to a destination. Server default value: APP (string)
     
     
    putAsyncAllowed: STRING
    Whether message producers are allowed to use asynchronous puts to send messages to this destination. Server default value: DESTINATION (enum) values(DESTINATION, DISABLED, ENABLED)
     
     
    readAheadAllowed: STRING
    Whether the MDB is allowed to use read ahead to get nonpersistent messages from the destination into an internal buffer before receiving them. Server default value: DESTINATION (enum) values(DESTINATION, DISABLED, ENABLED)
     
     
    readAheadClosePolicy: STRING
    What happens to messages in the internal read ahead buffer when the MDB is stopped by the administrator. Server default value: ALL (enum) values(ALL, CURRENT)
     
     
    receiveCcsid: STRING
    Destination property that sets the target Coded character set identifier for queue manager message conversion. The value is ignored unless receiveConversion is set to QMGR. (string)
     
     
    receiveConversion: STRING
    Destination property that determines if data conversion is going to be performed by the queue manager. Server default value: CLIENT_MSG (string)
     
     
    tags: SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
     
     
    targetClient: STRING
    Whether the WebSphere MQ RFH2 format is used to exchange information with target applications. Server default value: JMS (enum) values(JMS, MQ)
      Hidden properties
     
     
    boundTemplates: SET_OF_CI<udm.Template>
    The set of CI templates.