Jump to

• Request
• Response

Modify This JDBC Data Source Params

post

/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/JDBCSystemResources/{name}/JDBCResource/JDBCDataSourceParams

Modify this JDBC data source params.

Request

Supported Media Types

• application/json

Path Parameters

• name: string
  The name property of the instance in the collection.
• version: string
  The version of the WebLogic REST interface.

Header Parameters

• X-Requested-By: string
  The 'X-Requested-By' header is used to protect against Cross-Site Request Forgery (CSRF) attacks. The value is an arbitrary name such as 'MyClient'.

Body ()

Must contain the modified JDBC data source params model.

Root Schema : JDBC Data Source Params

Type: object

Show Source

• algorithmType(optional): string
  Default Value: Failover

  Allowed Values: [ "Load-Balancing", "Failover" ]

  The algorithm determines the connection request processing for the multi data source.

  You can specify one of the following algorithm types:

  • Failover

    Connection requests are sent to the first data source in the list; if the request fails, the request is sent to the next data source in the list, and so forth. The process is repeated until a valid connection is obtained, or until the end of the list is reached, in which case an exception is thrown.

  • Load balancing

    The multi data source distributes connection requests evenly to its member data sources. With this algorithm, the multi data source also provides failover processing. That is, if a request fails, the multi data source sends the request to the next data source in the list until a valid connection is obtained, or until the end of the list is reached, in which case an exception is thrown.

• connectionPoolFailoverCallbackHandler(optional): string
  Default Value: oracle.doceng.json.BetterJsonNull@28fe508b

  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.

• dataSourceList(optional): string
  Default Value: oracle.doceng.json.BetterJsonNull@61672968

  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.

• failoverRequestIfBusy(optional): boolean
  Default Value: false

  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.

• globalTransactionsProtocol(optional): string
  Default Value: OnePhaseCommit

  Allowed Values: [ "TwoPhaseCommit", "LoggingLastResource", "EmulateTwoPhaseCommit", "OnePhaseCommit", "None" ]

  Determines the transaction protocol (global transaction processing behavior) for the data source. Options include:

  • TwoPhaseCommit - Standard XA transaction processing. Requires an XA driver.

  • LoggingLastResource - A performance enhancement for one non-XA resource.

  • EmulateTwoPhaseCommit - Enables one non-XA resource to participate in a global transaction, but has some risk to data.

  • OnePhaseCommit - One-phase XA transaction processing using a non-XA driver. This is the default setting.

  • None - Support for local transactions only.

• JNDINames(optional): array Items
  Title: Items

  The JNDI path for this Data Source. By default, the JNDI name is the name of the data source.

  Applications that look up the JNDI path get a javax.sql.DataSource instance that corresponds to this data source.

• keepConnAfterGlobalTx(optional): boolean
  Default Value: false

  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 option to true may require additional connections to be configured on the database.

  Use this setting to work around specific problems with JDBC XA drivers.

• proxySwitchingCallback(optional): string
  Default Value: oracle.doceng.json.BetterJsonNull@36e366a

  The name of the switching callback class for a Proxy data source.

  This class implements the weblogic.jdbc.extensions.DataSourceSwitchingCallback interface.

• proxySwitchingProperties(optional): string
  Default Value: oracle.doceng.json.BetterJsonNull@1fc8a3b9

  Specifies the switching properties passed to the switching callback method for a Proxy data source.

• scope(optional): string
  Default Value: Global

  Allowed Values: [ "Global", "Application" ]

  Specifies the scoping of the data source.

  You can specify one of the following scopes:

  • Global

    Specifies that the data source is bound in the cluster-wide JNDI tree with the JNDIName specified so that the data source is available for use to any JDBC client across the cluster.

    This is the default setting.

  • Application

    Specifies that the data source is bound in the application's local namespace with the JNDIName specified so that the data source is available for use only by JDBC clients within the application. This can only be used for packaged datasources and is ignored for JDBC System resources.

