Package weblogic.management.security

Interface RDBMSSecurityStoreMBean

All Superinterfaces:

DescriptorBean, SettableBean, StandardInterface

public interface RDBMSSecurityStoreMBean
extends StandardInterface, DescriptorBean

The MBean that represents configuration attributes for a RDBMS security store. It is used to specify the required and optional properties for connecting to a RDBMS back-end store.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getConnectionProperties()	The JDBC driver specific connection parameters.
java.lang.String	getConnectionURL()	The URL of the database to which to connect.
java.lang.String	getDriverName()	The full package name of the JDBC driver class used to create the physical database connections in the connection pool.
int	getJMSExceptionReconnectAttempts()	The number of times to attempt to reconnect if the JMS system notifies Kodo of a serious connection error.
java.lang.String	getJMSTopic()	The JMS topic to which the Kodo remote commit provider should publish notifications and subscribe for notifications sent from other JVMs.
java.lang.String	getJMSTopicConnectionFactory()	The JNDI name of a javax.jms.TopicConnectionFactory instance to use for finding JMS topics.
java.lang.String	getJNDIPassword()	The password to authenticate the user defined in the JNDIUsername attribute for Kodo notification.
byte[]	getJNDIPasswordEncrypted()	Returns the encrypted password to authenticate the user defined in the JNDIUsername attribute for Kodo notification.
java.lang.String	getJNDIUsername()	The JNDI user name used for Kodo notification.
java.lang.String	getName()	The name of this configuration.
java.lang.String	getNotificationProperties()	The comma-delimited list of key-value properties to pass to the JNDI InitialContext on construction, in the form of xxKey=xxValue, xxKey=xxValue.
java.lang.String	getPassword()	The password for the user specified in the Username attribute for connecting to the datastore.
byte[]	getPasswordEncrypted()	Returns the encrypted password to authenticate the user defined in the Username attribute when connecting to the data store.
RealmMBean	getRealm()	Returns the realm that contains this RDBMS security store.
java.lang.String	getUsername()	The username to use when connecting to the datastore.
void	setConnectionProperties(java.lang.String connectionProperties)	Sets the value of the ConnectionProperties attribute.
void	setConnectionURL(java.lang.String connectionURL)	Sets the value of the ConnectionURL attribute.
void	setDriverName(java.lang.String driverName)	Sets the value of the DriverName attribute.
void	setJMSExceptionReconnectAttempts(int jmsExceptionReconnectAttempts)	Sets the value of the JMSExceptionReconnectAttempts attribute.
void	setJMSTopic(java.lang.String jmsTopic)	Sets the value of the JMSTopic attribute.
void	setJMSTopicConnectionFactory(java.lang.String jmsTopicConnectionFactory)	Sets the value of the JMSTopicConnectionFactory attribute.
void	setJNDIPassword(java.lang.String password)	Sets the value of the JNDIPassword attribute.
void	setJNDIPasswordEncrypted(byte[] bytes)	Encrypts the JNDI password and sets the value of the JNDIPasswordEncrypted attribute.
void	setJNDIUsername(java.lang.String username)	Sets the value of the JNDI Username attribute.
void	setNotificationProperties(java.lang.String notificationProperties)	Sets the value of the NotificationProperties attribute.
void	setPassword(java.lang.String password)	Sets the value of the Password attribute.
void	setPasswordEncrypted(byte[] bytes)	Encrypts the user password and sets the value of the PasswordEncrypted attribute.
void	setUsername(java.lang.String username)	Sets the value of the Username attribute.

Methods inherited from interface weblogic.descriptor.DescriptorBean

addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener

Method Detail

getUsername

java.lang.String getUsername()

The username to use when connecting to the datastore.

Returns:

the value of the Username attribute

setUsername

void setUsername(java.lang.String username)
          throws javax.management.InvalidAttributeValueException

Sets the value of the Username attribute.

