Package weblogic.management.configuration

Interface EmbeddedLDAPMBean

All Superinterfaces:

ConfigurationMBean, DescriptorBean, javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, SettableBean, WebLogicMBean

public interface EmbeddedLDAPMBean
extends ConfigurationMBean

The MBean that defines the configuration properties for the embedded LDAP server for the WebLogic domain.

Field Summary

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean

DEFAULT_EMPTY_BYTE_ARRAY

Method Summary

Modifier and Type	Method	Description
int	getBackupCopies()	The maximum number of backup copies that should be made for the embedded LDAP server.
int	getBackupHour()	The hour at which the embedded LDAP server should be backed up.
int	getBackupMinute()	The minute at which the embedded LDAP server should be backed up.
int	getCacheSize()	The size of the cache (in kilobytes) that is used with the embedded LDAP server.
int	getCacheTTL()	The time-to-live of the cache (in seconds) that is used with the embedded LDAP server.
java.lang.String	getCredential()	The credential (usually a password) used to connect to the embedded LDAP server.
byte[]	getCredentialEncrypted()	The credential (usually password) used to connect to the embedded LDAP server.
int	getTimeout()	Specifies the maximum number of seconds to wait for results from the embedded LDAP server before timing out.
boolean	isCacheEnabled()	Specifies whether a cache is used with the embedded LDAP server.
boolean	isKeepAliveEnabled()	Whether keep alive is enabled in the socket connection
boolean	isMasterFirst()	Specifies whether a Managed Server should always connect to the master LDAP server (contained in the Administration Server), instead of connecting to the local replicated LDAP server (contained in the Managed Server).
boolean	isRefreshReplicaAtStartup()	Specifies whether a Managed Server should refresh all replicated data at boot time.
void	setAnonymousBindAllowed(boolean allowed)	Set whether anonymous connection to the embedded LDAP server is allowed.
void	setBackupCopies(int copies)	Sets the value of the BackupCopies attribute.
void	setBackupHour(int hour)	Sets the value of the BackupHour attribute.
void	setBackupMinute(int minute)	Sets the value of the BackupMinute attribute.
void	setCacheEnabled(boolean enable)	Sets the value of the isCacheEnabled attribute.
void	setCacheSize(int size)	Sets the value of the setCacheSize attribute.
void	setCacheTTL(int ttl)	Set the value for the setCacheTTL attribute.
void	setCredential(java.lang.String credential)	Sets the value of the Credential attribute.
void	setCredentialEncrypted(byte[] bytes)	Encrypts the credential and sets the value of the Credential and CredentialEncrypted attributes.
void	setKeepAliveEnabled(boolean keepAliveEnabled)
void	setMasterFirst(boolean enable)	Sets the value for the MasterFirst attribute.
void	setRefreshReplicaAtStartup(boolean enable)	Sets the value for the RefreshReplicaAtStartup attribute.
void	setTimeout(int seconds)	Sets the value of the Timeout attribute.

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean

freezeCurrentValue, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet

Methods inherited from interface weblogic.descriptor.DescriptorBean

addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preDeregister, preRegister

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Methods inherited from interface weblogic.management.WebLogicMBean

getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent

Method Detail

getCredential

java.lang.String getCredential()

The credential (usually a password) used to connect to the embedded LDAP server.

If this credential has not been set, WebLogic Server generates a password at startup, initializes the attribute, and saves the configuration to the config.xml file. If you want to connect to the embedded LDAP server using an external LDAP browser and the embedded LDAP administrator account (cn=Admin), change this attribute from the generated value.

As of 8.1 sp4, when you get the value of this attribute, WebLogic Server does the following:

1. Retrieves the value of the CredentialEncrypted attribute.
2. Decrypts the value and returns the unencrypted password as a String.

When you set the value of this attribute, WebLogic Server does the following:

1. Encrypts the value.
2. Sets the value of the CredentialEncrypted attribute to the encrypted value.

Using the Credential attribute 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 CredentialEncrypted().

Returns:

The credential value

See Also:

getCredentialEncrypted()

setCredential

void setCredential(java.lang.String credential)
            throws javax.management.InvalidAttributeValueException

Sets the value of the Credential attribute.

Parameters:

credential - The new credential value

Throws:

javax.management.InvalidAttributeValueException

See Also:

# @see #setCredentialEncrypted(byte[])

getCredentialEncrypted

byte[] getCredentialEncrypted()

The credential (usually password) used to connect to the embedded LDAP server.

If this credential has not been set, WebLogic Server generates a password at startup, initializes the attribute, and saves the configuration to the config.xml file. If you want to connect to the embedded LDAP server using an external LDAP browser and the embedded LDAP administrator account (cn=Admin), change this attribute from the generated value.

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 credential value, as an encrypted byte array.

Default Value:

null

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

setCredentialEncrypted

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

Encrypts the credential and sets the value of the Credential and CredentialEncrypted attributes.

Parameters:

bytes - The new credential value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getCredentialEncrypted()

getBackupHour

int getBackupHour()