{
    "type":"object",
    "properties":{
        "JNDINames":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>The JNDI path for this Data Source. By default, the JNDI name is the name of the data source.</p><p>Applications that look up the JNDI path get a <code>javax.sql.DataSource</code> instance that corresponds to this data source. </p>"
        },
        "algorithmType":{
            "default":"Failover",
            "enum":[
                "Load-Balancing",
                "Failover"
            ],
            "type":"string",
            "description":"<p>The algorithm determines the connection request processing for the multi data source.</p><p>You can specify one of the following algorithm types:</p><ul><li><p><b>Failover</b></p><p>Connection requests are sent to the first data source in the list; if the request fails, the request is sent to the next data source in the list, and so forth. The process is repeated until a valid connection is obtained, or until the end of the list is reached, in which case an exception is thrown.</p></li><li><p><b>Load balancing</b></p><p>The multi data source distributes connection requests evenly to its member data sources. With this algorithm, the multi data source also provides failover processing. That is, if a request fails, the multi data source sends the request to the next data source in the list until a valid connection is obtained, or until the end of the list is reached, in which case an exception is thrown.</p></li></ul>"
        },
        "connectionPoolFailoverCallbackHandler":{
            "default":null,
            "type":"string",
            "description":"<p>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.</p><p>The name must be the absolute name of an application class that implements the <code>weblogic.jdbc.extensions.ConnectionPoolFailoverCallback</code> interface.</p>"
        },
        "dataSourceList":{
            "default":null,
            "type":"string",
            "description":"<p>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.</p>"
        },
        "failoverRequestIfBusy":{
            "default":false,
            "type":"boolean",
            "description":"<p>For multi data sources with the <code>failover</code> 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.</p>"
        },
        "globalTransactionsProtocol":{
            "default":"OnePhaseCommit",
            "enum":[
                "TwoPhaseCommit",
                "LoggingLastResource",
                "EmulateTwoPhaseCommit",
                "OnePhaseCommit",
                "None"
            ],
            "type":"string",
            "description":"<p>Determines the transaction protocol (global transaction processing behavior) for the data source. Options include:</p><ul><li><p>TwoPhaseCommit - Standard XA transaction processing. Requires an XA driver.</p></li><li><p>LoggingLastResource - A performance enhancement for one non-XA resource.</p></li><li><p>EmulateTwoPhaseCommit - Enables one non-XA resource to participate in a global transaction, but has some risk to data.</p></li><li><p>OnePhaseCommit - One-phase XA transaction processing using a non-XA driver. This is the default setting.</p></li><li><p>None - Support for local transactions only.</p></li></ul>"
        },
        "keepConnAfterGlobalTx":{
            "default":false,
            "type":"boolean",
            "description":"<p>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.</p><p>Setting this option to true may require additional connections to be configured on the database.</p><p>Use this setting to work around specific problems with JDBC XA drivers.</p>"
        },
        "proxySwitchingCallback":{
            "default":null,
            "type":"string",
            "description":"<p>The name of the switching callback class for a Proxy data source.</p><p>This class implements the <code>weblogic.jdbc.extensions.DataSourceSwitchingCallback</code> interface.</p>"
        },
        "proxySwitchingProperties":{
            "default":null,
            "type":"string",
            "description":"<p>Specifies the switching properties passed to the switching callback method for a Proxy data source.</p>"
        },
        "scope":{
            "default":"Global",
            "enum":[
                "Global",
                "Application"
            ],
            "type":"string",
            "description":"<p>Specifies the scoping of the data source.</p><p>You can specify one of the following scopes:</p><ul><li><p><b>Global</b></p><p>Specifies that the data source is bound in the cluster-wide JNDI tree with the JNDIName specified so that the data source is available for use to any JDBC client across the cluster.</p><p>This is the default setting.</p></li><li><p><b>Application</b></p><p>Specifies that the data source is bound in the application's local namespace with the JNDIName specified so that the data source is available for use only by JDBC clients within the application.  This can only be used for packaged datasources and is ignored for JDBC System resources.</p></li></ul>"
        }
    },
    "description":""
}

Nested Schema : Items

Type: array

Title: Items

The JNDI path for this Data Source. By default, the JNDI name is the name of the data source.

Applications that look up the JNDI path get a javax.sql.DataSource instance that corresponds to this data source.

Show Source

• Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>The JNDI path for this Data Source. By default, the JNDI name is the name of the data source.</p><p>Applications that look up the JNDI path get a <code>javax.sql.DataSource</code> instance that corresponds to this data source. </p>"
}

Security

• Admin: basic
  Type: basic

  Description: A user in the Admin security role.
• Deployer: basic
  Type: basic

  Description: A user in the Deployer security role.

Back to Top

Response

200 Response

Back to Top