1. REST API for Oracle Unified Directory Administration
  2. Tasks
  3. RDBMS Extension

Modify a RDBMS Extension by DN

patch

/rest/v1/admin/{dn}

Modify a RDBMS Extension by DN

Request

Supported Media Types
Path Parameters
Body ()
RDBMS Extension that needs to be modified
Root Schema : PatchRequest
Type: object
Show Source
Nested Schema : controls
Type: array
LDAP controls to be sent to server for LDAP modify operation.
Show Source
Nested Schema : operations
Type: array
Modifications (Patch operations) to be performed on the entry.
Show Source
Nested Schema : PatchOperation
Type: object
Show Source
Nested Schema : values
Type: array
The attribute values to be updated.
Show Source
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : RDBMS Extension PatchSuccessResponse
Type: object
Show Source
Nested Schema : searchResultEntries
Type: array
Number of search result entries returned after the LDAP operation.
Show Source
Nested Schema : RDBMS Extension SearchResultEntry
Type: object
Show Source
Nested Schema : RDBMS Extension Properties
Type: object
Show Source
  • CN (common name) of the entry
  • Default Value: universal-connection-pool
    Allowed Values: [ "simple-pool", "universal-connection-pool" ]
    The connection pool implementation to use for this extension. By default we use Universal Connection Pool (UCP). NOTE: In case Simple_Pool is used then the RDBMS Extension cannot be shared across multiple RDBMS WorkflowElements.
  • Default Value: 0
    Sets the maximum connection reuse count property. This property specifies the maximum number of times any connection can be reused after which the pool removes and closes a connection. The value must be greater than 0 for this feature to be enabled. For example, if the specified value is 100, then when a connection is reused or borrowed 100 times from the pool, it is closed and removed from the pool. Connections are closed gracefully after they are returned to the pool and the property value has been exceeded. Default is 0, which means this feature is not enabled.
  • Indicates whether the Extension is enabled.
  • Default Value: 0
    Sets the inactive connection timeout. This timeout determines how long an available connection remains in the connection pool before it is removed from the pool. The range of valid values is 0 to Integer.MAX_VALUE. Defaults to 0. Setting the value to 0 disables inactive connection timeout processing.
  • Default Value: 0
    The initial number of connections setup by the ConnectionPool. This is the number of connections that will be created and placed in the pool when the pool is started. The range of valid values is 0 to Integer.MAX_VALUE. It is illegal to set this to a value greater than the maximum pool size. Defaults to 0.
  • Default Value: com.oracle.dps.server.workflowelement.rdbms.RDBMSExtension
    Specifies the fully-qualified name of the Java class that provides the RDBMS Extension implementation.
  • ds-cfg-jdbc-connection-properties
    Optional JDBC driver related connection properties as name value pair for DataSource connection factories that also support connection properties.
  • Specifies the fully-qualified name of the Java class that provides the JDBC driver implementation for the RDBMS vendor.
  • Default Value: false
    Optional flag to specify if JDBC driver related connection properties need to be set as connection factory properties.
  • Default Value: javax.net.ssl.keyStore
    KeyStore property name for the JDBC driver.
  • Default Value: javax.net.ssl.keyStorePassword
    KeyStore password property name for the JDBC driver.
  • Default Value: javax.net.ssl.keyStoreType
    KeyStore type property name for the JDBC driver.
  • Default Value: javax.net.ssl.trustStore
    TrustStore property name for the JDBC driver.
  • Default Value: javax.net.ssl.trustStorePassword
    TrustStore password property name for the JDBC driver.
  • Default Value: javax.net.ssl.trustStoreType
    TrustStore type property name for the JDBC driver.
  • JDBC URL for connecting to the database.
  • Default Value: 0
    Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout.
  • Default Value: 20
    The maximum number of connections that can be setup by the connection pool. The maximum number of connections includes the number of connections that are in use as well as the number of available connections. The range of valid values is 1 to Integer.MAX_VALUE. Defaults to 20.
  • Default Value: 10
    Sets the minimum number of connections set up by the connection pool. If the number of available connections + the number of connections in use is less than the minimum then the connection is returned to the pool. Otherwise, the connection is closed. The range of valid values is 0 to Integer.MAX_VALUE. It is illegal to set this to a value greater than the maximum pool size. Defaults to 10.
  • Default Value:
    The password with which connections have to be obtained.
  • The user name with which connections have to be obtained.
  • Specifies key manager provider to use with RDBMS Extension. This key manager provider is not mandatory and may be used if the remote server is configured for client authentication.
  • Specifies trust manager provider to use with RDBMS Extension. This trust manager provider is mandatory when secure connection needs to be established with the remote backend.
  • Allowed Values: [ "db2", "db2mainframe", "derby", "mysql", "mysql4", "oracle", "oracle10g", "oracle11", "oracle8i", "oracle9i", "postgresql", "sqlserver", "timesten" ]
    Specify the Target Database in the backend.
  • Default Value: false
    Specifies to use secure JDBC connection to the database.
  • objectclass
    Objectclass(es) which this entry belongs to.
Nested Schema : ds-cfg-jdbc-connection-properties
Type: array
Optional JDBC driver related connection properties as name value pair for DataSource connection factories that also support connection properties.
Show Source
Nested Schema : objectclass
Type: array
Objectclass(es) which this entry belongs to.
Show Source

400 Response

ERROR

406 Response

Not Acceptable
Body ()
Root Schema : ErrorResponse
Type: object
Show Source
Back to Top