Type-Safe Access to BEA WebLogic Server 9.0 MBeans (Deprecated)

(Methods marked with @since 9.0.0.0 are not available through the deprecated MBeanHome interface.)

weblogic.management.configuration
Interface EmbeddedLDAPMBean

All Superinterfaces:

ConfigurationMBean, weblogic.descriptor.DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, weblogic.descriptor.SettableBean, weblogic.management.WebLogicMBean

public interface EmbeddedLDAPMBean

extends ConfigurationMBean

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

Since:

7.0.0.0

Copyright © 2005 BEA Systems, Inc. All Rights Reserved.

Field Summary

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean

DEFAULT_EMPTY_BYTE_ARRAY

Method Summary

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.
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	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(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	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, getName, getNotes, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet

Methods inherited from interface weblogic.management.WebLogicMBean

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

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.descriptor.DescriptorBean

addBeanUpdateListener, addPropertyChangeListener, createChildCopy, createChildCopyIncludingObsolete, getDescriptor, getParentBean, isEditable, removeBeanUpdateListener, removePropertyChangeListener

Method Detail

getBackupCopies

public 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

Minimum value:

0

Maximum value:

65534

A dynamic MBean attribute.

false

getBackupHour

public 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

Minimum value:

0

Maximum value:

23

A dynamic MBean attribute.

false

getBackupMinute

public 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

Minimum value:

0

Maximum value:

59

A dynamic MBean attribute.

false

getCacheSize

public int getCacheSize()

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

Returns:

The cacheSize value

Default value:

32

Minimum value:

0

A dynamic MBean attribute.

false

getCacheTTL

public 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

Minimum value:

0

A dynamic MBean attribute.

false

getCredential

public 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. 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()

getCredentialEncrypted

public 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, pass an unencrypted string to the MBean server's setAttribute method. WebLogic Server encrypts the value and sets the attribute to the encrypted value.

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.

See Also:

weblogic.management.EncryptionHelper

Default value:

null

A dynamic MBean attribute.

true

getTimeout

public 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

Minimum value:

0

A dynamic MBean attribute.

false

isCacheEnabled

public 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

A dynamic MBean attribute.

false

isMasterFirst

public 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

A dynamic MBean attribute.

false

isRefreshReplicaAtStartup

public 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

A dynamic MBean attribute.

false

setAnonymousBindAllowed

public 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()

setBackupCopies

public void setBackupCopies(int copies)
                     throws InvalidAttributeValueException

Sets the value of the BackupCopies attribute.

Parameters:

copies - The new backupCopies value

Throws:

InvalidAttributeValueException

See Also:

getBackupCopies()

setBackupHour

public void setBackupHour(int hour)
                   throws InvalidAttributeValueException

Sets the value of the BackupHour attribute.

Parameters:

hour - The new backupHour value

Throws:

InvalidAttributeValueException

See Also:

getBackupHour()

setBackupMinute

public void setBackupMinute(int minute)
                     throws InvalidAttributeValueException

Sets the value of the BackupMinute attribute.

Parameters:

minute - The new backupMinute value

Throws:

InvalidAttributeValueException

See Also:

getBackupMinute()

setCacheEnabled

public void setCacheEnabled(boolean enable)

Sets the value of the isCacheEnabled attribute.

Parameters:

enable - The new cacheEnabled value

See Also:

isCacheEnabled()

setCacheSize

public void setCacheSize(int size)
                  throws InvalidAttributeValueException

Sets the value of the setCacheSize attribute.

Parameters:

size - The new cacheSize value

Throws:

InvalidAttributeValueException

See Also:

getCacheSize()

setCacheTTL

public void setCacheTTL(int ttl)
                 throws InvalidAttributeValueException

Set the value for the setCacheTTL attribute.

Parameters:

ttl - The new cacheTTL value

Throws:

InvalidAttributeValueException

See Also:

getCacheTTL()

setCredential

public void setCredential(String credential)
                   throws InvalidAttributeValueException

Sets the value of the Credential attribute.

Parameters:

credential - The new credential value

Throws:

InvalidAttributeValueException

See Also:

# @see #setCredentialEncrypted(byte[])

setCredentialEncrypted

public void setCredentialEncrypted(byte[] bytes)
                            throws InvalidAttributeValueException

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

Throws:

InvalidAttributeValueException

See Also:

getCredentialEncrypted()

setMasterFirst

public void setMasterFirst(boolean enable)

Sets the value for the MasterFirst attribute.

Parameters:

enable - The new masterFirst value

See Also:

isMasterFirst()

setRefreshReplicaAtStartup

public void setRefreshReplicaAtStartup(boolean enable)

Sets the value for the RefreshReplicaAtStartup attribute.

Parameters:

enable - The new refreshReplicaAtStartup value

See Also:

isRefreshReplicaAtStartup()

setTimeout

public void setTimeout(int seconds)

Sets the value of the Timeout attribute.

Parameters:

seconds - The new timeout value

See Also:

getTimeout()