The hour at which the embedded LDAP server should be backed up.

The Backup Hour value is used in conjunction with the Backup Minute value to determine the time at which the embedded LDAP server data files are backed up. At the specified time, WebLogic Server suspends writes to the embedded LDAP server, backs up the data files into a zip files in the ldap/backup directory, and then resumes writes.

Returns:

The backupHour value

Default Value:

23

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

Maximum Value:

23

Minimum Value:

0

setBackupHour

void setBackupHour(int hour)
            throws javax.management.InvalidAttributeValueException

Sets the value of the BackupHour attribute.

Parameters:

hour - The new backupHour value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getBackupHour()

getBackupMinute

int getBackupMinute()

The minute at which the embedded LDAP server should be backed up.

The Backup Minute value is used in conjunction with the Back Up Hour value to determine the time at which the embedded LDAP server data files are backed up

Returns:

The backupMinute value

Default Value:

5

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

Maximum Value:

59

Minimum Value:

0

setBackupMinute

void setBackupMinute(int minute)
              throws javax.management.InvalidAttributeValueException

Sets the value of the BackupMinute attribute.

Parameters:

minute - The new backupMinute value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getBackupMinute()

getBackupCopies

int getBackupCopies()

The maximum number of backup copies that should be made for the embedded LDAP server.

This value limits the number of zip files in the ldap/backup directory.

Returns:

The backupCopies value

Default Value:

7

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

Maximum Value:

65534

Minimum Value:

0

setBackupCopies

void setBackupCopies(int copies)
              throws javax.management.InvalidAttributeValueException

Sets the value of the BackupCopies attribute.

Parameters:

copies - The new backupCopies value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getBackupCopies()

isCacheEnabled

boolean isCacheEnabled()

Specifies whether a cache is used with the embedded LDAP server.

This cache is used when a managed server is reading or writing to the master embedded LDAP server that is running on the Administration server.

Returns:

The cacheEnabled value

Default Value:

true

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

setCacheEnabled

void setCacheEnabled(boolean enable)

Sets the value of the isCacheEnabled attribute.

Parameters:

enable - The new cacheEnabled value

See Also:

isCacheEnabled()

getCacheSize

int getCacheSize()

The size of the cache (in kilobytes) that is used with the embedded LDAP server.

Returns:

The cacheSize value

Default Value:

32

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

Minimum Value:

0

setCacheSize

void setCacheSize(int size)
           throws javax.management.InvalidAttributeValueException

Sets the value of the setCacheSize attribute.

Parameters:

size - The new cacheSize value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getCacheSize()

getCacheTTL

int getCacheTTL()

The time-to-live of the cache (in seconds) that is used with the embedded LDAP server.

Returns:

The cacheTTL value

Default Value:

60

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

Minimum Value:

0

setCacheTTL

void setCacheTTL(int ttl)
          throws javax.management.InvalidAttributeValueException

Set the value for the setCacheTTL attribute.

Parameters:

ttl - The new cacheTTL value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getCacheTTL()

isRefreshReplicaAtStartup

boolean isRefreshReplicaAtStartup()

Specifies whether a Managed Server should refresh all replicated data at boot time. (This is useful if you have made a large amount of changes when the Managed Server was not active, and you want to download the entire replica instead of having the Administration Server push each change to the Managed Server.)

Returns:

The refreshReplicaAtStartup value

Default Value:

false

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setRefreshReplicaAtStartup

void setRefreshReplicaAtStartup(boolean enable)

Sets the value for the RefreshReplicaAtStartup attribute.

Parameters:

enable - The new refreshReplicaAtStartup value

See Also:

isRefreshReplicaAtStartup()

isMasterFirst

boolean isMasterFirst()

Specifies whether a Managed Server should always connect to the master LDAP server (contained in the Administration Server), instead of connecting to the local replicated LDAP server (contained in the Managed Server).

Returns:

The masterFirst value

Default Value:

false

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

setMasterFirst

void setMasterFirst(boolean enable)

Sets the value for the MasterFirst attribute.

Parameters:

enable - The new masterFirst value

See Also:

isMasterFirst()

getTimeout

int getTimeout()

Specifies the maximum number of seconds to wait for results from the embedded LDAP server before timing out. If this option is set to 0, there is no maximum time limit.

Returns:

The timeout value

Default Value:

0

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

Minimum Value:

0

setTimeout

void setTimeout(int seconds)

Sets the value of the Timeout attribute.

Parameters:

seconds - The new timeout value

See Also:

getTimeout()

isKeepAliveEnabled

boolean isKeepAliveEnabled()

Whether keep alive is enabled in the socket connection

Default Value:

false

setKeepAliveEnabled

void setKeepAliveEnabled(boolean keepAliveEnabled)

Parameters:

keepAliveEnabled - whether to enable socket keep alive

setAnonymousBindAllowed

void setAnonymousBindAllowed(boolean allowed)

Set whether anonymous connection to the embedded LDAP server is allowed.

Parameters:

allowed - whether anonymous connection is allowed

See Also:

isAnonymousBindAllowed()