The following sections describe the data models on which the REST resources operate. These data models describe the information exchanged in REST resources.
The descriptions of these data models in this section include a description of the constraints that apply to each data field.
Specifies that this value is encrypted and will not be returned by a GET method. It may be specified in a POST for update.
Specifies that the contents of this field can be written once, during creation, and may not be modified thereafter.
Specifies that a value must be specified for this field.
Specifies that this value may be read by a GET, but is ignored during a POST.
The Application entity includes configuration and monitoring information for an application deployment.
Note that an Application entity includes all the Deployment properties in addition to the following properties.
The properties of the Application entity are as follows:
The application type: ear, war, ejb, or gar
Type: string
Constraints: Read Only
The archive version (from the deployment manifest file).
Type: string
Constraints: Read Only
The runtime information for all EJBs in this application.
Type: array
Constraints: Read Only
The health of this application, if running. This health status is aggregated across all of the servers running this application and will denote the most severe health condition encountered.
Type: Health
Constraints: Read Only
The maximum total number of open sessions in this server. The count starts at zero each time the server is activated. Note that this is an optimization method for a highly useful statistic that could be implemented less efficiently using change notification.
Type: number
Constraints: Read Only
(Optional) The pathname (relative to the Administration Server) of a file containing a deployment plan.
Type: string
Constraints: Immutable
The deployment plan version (specified during deployment).
Type: string
Constraints: Immutable
The runtime information for all servlets in this application.
Type: array
Constraints: Read Only
A count of the total number of sessions opened.
Type: number
Constraints: Read Only
A list of the URLs for each context root. Can be used to ping the application.
Type: array
Constraints: Read Only
The ApplicationBindable entity describes information about a descriptor element that can be bound to a resource and overridden through a deployment plan.
The properties of the ApplicationBindable entity are as follows:
The JNDI name of the resource that should be bound to this application.
Type: string
The name of this bindable descriptor value.
Type: string
Constraints: Read Only
The path in the deployment used to locate and identify this descriptor value.
Type: array
Constraints: Read Only
The type of resource that is expected to be bound to this descriptor value, if constrained: jms destination, jms connection factory, resource adapter, or ejb
Type: string
Constraints: Read Only
The ApplicationBindables entity is a collection of ApplicationBindable descriptor values in an application. Each entry represents a reference to a resource that can be specified and overridden in a deployment plan for an application.
The properties of the ApplicationBindables entity are as follows:
Bindables is the collection of ApplicationBindable descriptor values.
Type: array
Constraints: Read Only
Writeable indicates that this application configuration supports overwriting deployment plan descriptor values. If a deployment is not supported by a deployment plan, then values may not be overwritten.
Type: boolean
Constraints: Read Only
The ApplicationDescriptorScope entity identifies a path or scope within a deployment descriptor tree.
The properties of the ApplicationDescriptorScope entity are as follows:
The name for this scope, intended to be human readable.
Type: string
Constraints: Read Only
The path of this scope, which identifies the deployment descriptor path.
Type: string
Constraints: Read Only
The type of this descriptor scope.
Type: string
Constraints: Read Only
The ChangeManager entity includes properties that are required for change management.
The properties of the ChangeManager entity are as follows:
True if there are any changes that have been saved but not activated in the current and previous edit sessions.
Type: boolean
Constraints: Read Only
The user name of the owner of the current configuration lock.
Type: string
Constraints: Read Only
True if a configuration session is currently active.
Type: boolean
Constraints: Read Only
True if there are any changes in the global configuration that need to be merged with the default edit session before the default edit session can be activated.
Type: boolean
Constraints: Read Only
The DataSource entity represents the configuration and runtime metrics for a data source resource, used by applications to interact with a database.
The properties of the DataSource entity are as follows:
Aggregate metrics calculated across all running instances of this data source.
Type: DataSourceMetrics
Constraints: Read Only
The list of per server runtime metrics for this data source.
Type: array
Constraints: Read Only
The connection pool parameters of this data source. Configuration parameters for this data source's connection pool are specified using these parameters.
Type: JdbcConnectionPoolParams
Constraints: Read Only
The general parameters of this data source. Basic configuration parameters for this data source are specified using these parameters.
Type: JdbcDataSourceParams
Constraints: Read Only
The driver parameters for this data source. Configuration parameters for the JDBC driver used by this data source are specified using these parameters.
Type: JdbcDriverParams
Constraints: Read Only
The name of this data source.
Type: string
Constraints: Immutable, Not Null
The list of the targets for this data source.
Type: array
Constraints: Read Only
The DataSourceMetrics entity includes attributes that can be used to monitor a data source.
The properties of the DataSourceMetrics entity are as follows:
The average number of active connections in this instance of the data source. Active connections are connections in use by an application. This value is only valid if the resource is configured to allow shrinking.
Type: number
Constraints: Read Only
The number of connections currently in use by applications.
Type: number
Constraints: Read Only
The highest number of active database connections in this instance of the data source since the data source was instantiated. Active connections are connections in use by an application.
Type: number
Constraints: Read Only
The average amount of time, in milliseconds, that it takes to create a physical connection to the database. The value is calculated as summary of all times to connect divided by the total number of connections.
Type: number
Constraints: Read Only
The cumulative total number of database connections created in this data source since the data source was deployed.
Type: number
Constraints: Read Only
The current count of JDBC connections in the connection pool in the data source.
Type: number
Constraints: Read Only
The highest number of database connections available or in use (current capacity) in this instance of the data source since the data source was deployed.
Type: number
Constraints: Read Only
The cumulative, running count of requests for a connection from this data source that could not be fulfilled.
Type: number
Constraints: Read Only
The number of times that the data source attempted to refresh a database connection and failed. Failures may occur when the database is unavailable or when the network connection to the database is interrupted.
Type: number
Constraints: Read Only
The highest number of database connections that were idle and available to be used by an application at any time in this instance of the data source since the data source was deployed.
Type: number
Constraints: Read Only
The highest number of database connections that were in use by applications or being tested by the system in this instance of the data source since the data source was deployed.
Type: number
Constraints: Read Only
The number of leaked connections. A leaked connection is a connection that was reserved from the data source but was not returned to the data source by calling close()
Type: number
Constraints: Read Only
The number of database connections that are currently idle and available to be used by applications in this instance of the data source.
Type: number
Constraints: Read Only
The number of connections currently in use by applications or being tested in this instance of the data source.
Type: number
Constraints: Read Only
The cumulative, running count of the number of times that the statement cache was accessed.
Type: number
Constraints: Read Only
The cumulative, running count of the number of statements added to the statement cache. Each connection in the connection pool has its own cache of statements. This number is the sum of the number of statements added to the caches for all connections in the connection pool.
Type: number
Constraints: Read Only
The number of prepared and callable statements currently cached in the statement cache. Each connection in the connection pool has its own cache of statements. This number is the sum of the number of statements in the caches for all connections in the connection pool.
Type: number
Constraints: Read Only
The cumulative, running count of statements discarded from the cache. Each connection in the connection pool has its own cache of statements. This number is the sum of the number of statements that were discarded from the caches for all connections in the connection pool.
Type: number
Constraints: Read Only
The cumulative, running count of the number of times that statements from the cache were used.
Type: number
Constraints: Read Only
The number of times that a statement request could not be satisfied with a statement from the cache.
Type: number
Constraints: Read Only
The cumulative, running count of requests for a connection from this data source.
Type: number
Constraints: Read Only
The name of the server where this data source instance runs.
Type: string
Constraints: Read Only
The state of this data source: running, suspended, shutdown, overloaded, or unknown
Type: string
Constraints: Read Only
The highest number of seconds that an application waited for a connection (the longest connection reserve wait time) from this instance of the connection pool since the connection pool was instantiated. This value is updated when a completed getConnection request takes longer to return a connection than any previous request.
Type: number
Constraints: Read Only
The number of connection requests waiting for a database connection.
Type: number
Constraints: Read Only
The cumulative, running count of requests for a connection from this data source that had to wait before getting a connection and eventually failed to get a connection. Waiting connection requests can fail for a variety of reasons, including waiting for longer than the ConnectionReserveTimeoutSeconds.
Type: number
Constraints: Read Only
Highest number of application requests concurrently waiting for a connection from this instance of the data source.
Type: number
Constraints: Read Only
The cumulative, running count of requests for a connection from this data source that had to wait before getting a connection and eventually succeeded in getting a connection.
Type: number
Constraints: Read Only
The cumulative, running count of requests for a connection from this data source that had to wait before getting a connection, including those that eventually got a connection and those that did not get a connection.
Type: number
Constraints: Read Only
A DatabaseConnection entity describes the key properties necessary to establish a connection to a database. This is the basis for a DataSource entity, and may be used to validate that a database connection can be established successfully.
The properties of the DatabaseConnection entity are as follows:
The driver name for this connection.
Type: string
The password for this connection.
Type: string
The properties for this connection.
Type: array
The URL used to connect to the database.
Type: string
A DatabaseConnectionStatus entity describes the results that occur when a database connection is attempted.
The properties of the DatabaseConnectionStatus entity are as follows:
If issues were uncovered during this attempt, then cause can be used to retrieve human readable strings which describe these issues.
Type: array
Constraints: Read Only
The connection status. True if this connection was successful.
Type: boolean
Constraints: Read Only
The DatabaseDriver entity includes properties that are required to interact with a specific database driver.
The properties of the DatabaseDriver entity are as follows:
A human readable description for this driver.
Type: string
Constraints: Read Only
The driver class name.
Type: string
Constraints: Read Only
Whether this driver supports XA connections.
Type: boolean
Constraints: Read Only
The name of this driver.
Type: string
Constraints: Read Only
A test SQL statement that should be used when interacting with this driver.
Type: string
Constraints: Read Only
The type of this driver, unconstrained, but typically Thin, OCI, Type 2, or Type 4
Type: string
Constraints: Read Only
The DatabaseDriverAttribute entity represents a driver-specific attribute that is required to support connections with this driver.
The properties of the DatabaseDriverAttribute entity are as follows:
The default value for this attribute, if any.
Type: string
Constraints: Read Only
A human readable description string for this attribute.
Type: string
Constraints: Read Only
If true, this attribute will be formatted and included in the URL string used to interact with the driver.
Type: boolean
Constraints: Read Only
The name of this attribute.
Type: string
Constraints: Read Only
If true, this attribute is required. Otherwise, attributes are optional and may be omitted.
Type: boolean
Constraints: Read Only
The user specified value for this attribute.
Type: string
The DatabaseDriverAttributes entity represents a list of attributes that are associated with a database driver. These attributes represent driver-specific properties that are required to support connections with this driver.
The properties of the DatabaseDriverAttributes entity are as follows:
The list of attributes for this driver.
Type: array
The name of the password attribute, which requires special handling in clients to avoid surfacing confidential information.
Type: string
Constraints: Read Only
The DatabaseVendor entity describes a vendor of database drivers. Each vendor will have one or more drivers that can be selected and applied.
The properties of the DatabaseVendor entity are as follows:
A list of drivers available from this vendor.
Type: array
Constraints: Read Only
The name of this database driver vendor.
Type: string
Constraints: Read Only
The Deployment entity includes essential information that is common to all deployment types.
The properties of the Deployment entity are as follows:
The pathname (relative to the Administration Server) of a file containing the deployment archive or a directory containing an exploded deployment.
Type: string
Constraints: Immutable
A human readable name for this deployment, with formatted version information.
Type: string
Constraints: Read Only
The name of this deployment.
Type: string
Constraints: Immutable
The state of this deployment: active, admin, update pending, prepared, failed, retired, or new
Type: string
Constraints: Read Only
The list of the targets for this deployment.
Type: array
Constraints: Read Only
The type of this deployment: application or library
Type: string
Constraints: Read Only
The DeploymentDescription entity provides access to the configuration of a deployment.
The properties of the DeploymentDescription entity are as follows:
The archive version if the deployment is an application and specifies its archive version.
Type: string
Constraints: Read Only
The pathname (relative to the Administration Server) of a file containing the deployment archive or a directory containing an exploded deployment.
Type: string
Constraints: Read Only
The type of deployment: library, application, or unknown
Type: string
Constraints: Read Only
The implementation version if the deployment is a library and specifies its implementation version.
Type: string
Constraints: Read Only
The name of this deployment, if available. (This is the suggested name for a new deployment.)
Type: string
Constraints: Read Only
(Optional) The pathname (relative to the Administration Server) of a file containing a deployment plan.
Type: string
Constraints: Read Only
The plan version if the deployment is an application and specifies its plan version.
Type: string
Constraints: Read Only
The specification version if the deployment is a library and specifies its specification version.
Type: string
Constraints: Read Only
The DeploymentJob entity includes the attributes of a Job entity, and adds the following attributes that are unique to a deployment operation.
The properties of the DeploymentJob entity are as follows:
The name of the deployment affected by this job.
Type: string
Constraints: Read Only
The deployment operation that this job is tracking: activate, prepare, deactivate, remove, unprepare, distribute, start, stop, redeploy, update, deploy, or undeploy
Type: string
Constraints: Read Only
The status of this deployment job: initialized, in progresscompleted, failed, or deferred
Type: string
Constraints: Read Only
The target specific status information associated with this job.
Type: array
Constraints: Read Only
The DeploymentJobTarget entity provides access to target-specific status information for a deployment job.
The properties of the DeploymentJobTarget entity are as follows:
A list of error messages that describe issues that occurred during this deployment job, if any.
Type: array
Constraints: Read Only
The name of this target.
Type: string
Constraints: Read Only
The status of the deployment operation on this target: initialized, in progresscompleted, failed, or unavailable
Type: string
Constraints: Read Only
The type of this target: unknown, server, clusterJMS server, virtual host, or SAF agent
Type: string
Constraints: Read Only
A DeploymentReference entity is used to identify a deployment for inspection or deployment.
The properties of the DeploymentReference entity are as follows:
The pathname (relative to the Administration Server) of a file containing the deployment archive or a directory containing an exploded deployment.
Type: string
Constraints: Not Null
(Optional) The pathname (relative to the Administration Server) of a file containing a deployment plan.
Type: string
The Ejb entity includes information for each EJB.
The properties of the Ejb entity are as follows:
Aggregate metrics calculated across all running instances of this EJB.
Type: EjbMetrics
Constraints: Read Only
The list of per server runtime metrics for this EJB.
Type: array
Constraints: Read Only
The name for this EJB as defined in the javax.ejb.EJB annotation, or the ejb-name when using the ejb-jar.xml deployment descriptor.
Type: string
Constraints: Read Only
The name of this EJB module.
Type: string
Constraints: Read Only
The type of this EJB: entity, stateless, stateful, singleton, or message driven
Type: string
Constraints: Read Only
The EjbCacheMetrics entity includes runtime cache monitoring information for each EJB.
The properties of the EjbCacheMetrics entity are as follows:
A count of the total number of beans from this EJB Home that have been activated.
Type: number
Constraints: Read Only
A count of the total number of attempts to access a bean from the cache.
Type: number
Constraints: Read Only
A count of the total number of times an attempt to access a bean from the cache failed.
Type: number
Constraints: Read Only
A count of the total number of beans from this EJB Home currently in the EJB cache.
Type: number
Constraints: Read Only
A count of the total number of beans from this EJB Home that have been passivated.
Type: number
Constraints: Read Only
The EjbLockingMetrics entity includes runtime locking monitoring information for each EJB.
The properties of the EjbLockingMetrics entity are as follows:
A count of the number of beans currently locked.
Type: number
Constraints: Read Only
The total number of attempts to obtain a lock on a bean. This includes attempts to obtain a lock on a bean that is already locked on behalf of the client.
Type: number
Constraints: Read Only
The current number of threads that have timed out waiting for a lock on a bean.
Type: number
Constraints: Read Only
The current number of threads that have waited for a lock on a bean.
Type: number
Constraints: Read Only
The total number of threads that have waited for a lock on a bean.
Type: number
Constraints: Read Only
The EjbMetrics entity includes runtime monitoring information for an EJB instance.
The properties of the EjbMetrics entity are as follows:
The EJB caching metrics, if applicable.
Type: EjbCacheMetrics
Constraints: Read Only
The EJB locking metrics, if applicable.
Type: EjbLockingMetrics
Constraints: Read Only
The EJB pool metrics, if applicable.
Type: EjbPoolMetrics
Constraints: Read Only
The name of the server where this EJB instance runs.
Type: string
Constraints: Read Only
The EJB timer metrics, if applicable.
Type: EjbTimerMetrics
Constraints: Read Only
The EJB transaction metrics, if applicable.
Type: EjbTransactionMetrics
Constraints: Read Only
The EjbPoolMetrics entity includes runtime pool monitoring information for each EJB.
The properties of the EjbPoolMetrics entity are as follows:
A count of the total number of times an attempt was made to get an instance from the free pool.
Type: number
Constraints: Read Only
A count of the number of bean instances currently being used from the free pool.
Type: number
Constraints: Read Only
A count of the total number of times a bean instance from this pool was destroyed due to a non-application exception being thrown from it.
Type: number
Constraints: Read Only
A count of the total number of times a failed attempt was made to get an instance from the free pool. An attempt to get a bean from the pool will fail if there are no available instances in the pool.
Type: number
Constraints: Read Only
A count of the current number of available bean instances in the free pool.
Type: number
Constraints: Read Only
A count of the total number of threads that have timed out waiting for an available bean instance from the free pool.
Type: number
Constraints: Read Only
A count of the total number of threads currently waiting for an available bean instance from the free pool.
Type: number
Constraints: Read Only
The EjbTimerMetrics entity includes runtime timer monitoring information for each EJB.
The properties of the EjbTimerMetrics entity are as follows:
The current number of active timers for this EJB.
Type: number
Constraints: Read Only
The total number of timers that have been explicitly cancelled for this EJB.
Type: number
Constraints: Read Only
The current number of timers temporarily disabled for this EJB.
Type: number
Constraints: Read Only
The total number of successful timeout notifications that have been made for this EJB.
Type: number
Constraints: Read Only
The EjbTransactionMetrics entity includes runtime transaction monitoring information for each EJB.
The properties of the EjbTransactionMetrics entity are as follows:
A count of the total number of transactions that have been committed for this EJB.
Type: number
Constraints: Read Only
A count of the total number of transactions that have been rolled back for this EJB.
Type: number
Constraints: Read Only
A count of the total number of transactions that have timed out for this EJB.
Type: number
Constraints: Read Only
The Health entity represents the health of a WebLogic domain.
The properties of the Health entity are as follows:
The reasons for the health state of this domain.
Type: string
Constraints: Read Only
The domain health state: ok, warn, critical, failed, overloaded, or unknown
Type: string
Constraints: Read Only
The JdbcConnectionPoolParams entity includes parameters for a data source's connection pool.
The properties of the JdbcConnectionPoolParams entity are as follows:
If you do not set this value, data source creation fails if the database is unavailable. If set and if the database is unavailable when the data source is created, WebLogic Server will attempt to create connections in the pool again after the number of seconds you specify, and will continue to attempt to create the connections until it succeeds. When set to zero (0), connection retry is disabled.
Type: number
The maximum number of connections that may be harvested when the connection harvesting occurs. The range of valid values is to MaxCapacity
Type: number
The number of available connections (trigger value) used to determine when connection harvesting occurs.
Harvesting occurs when the number of available connections is below the trigger value for a connection pool.
The range of valid values is -1 to MaxCapacity
The default value is -1
Setting the value to -1 disables connection harvesting.
Type: number
The class name of the connection labeling callback. This is automatically passed to registerConnectionLabelingCallback when the data source is created. The class must implement oracle.ucp.ConnectionLabelingCallback
Type: string
Constraints: Not Null
The number of seconds after which a call to reserve a connection from the connection pool will timeout. When set to zero (0), a call will never timeout. When set to -1, a call will timeout immediately.
Type: number
The number of refresh failures allowed before WebLogic Server closes all connections in a connection pool to minimize the delay caused by further database testing.
Type: number
The number of test failures allowed before WebLogic Server closes all connections in a connection pool to minimize the delay caused by further database testing.
Type: number
Enables Set Client ID on connection for the data source. When an application requests a database connection, WebLogic Server sets a light-weight client ID on the database connection.
By default, it uses the credential mapping to map WebLogic Server user IDs to database user IDs. However, if use-database-credentials is set to true, then the credential mapping is not done and the ID is used directly as a database user ID.
It is currently supported for IBM DB2 driver and Oracle thin driver. Support for this feature will be dropped in a future Oracle thin driver release. Oracle recommends using proxy authentication instead of this feature.
Type: boolean
The absolute name of the application class used to intercept method calls to the JDBC driver. The application specified must implement the weblogic.jdbc.extensions.DriverInterceptor interface.
WebLogic Server will invoke the preInvokeCallback(), postInvokeExceptionCallback(), and postInvokeCallback() methods of the registered application before and after invoking any method inside the JDBC driver. You can use this feature to profile JDBC driver usage and monitor:
Methods being executed
Any exceptions thrown
Time spent inside the driver executing methods
Type: string
Constraints: Not Null
A comma-separated list of error codes that are treated as fatal errors. These errors include deployment errors that cause a server to fail to boot and connection errors that prevent a connection from being put back in the connection pool.
This optional property is used to define fatal error codes, that when specified as the exception code within a SQLException (retrieved by sqlException.getErrorCode()), indicate that a fatal error has occurred and the connection is no longer usable. For Oracle databases the following fatal error codes are predefined within WLS and do not need to be placed in the configuration file:
3113: end-of-file on communication channel
3114: not connected to ORACLE
1033: ORACLE initialization or shutdown in progress
1034: ORACLE not available
1089: immediate shutdown in progress - no operations are permitted
1090: shutdown in progress - connection is not permitted
17002: I/O exception
Type: string
Constraints: Not Null
The maximum number of connection requests that can concurrently block threads while waiting to reserve a connection from the data source's connection pool.
Type: number
Enables identity-based-connection-pooling for the data source. When an application requests a database connection, WebLogic Server picks or creates a physical connection with the requested DBMS identity based on a map of WebLogic user IDs and database IDs. You must also specify the map of WebLogic Server user IDs to database user IDs (credential mapping).
Type: boolean
Enables the data source to be shutdown even if connections obtained from the pool are still in use.
Type: boolean
The number of inactive seconds on a reserved connection before WebLogic Server reclaims the connection and releases it back into the connection pool.
You can use the Inactive Connection Timeout feature to reclaim leaked connections - connections that were not explicitly closed by the application. Note that this feature is not intended to be used in place of properly closing connections.
When set to zero (0), the feature is disabled.
Type: number
SQL statement to execute that will initialize newly created physical database connections. Start the statement with SQL followed by a space.
If the Init SQL value begins with SQL, then the rest of the string following that leading token will be taken as a literal SQL statement that will be used to initialize database connections. If the Init SQL value does not begin with SQL, the value will be treated as the name of a table and the following SQL statement will be used to initialize connections: select count(*) from InitSQL
The table InitSQL must exist and be accessible to the database user for the connection. Most database servers optimize this SQL to avoid a table scan, but it is still a good idea to set InitSQL to the name of a table that is known to have few rows, or even no rows.
Type: string
Constraints: Not Null
The number of physical connections to create when creating the connection pool in the data source. If unable to create this number of connections, creation of the data source will fail.
Type: number
The level of JDBC debugging for XA drivers, where larger values in the range provide more debugging information.
Type: number
The number of seconds to delay before creating each physical database connection. This delay supports database servers that cannot handle multiple connection requests in rapid succession.
The delay takes place both during initial data source creation and during the lifetime of the data source whenever a physical database connection is created.
Type: number
The maximum number of physical connections that this connection pool can contain.
Type: number
The minimum number of physical connections that this connection pool can contain after it is initialized.
Type: number
Enables an option to improve performance by enabling execute threads to keep a pooled database connection even after the application closes the logical connection. When enabled:
WebLogic Server pins a database connection from the connection pool to an execution thread the first time an application uses the thread to reserve a connection. When the application finishes using the connection and calls connection.close(), WebLogic Server keeps the connection with the execute thread and does not return it to the connection pool. When an application subsequently requests a connection using the same execute thread, WebLogic Server provides the connection already reserved by the thread.
There is no locking contention on the connection pool that occurs when multiple threads attempt to reserve a connection at the same time. There is no contention for threads that attempt to reserve the same connection from a limited number of database connections.
If an application concurrently reserves more than one connection from the connection pool using the same execute thread, WebLogic Server creates additional database connections and pins them to the thread.
Type: boolean
The number of seconds between when WebLogic Server harvests profile data. When set to zero (0), harvesting of data is disabled.
Type: number
The type of profile data to be collected for the JDBC subsystem.
Type: number
Specifies whether a connection will be removed from the connection pool after the application uses the underlying vendor connection object.
If you disable removing infected connections, you must make sure that the database connection is suitable for reuse by other applications.
When set to true (the default), the physical connection is not returned to the connection pool after the application closes the logical connection. Instead, the physical connection is closed and recreated.
When set to false, when the application closes the logical connection, the physical connection is returned to the connection pool and can be reused by the application or by another application.
Type: boolean
The number of seconds within a connection that WebLogic Server trusts that the connection is still viable and will skip the connection test, either before delivering it to an application or during the periodic connection testing process.
This option is an optimization that minimizes the performance impact of connection testing, especially during heavy traffic.
Type: number
The number of seconds to wait before shrinking a connection pool that has incrementally increased to meet demand. When set to zero (0), shrinking is disabled.
Type: number
The number of prepared and callable statements stored in the cache. (This may increase server performance.)
WebLogic Server can reuse statements in the cache without reloading the statements, which can increase server performance. Each connection in the connection pool has its own cache of statements.
Setting the size of the statement cache to zero (0) turns off statement caching.
Type: number
The algorithm used for maintaining the prepared statements stored in the statement cache:
least recently used - when a new prepared or callable statement is used, the least recently used statement is replaced in the cache.
fixed - the first fixed number of prepared and callable statements are cached.
Type: string
The time after which a statement currently being executed will time out.
Statement timeout relies on underlying JDBC driver support. WebLogic Server passes the time specified to the JDBC driver using the java.sql.Statement.setQueryTimeout() method. If your JDBC driver does not support this method, it may throw an exception and the timeout value is ignored.
A value of -1 disables this feature. A value of zero (0) means that statements will not time out.
Type: number
Enables WebLogic Server to test a connection before giving it to a client. (Requires that you specify a Test Table Name.)
The test adds a small delay in serving the client's request for a connection from the pool, but ensures that the client receives a viable connection.
Type: boolean
The number of seconds a WebLogic Server instance waits between attempts when testing unused connections. (Requires that you specify a Test Table Name.) Connections that fail the test are closed and reopened to re-establish a valid physical connection. If the test fails again, the connection is closed.
In the context of multi data sources, this attribute controls the frequency at which WebLogic Server checks the health of data sources it had previously marked as unhealthy.
When set to zero (0), the feature is disabled.
Type: number
The name of the database table to use when testing physical database connections. This name is required when you specify a Test Frequency and enable Test Reserved Connections.
The default SQL code used to test a connection is select count(*) from TestTableName. Most database servers optimize this SQL to avoid a table scan, but it is still a good idea to set the Test Table Name to the name of a table that is known to have few rows, or even no rows.
If the Test Table Name begins with SQL, then the rest of the string following that leading token will be taken as a literal SQL statement that will be used to test connections instead of the standard query. For example: SQL BEGIN; Null; END;
For an Oracle database, you can reduce the overhead of connection testing by setting Test Table Name to SQL PINGDATABASE which uses the pingDatabase() method to test the Oracle connection.
Type: string
By default, SQL objects for CallableStatement, PreparedStatement, ResultSet, Statement, and DatabaseMetaData are wrapped with a WebLogic wrapper. Wrapping allows features like debugging and connection usage to be performed by the server.
When false, wrapping is disabled. This improves performance, in some cases significantly, and allows for the application to use the native driver objects directly. A value of false also disables data type wrapping.
Type: boolean
By default, data type objects for Array, Blob, Clob, NClob, Ref, SQLXML, and Struct, plus ParameterMetaData and ResultSetMetaData objects are wrapped with a WebLogic wrapper. This allows features like debugging and connection usage to be done by the server. The wrapping can be turned off by setting this value to false. This improves performance, in some cases significantly, and allows the application to use the native driver objects directly.
Type: boolean
The JdbcDataSourceParams entity includes the basic configuration settings for a data source.
The properties of the JdbcDataSourceParams entity are as follows:
The algorithm that determines the connection request processing for the multi data source: failover or load balancing
Type: string
The name of the application class to handle the callback sent when a multi data source is ready to failover or fail back connection requests to another data source within the multi data source. The name must be the absolute name of an application class that implements the weblogic.jdbc.extensions.ConnectionPoolFailoverCallback interface.
Type: string
The list of data sources to which the multi data source will route connection requests. The order of data sources in the list determines the failover order.
Type: string
For multi data sources with the failover algorithm, enables the multi data source to failover connection requests to the next data source if all connections in the current data source are in use.
Type: boolean
The transaction protocol (global transaction processing behavior) for the data source: two phase commit, logging last resource, emulate two phase commit, one phase commit, or none
Type: string
The JNDI path to where this data source is bound. By default, the JNDI name is the name of the data source. Applications that look up the JNDI path will get a javax.sql.DataSource instance that corresponds to this data source.
Type: array
Enables WebLogic Server to keep the physical database connection associated with the logical connection when committing a global transaction instead releasing it and getting another physical connection when needed. Setting this property to true may require additional connections to be configured on the database.
Type: boolean
Enables WebLogic Server to keep the physical database connection associated with the logical connection when committing a local transaction instead of releasing it and getting another physical connection when needed. Setting this property to true may require additional connections to be configured on the database.
Type: boolean
Enables multiple rows to be "prefetched" (that is, sent from the server to the client) in one server access.
Type: boolean
If row prefetching is enabled, specifies the number of result set rows to prefetch for a client.
Type: number
The scoping of the data source: global or application
Type: string
The data chunk size for streaming data types.
Type: number
A JdbcDriverParams entity includes the driver parameters for the JDBC driver used by a data source.
The properties of the JdbcDriverParams entity are as follows:
The list of properties passed to the JDBC driver when creating physical database connections.
To enable driver-level features, add the driver property and its value to the Properties list. WebLogic Server sets driver-level properties in the Properties list on the driver's ConnectionPoolDataSource object.
NOTE: For Security reasons, when WebLogic Server is running in production mode, you cannot specify database passwords in this properties list. Data source deployment will fail if a password is specified in the properties list. To override this security check, use the command line argument weblogic.management.allowClearTextPasswords when starting the server.
Type: array
Specifies whether the database credentials are to be obtained from the credential mapper using the "user" property as the key. When true, the credentials are obtained from the credential mapper. When false, the database user name and password are obtained from the "user" property and Password element, respectively.
Type: boolean
Specifies that WebLogic Server should use the XA interface of the JDBC driver. If the JDBC driver class used to create database connections implements both XA and non-XA versions of a JDBC driver, you can set this attribute to indicate that WebLogic Server should treat the JDBC driver as an XA driver or as a non-XA driver.
Type: boolean
The Job entity includes information about an asynchronous task.
The properties of the Job entity are as follows:
The time at which this job was started.
Type: number
Constraints: Read Only
A description associated with this job.
Type: string
Constraints: Read Only
The time at which this job was completed. Zero (0) if running.
Type: number
Constraints: Read Only
An error message for this job, if any.
Type: string
Constraints: Read Only
A unique identity for the job within its specific job type. Not meant to be displayed. Useful for constructing URLs and for querying for additional job information.
Type: string
Constraints: Read Only
The name associated with this job.
Type: string
Constraints: Read Only
The status of this job.
Type: string
Constraints: Read Only
The type of job: server or deployment
Type: string
Constraints: Read Only
A Library entity includes information about a library deployment, including the libraries and applications which are dependent on this library.
Note that a Library entity includes all the Deployment properties in addition to the following properties.
The properties of the Library entity are as follows:
The library implementation version (from the deployment manifest file).
Type: string
Constraints: Read Only
The list of application names that reference this library.
Type: array
Constraints: Read Only
The list of other library names that reference this library.
Type: array
Constraints: Read Only
The library specification version (from the deployment manifest file).
Type: string
Constraints: Read Only
The LogEntry entity describes a specific log entry in a log file.
The fields recorded in a log file in WebLogic Server vary considerably according to the log type: data source, HTTP access, or server log. As such, the information returned in a LogEntry entity will also vary depending on the log file being viewed.
The properties of the LogEntry entity are as follows:
The authorized user associated with this condition, if applicable to this log type.
Type: string
Constraints: Read Only
The context ID associated with this condition, if applicable to this log type.
Type: string
Constraints: Read Only
The data source associated with this condition, if applicable to this log type.
Type: string
Constraints: Read Only
The host of this condition, if applicable to this log type.
Type: string
Constraints: Read Only
The message associated with this condition, if applicable to this log type.
Type: string
Constraints: Read Only
The message ID of this condition, if applicable to this log type.
Type: string
Constraints: Read Only
The profile information associated with this condition, if applicable to this log type.
Type: string
Constraints: Read Only
The profile type associated with this condition, if applicable to this log type.
Type: string
Constraints: Read Only
The unique identifier for this log entry in this log.
Type: string
Constraints: Read Only
The remote user associated with this condition, if applicable to this log type.
Type: string
Constraints: Read Only
The request associated with this condition, if applicable to this log type.
Type: string
Constraints: Read Only
The severity of this condition, if applicable to this log type.
Type: string
Constraints: Read Only
The status of this condition, if applicable to this log type.
Type: string
Constraints: Read Only
The subsystem associated with this condition, if applicable to this log type.
Type: string
Constraints: Read Only
The date and time of this log entry. Not available for resource adapter logs.
Type: string
Constraints: Read Only
The user associated with this condition, if applicable to this log type.
Type: string
Constraints: Read Only
The user ID associated with this condition, if applicable to this log type.
Type: string
Constraints: Read Only
The LogReference entity describes a specific, named log.
The properties of the LogReference entity are as follows:
The name of the log.
Type: string
Constraints: Read Only
The Server entity describes the configuration, state, and metrics associated with a WebLogic Server instance.
The properties of the Server entity are as follows:
The number of current active HTTP sessions for all servlets hosted by this server.
Type: number
Constraints: Read Only
The number of active threads being used by all applications and resources on this server.
Type: number
Constraints: Read Only
The health of this server instance, if running. This health status is aggregated across all of the components of a server and will denote the most severe health condition encountered.
Type: Health
Constraints: Read Only
The current amount of memory (in bytes) that is available in the JVM heap.
Type: number
Constraints: Read Only
The current size (in bytes) of the JVM heap used by this server.
Type: number
Constraints: Read Only
The average load that the VM is placing on all processors, in percent: 0% to 100%.
Type: number
Constraints: Read Only
The name of this server instance.
Type: string
Constraints: Read Only
The current state of this server instance:
shutdown
starting
running
standby
admin
suspending
force suspending
resuming
shutting down
force shutting down
failed
unknown
discovered
failed restarting
activate later
failed not restartable
failed migratable
Type: string
Constraints: Read Only
The amount (in bytes) of physical memory that is currently being used by this server.
Type: number
Constraints: Read Only
The ServerJob entity includes the attributes of a Job entity, and adds additional attributes that are unique to a server life cycle operation.
The properties of the ServerJob entity are as follows:
The server life cycle state transitions tracked by this job:
start
shutdown
start in standby
resume
force shutdown
suspending
force suspend
Type: string
Constraints: Read Only
The name of the server affected by this job.
Type: string
Constraints: Read Only
The server job status: in progress, completed, or failed
Type: string
Constraints: Read Only
The Servlet entity includes information for each servlet.
The properties of the Servlet entity are as follows:
Aggregate metrics calculated across all running instances of this servlet.
Type: ServletMetrics
Constraints: Read Only
The context path for this servlet.
Type: string
Constraints: Read Only
The module associated with this servlet.
Type: string
Constraints: Read Only
The list of per server runtime metrics for this servlet.
Type: array
Constraints: Read Only
The name of this instance of a servlet.
Type: string
Constraints: Read Only
The ServletMetrics entity includes runtime monitoring information for a servlet instance.
The properties of the ServletMetrics entity are as follows:
The amount of time the single longest invocation of the servlet has executed since created.
Type: number
Constraints: Read Only
The amount of time the single shortest invocation of the servlet has executed since created. Note that for the CounterMonitor, the difference option must be used.
Type: number
Constraints: Read Only
The total amount of time all invocations of the servlet have executed since created.
Type: number
Constraints: Read Only
A total count of the number of times this servlet has been invoked.
Type: number
Constraints: Read Only
A total count of the number of times this servlet has been reloaded.
Type: number
Constraints: Read Only
The name of the server where this servlet instance runs.
Type: string
Constraints: Read Only
The Target entity represents a WLS target.
The properties of the Target entity are as follows:
The name of this target.
Type: string
Constraints: Read Only
The type of this target: server or cluster
Type: string
Constraints: Read Only
A Version entity describes a version of the WLS resources.
The properties of the Version entity are as follows:
True if this is the default version.
Type: boolean
Constraints: Read Only
Type: string
The life cycle of this version: active or deprecated
Type: string
Constraints: Read Only
The name of this version.
Type: string
Constraints: Read Only
The Wls entity provides access to the overall state and condition of the WebLogic Server domain.
The properties of the Wls entity are as follows:
The total number of active HTTP sessions in all applications and all servers in this domain.
Type: number
Constraints: Read Only
The number of currently active WebLogic Server instances.
Type: number
Constraints: Read Only
The total number of active threads currently in use on all servers.
Type: number
Constraints: Read Only
The number of potential WebLogic Server instances.
Type: number
Constraints: Read Only
The name of this domain.
Type: string
Constraints: Read Only
The health of this domain. This health status is aggregated across all of the running servers and will denote the most severe health condition encountered.
Type: Health
Constraints: Read Only
True if this domain is running in production mode. False if the domain is running in development mode.
Type: boolean
Constraints: Read Only