RESTful Server Configuration Management Interface for Oracle WebLogic Server

View This RDBMS Security Store

get

/management/weblogic/{version}/serverConfig/securityConfiguration/realms/{name}/RDBMSSecurityStore

View this RDBMS security store.

Request

Path Parameters

name: string

The name property of the instance in the collection.
version: string

The version of the WebLogic REST interface.

Query Parameters

excludeFields(optional): string

The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
excludeLinks(optional): string

The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
fields(optional): string

The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
links(optional): string

The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.

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.
Monitor: basic

Type: basic

Description: A user in the Monitor security role.
Operator: basic

Type: basic

Description: A user in the Operator security role.

Response

Supported Media Types

application/json

200 Response

Returns this RDBMS security store.

This method can return the following links:

rel=realm
This resource's realm reference to a realm resource.

Root Schema : RDBMS Security Store

Type: object

Show Source

connectionProperties(optional): string

The JDBC driver specific connection parameters. This attribute is a comma-delimited list of key-value properties to pass to the driver for configuration of JDBC connection pool, in the form of xxKey=xxValue, xxKey=xxValue
The syntax of the attribute will be validated and an InvalidAttributeValueException is thrown if the check failed.
connectionURL(optional): string
The URL of the database to which to connect. The format of the URL varies by JDBC driver.
The URL is passed to the JDBC driver to create the physical database connections.
Constraints
- legal null
driverName(optional): string
The full package name of the JDBC driver class used to create the physical database connections in the connection pool. Note that this driver class must be in the classpath of any server to which it is deployed.
For example:
- oracle.jdbc.OracleDriver
- com.microsoft.sqlserver.jdbc.SQLServerDriver
It must be the name of a class that implements the java.sql.Driver interface. The full pathname of the JDBC driver is available in the documentation.
Constraints
- legal null
JMSExceptionReconnectAttempts(optional): integer(int32)

Minimum Value: 0

Default Value: 0

The number of times to attempt to reconnect if the JMS system notifies Kodo of a serious connection error.
The default is 0, and by default the error is logged but ignored. The value cannot be less than 0.
JMSTopic(optional): string

The JMS topic to which the Kodo remote commit provider should publish notifications and subscribe for notifications sent from other JVMs. This setting varies depending on the application server in use.
JMSTopicConnectionFactory(optional): string

The JNDI name of a javax.jms.TopicConnectionFactory instance to use for finding JMS topics.
This setting varies depending on the application server in use. Consult the JMS documentation for details about how this parameter should be specified.
JNDIPassword(optional): string(password)
The password to authenticate the user defined in the JNDIUsername attribute for Kodo notification.
When getting the value of this attribute, WebLogic Server does the following:
- Retrieves the value of the JNDIPasswordEncrypted attribute.
- Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
- Encrypts the value.
- Sets the value of the JNDIPasswordEncrypted attribute to the encrypted value.
Using this attribute (JNDIPassword) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use JNDIPasswordEncrypted
JNDIUsername(optional): string

The JNDI user name used for Kodo notification.
name(optional): string

Read Only: true

Default Value: RDBMSSecurityStore

