# EmbeddedLDAPMBean

Overview | Related MBeans | Attributes | Operations

## Overview

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

Since | 7.0.0.0
Fully Qualified Interface Name | If you use the `getMBeanInfo` operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name: `weblogic.management.configuration.EmbeddedLDAPMBean`
Factory Methods | No factory methods. Instances of this MBean are created automatically.
Access Points | You can access this MBean from the following MBean attributes:
DomainMBean.EmbeddedLDAP |

## Attributes

This section describes the following attributes:

AnonymousBindAllowed BackupCopies BackupHour BackupMinute CacheEnabled CacheSize CacheTTL Credential CredentialEncrypted | MasterFirst Name Notes Parent RefreshReplicaAtStartup Timeout Type

### AnonymousBindAllowed

Specifies whether the embedded LDAP server should allow anonymous connections.

Privileges | Read/Write
Type | boolean

### BackupCopies

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.

Privileges | Read/Write
Type | int
Default Value | 7
Minimum value | 0
Maximum value | 65534

### BackupHour

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.

Privileges | Read/Write
Type | int
Default Value | 23
Minimum value | 0
Maximum value | 23

### BackupMinute

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

Privileges | Read/Write
Type | int
Default Value | 5
Minimum value | 0
Maximum value | 59

### CacheEnabled

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.

Privileges | Read/Write
Type | boolean
Default Value | true

### CacheSize

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

Privileges | Read/Write
Type | int
Default Value | 32
Minimum value | 0

### CacheTTL

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

Privileges | Read/Write
Type | int
Default Value | 60
Minimum value | 0

### Credential

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

For more information, see:

- getCredentialEncrypted()

Privileges | Read/Write
Type | java.lang.String
Encrypted | true

### CredentialEncrypted

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.

For more information, see:

- weblogic.management.EncryptionHelper

Privileges | Read/Write
Type | byte[]
Encrypted | true

### MasterFirst

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

Privileges | Read/Write
Type | boolean

### Name

The user-specified name of this MBean instance.

This name is included as one of the key properties in the MBean's `javax.management.ObjectName`:
`Name=user-specified-name`

Privileges | Read/Write
Type | java.lang.String

### Notes

Optional information that you can include to describe this configuration.

WebLogic Sever saves this note in the domain's configuration file (`config.xml`) as XML PCDATA. All left angle brackets (<) are converted to the XML entity `&lt;`. Carriage returns/line feeds are preserved.

Note:

  If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

Privileges | Read/Write
Type | java.lang.String

### Parent

Return the immediate parent for this MBean

Privileges | Read/Write
Type |

### RefreshReplicaAtStartup

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

Privileges | Read/Write
Type | boolean

### Timeout

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.

Privileges | Read/Write
Type | int
Default Value | 0
Minimum value | 0

### Type

Returns the type of the MBean.

Privileges | Read only
Type | java.lang.String
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

## Operations

This section describes the following operations:

freezeCurrentValue isSet restoreDefaultValue | unSet

### freezeCurrentValue

If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.

Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.

Note:

  To insure that you are freezing the default value, invoke the `restoreDefaultValue` operation before you invoke this.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.

Deprecated. 9.0.0.0

Operation Name | `"freezeCurrentValue"`
Parameters | `Object [] { attributeName }` where: `attributeName` is an object of type `java.lang.String` that specifies: attributeName
Signature | `String [] { "java.lang.String" }`
Returns | `void`
Exceptions | `javax.management.AttributeNotFoundException` `javax.management.MBeanException`

### isSet

Returns true if the specified attribute has been set explicitly in this MBean instance.

Operation Name | `"isSet"`
Parameters | `Object [] { propertyName }` where: `propertyName` is an object of type `java.lang.String` that specifies: property to check
Signature | `String [] { "java.lang.String" }`
Returns | `boolean`

### restoreDefaultValue

If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.

Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the `freezeCurrentValue` operation.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.

Deprecated. 9.0.0.0

Operation Name | `"restoreDefaultValue"`
Parameters | `Object [] { attributeName }` where: `attributeName` is an object of type `java.lang.String` that specifies: attributeName
Signature | `String [] { "java.lang.String" }`
Returns | `void`
Exceptions | `javax.management.AttributeNotFoundException`

### unSet

Restore the given property to its default value.

Operation Name | `"unSet"`
Parameters | `Object [] { propertyName }` where: `propertyName` is an object of type `java.lang.String` that specifies: property to restore
Signature | `String [] { "java.lang.String" }`
Returns | `void`