The string value must be explicitly specified and satisfy the constraint (value != null) && (value.trim().length() > 0.

Parameters:

username - the new Username value

Throws:

javax.management.InvalidAttributeValueException

This property cannot be null.

This property cannot have a value of length zero.

getPassword

java.lang.String getPassword()

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.

Returns:

the value of the Password attribute

See Also:

getPasswordEncrypted()

setPassword

void setPassword(java.lang.String password)
          throws javax.management.InvalidAttributeValueException

Sets the value of the Password attribute.

Parameters:

password - the new Password value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getPassword(), setPasswordEncrypted(byte[])

getPasswordEncrypted

byte[] getPasswordEncrypted()

Returns the encrypted password to authenticate the user defined in the Username attribute when connecting to the data store.

To set this attribute, use weblogic.management.EncryptionHelper.encrypt() to encrypt the value. Then set this attribute to the output of the encrypt() method.

To compare a password that a user enters with the encrypted value of this attribute, go to the same WebLogic Server instance that you used to set and encrypt this attribute and use weblogic.management.EncryptionHelper.encrypt() to encrypt the user-supplied password. Then compare the encrypted values.

Returns:

the PasswordEncrypted value as an encrypted byte array

setPasswordEncrypted

void setPasswordEncrypted(byte[] bytes)
                   throws javax.management.InvalidAttributeValueException

Encrypts the user password and sets the value of the PasswordEncrypted attribute.

Parameters:

bytes - the new password value as a byte array

Throws:

javax.management.InvalidAttributeValueException

See Also:

getPasswordEncrypted()

getJNDIUsername

java.lang.String getJNDIUsername()

The JNDI user name used for Kodo notification.

Returns:

the value of the JNDIUsername attribute

setJNDIUsername

void setJNDIUsername(java.lang.String username)
              throws javax.management.InvalidAttributeValueException

Sets the value of the JNDI Username attribute.

Parameters:

username - the new JNDIUsername value

Throws:

javax.management.InvalidAttributeValueException

getJNDIPassword

java.lang.String getJNDIPassword()

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.

Returns:

the value of the Password attribute

See Also:

getJNDIPasswordEncrypted()

setJNDIPassword

void setJNDIPassword(java.lang.String password)
              throws javax.management.InvalidAttributeValueException

Sets the value of the JNDIPassword attribute.

Parameters:

password - the new JNDIPassword value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getJNDIPassword(), setJNDIPasswordEncrypted(byte[])

getJNDIPasswordEncrypted

byte[] getJNDIPasswordEncrypted()

Returns the encrypted password to authenticate the user defined in the JNDIUsername attribute for Kodo notification.

To set this attribute, use weblogic.management.EncryptionHelper.encrypt() to encrypt the value. Then set this attribute to the output of the encrypt() method.

To compare a password that a user enters with the encrypted value of this attribute, go to the same WebLogic Server instance that you used to set and encrypt this attribute and use weblogic.management.EncryptionHelper.encrypt() to encrypt the user-supplied password. Then compare the encrypted values.

Returns:

the JNDIPasswordEncrypted value as an encrypted byte array

setJNDIPasswordEncrypted

void setJNDIPasswordEncrypted(byte[] bytes)
                       throws javax.management.InvalidAttributeValueException

Encrypts the JNDI password and sets the value of the JNDIPasswordEncrypted attribute.

Parameters:

bytes - the new password value as a byte array

Throws:

javax.management.InvalidAttributeValueException

See Also:

getPasswordEncrypted()

getConnectionURL

java.lang.String getConnectionURL()

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.

Returns:

the value of the ConnectionURL attribute

setConnectionURL

void setConnectionURL(java.lang.String connectionURL)
               throws javax.management.InvalidAttributeValueException

Sets the value of the ConnectionURL attribute.

The string value must be explicitly specified and satisfy the constraint (value != null) && (value.trim().length() > 0.

Parameters:

connectionURL - the new ConnectionURL value

Throws:

javax.management.InvalidAttributeValueException

This property cannot be null.

This property cannot have a value of length zero.

getDriverName

java.lang.String getDriverName()

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.

Returns:

the value of the DriverName attribute

setDriverName

void setDriverName(java.lang.String driverName)
            throws javax.management.InvalidAttributeValueException

Sets the value of the DriverName attribute.

The string value must be explicitly specified and satisfy the constraint (value != null) && (value.trim().length() > 0.

Parameters:

driverName - the new DriverName value

Throws:

javax.management.InvalidAttributeValueException

This property cannot be null.

This property cannot have a value of length zero.

getConnectionProperties

java.lang.String getConnectionProperties()

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.

Returns:

the value of the ConnectionProperties attribute

setConnectionProperties

void setConnectionProperties(java.lang.String connectionProperties)
                      throws javax.management.InvalidAttributeValueException

Sets the value of the ConnectionProperties attribute.

Parameters:

connectionProperties - the new ConnectionProperties value

Throws:

javax.management.InvalidAttributeValueException

getJMSTopic

java.lang.String getJMSTopic()

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.

Returns:

the value of the JMSTopic attribute

setJMSTopic

void setJMSTopic(java.lang.String jmsTopic)
          throws javax.management.InvalidAttributeValueException

Sets the value of the JMSTopic attribute.

Parameters:

jmsTopic - the new JMSTopic value

Throws:

javax.management.InvalidAttributeValueException

getJMSTopicConnectionFactory

java.lang.String getJMSTopicConnectionFactory()

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.

Returns:

the value of the JMSTopicConnectionFactory attribute

setJMSTopicConnectionFactory

void setJMSTopicConnectionFactory(java.lang.String jmsTopicConnectionFactory)
                           throws javax.management.InvalidAttributeValueException

Sets the value of the JMSTopicConnectionFactory attribute.

Parameters:

jmsTopicConnectionFactory - the new JMSTopicConnectionFactory value

Throws:

javax.management.InvalidAttributeValueException

getJMSExceptionReconnectAttempts

int getJMSExceptionReconnectAttempts()

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.

Returns:

the value of the JMSExceptionReconnectAttempts attribute

setJMSExceptionReconnectAttempts

void setJMSExceptionReconnectAttempts(int jmsExceptionReconnectAttempts)
                               throws javax.management.InvalidAttributeValueException

Sets the value of the JMSExceptionReconnectAttempts attribute.

Parameters:

jmsExceptionReconnectAttempts - the new JMSExceptionReconnectAttempts value

Throws:

javax.management.InvalidAttributeValueException

Default Value:

0

Minimum Value:

0

getNotificationProperties

java.lang.String getNotificationProperties()

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.

Returns:

the value of NotificationProperties attribute

setNotificationProperties

void setNotificationProperties(java.lang.String notificationProperties)
                        throws javax.management.InvalidAttributeValueException

Sets the value of the NotificationProperties attribute.

Parameters:

notificationProperties - the new NotificationProperties value

Throws:

javax.management.InvalidAttributeValueException

getRealm

RealmMBean getRealm()

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

Returns:

the Realm that contains this MBean

getName

java.lang.String getName()

The name of this configuration.

Specified by:

getName in interface StandardInterface

Returns:

the value of the Name attribute

Default Value:

"RDBMSSecurityStore"