The name of this configuration.
notificationProperties(optional): string
The comma-delimited list of key-value properties to pass to the JNDI InitialContext on construction, in the form of xxKey=xxValue, xxKey=xxValue
The following are examples of keys:
- java.naming.provider.url: property for specifying configuration information for the service provider to use. The value of the property should contain a URL string (For example: iiops://localhost:7002).
- java.naming.factory.initial: property for specifying the initial context factory to use. The value of the property should be the fully qualified class name of the factory class that will create an initial context (For example: weblogic.jndi.WLInitialContextFactory).
When setting the attribute, the syntax of its value is validated, and an InvalidAttributeValueException is thrown if the check fails.
password(optional): string(password)
The password for the user specified in the Username attribute for connecting to the datastore.
When getting the value of this attribute, WebLogic Server does the following:
- Retrieves the value of the PasswordEncrypted attribute.
- Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
- Encrypts the value.
- Sets the value of the PasswordEncrypted attribute to the encrypted value.
Note that use of the Password attribute is a potential security risk because the String object that contains the unencrypted password remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use PasswordEncrypted
realm(optional): array Realm Reference

Title: Realm Reference

Read Only: true

Contains the realm reference.
Returns the realm that contains this RDBMS security store. Returns null if this RDBMS security store is not contained by a realm.
username(optional): string
The username to use when connecting to the datastore.
Constraints
- legal null

{
    "type":"object",
    "properties":{
        "JMSExceptionReconnectAttempts":{
            "default":0,
            "minimum":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>The number of times to attempt to reconnect if the JMS system notifies Kodo of a serious connection error.</p><p>The default is 0, and by default the error is logged but ignored. The value cannot be less than 0.</p>"
        },
        "JMSTopic":{
            "type":"string",
            "description":"<p>The JMS topic to which the Kodo remote commit provider should publish notifications and subscribe for notifications sent from other JVMs. This setting varies depending on the application server in use.</p>"
        },
        "JMSTopicConnectionFactory":{
            "type":"string",
            "description":"<p>The JNDI name of a <code>javax.jms.TopicConnectionFactory</code> instance to use for finding JMS topics.</p><p>This setting varies depending on the application server in use. Consult the JMS documentation for details about how this parameter should be specified.</p>"
        },
        "JNDIPassword":{
            "type":"string",
            "format":"password",
            "description":"<p>The password to authenticate the user defined in the <code>JNDIUsername</code> attribute for Kodo notification.</p><p>When getting the value of this attribute, WebLogic Server does the following:</p><ul><li><p>Retrieves the value of the <code>JNDIPasswordEncrypted</code> attribute.</p></li><li><p>Decrypts the value and returns the unencrypted password as a String. </p></li></ul><p>When you set the value of this attribute, WebLogic Server does the following:</p><ul><li><p>Encrypts the value.</p></li><li><p>Sets the value of the <code>JNDIPasswordEncrypted</code> attribute to the encrypted value.</p></li></ul><p>Using this attribute (<code>JNDIPassword</code>) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.</p><p>Instead of using this attribute, use <code>JNDIPasswordEncrypted</code></p>"
        },
        "JNDIUsername":{
            "type":"string",
            "description":"<p>The JNDI user name used for Kodo notification.</p>"
        },
        "connectionProperties":{
            "type":"string",
            "description":"<p>The JDBC driver specific connection parameters. This attribute is a comma-delimited list of key-value properties to pass to the driver for configuration of JDBC connection pool, in the form of <code><i>xx</i>Key=<i>xx</i>Value, <i>xx</i>Key=<i>xx</i>Value</code></p><p>The syntax of the attribute will be validated and an <code>InvalidAttributeValueException</code> is thrown if the check failed.</p>"
        },
        "connectionURL":{
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The URL of the database to which to connect. The format of the URL varies by JDBC driver.</p><p>The URL is passed to the JDBC driver to create the physical database connections.</p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "driverName":{
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The full package name of the JDBC driver class used to create the physical database connections in the connection pool. Note that this driver class must be in the classpath of any server to which it is deployed.</p><p>For example:</p><ul><li><p><code>oracle.jdbc.OracleDriver</code></p></li><li><p><code>com.microsoft.sqlserver.jdbc.SQLServerDriver</code></p></li></ul><p>It must be the name of a class that implements the <code>java.sql.Driver</code> interface. The full pathname of the JDBC driver is available in the documentation. </p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "name":{
            "readOnly":true,
            "default":"RDBMSSecurityStore",
            "type":"string",
            "description":"<p>The name of this configuration.</p>"
        },
        "notificationProperties":{
            "type":"string",
            "description":"<p>The comma-delimited list of key-value properties to pass to the JNDI InitialContext on construction, in the form of <code><i>xx</i>Key=<i>xx</i>Value, <i>xx</i>Key=<i>xx</i>Value</code></p><p>The following are examples of keys:</p><ul><li><p><code>java.naming.provider.url:</code> property for specifying configuration information for the service provider to use. The value of the property should contain a URL string (For example: <code>iiops://localhost:7002</code>).</p></li><li><p><code>java.naming.factory.initial:</code> property for specifying the initial context factory to use. The value of the property should be the fully qualified class name of the factory class that will create an initial context (For example: <code>weblogic.jndi.WLInitialContextFactory</code>).</p></li></ul><p>When setting the attribute, the syntax of its value is validated, and an <code>InvalidAttributeValueException</code> is thrown if the check fails.</p>"
        },
        "password":{
            "type":"string",
            "format":"password",
            "description":"<p>The password for the user specified in the <code>Username</code> attribute for connecting to the datastore.</p><p>When getting the value of this attribute, WebLogic Server does the following:</p><ul><li><p>Retrieves the value of the <code>PasswordEncrypted</code> attribute.</p></li><li><p>Decrypts the value and returns the unencrypted password as a String.</p></li></ul><p>When you set the value of this attribute, WebLogic Server does the following:</p><ul><li><p>Encrypts the value.</p></li><li><p>Sets the value of the <code>PasswordEncrypted</code> attribute to the encrypted value.</p></li></ul><p>Note that use of the <code>Password</code> attribute is a potential security risk because the String object that contains the unencrypted password remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.</p><p>Instead of using this attribute, use <code>PasswordEncrypted</code></p>"
        },
        "realm":{
            "readOnly":true,
            "title":"Realm Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the realm reference. <p>Returns the realm that contains this RDBMS security store. Returns null if this RDBMS security store is not contained by a realm.</p>"
        },
        "username":{
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The username to use when connecting to the datastore.</p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        }
    },
    "description":""
}

Nested Schema : Realm Reference

Type: array

Title: Realm Reference

Read Only: true

Contains the realm reference.

Returns the realm that contains this RDBMS security store. Returns null if this RDBMS security store is not contained by a realm.

Show Source

Array of: string

{
    "readOnly":true,
    "title":"Realm Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the realm reference. <p>Returns the realm that contains this RDBMS security store. Returns null if this RDBMS security store is not contained by a realm.</p>"
}