LDAPServerMBean (Abstract)

---

Overview  |   Related MBeans  |   Attributes  |   Operations

---

Overview

The LDAPServerMBean interface defines methods used to get/set the configuration attributes that are required to communicate with an external LDAP server.

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.utils.LDAPServerMBean
Factory Methods	No factory methods. Instances of this MBean are created automatically.
Subtypes	The following MBeans extend or implement this MBean type: ActiveDirectoryAuthenticatorMBean IPlanetAuthenticatorMBean LDAPAuthenticatorMBean LDAPX509IdentityAsserterMBean NovellAuthenticatorMBean OpenLDAPAuthenticatorMBean

---

Attributes

This section describes the following attributes:

BindAnonymouslyOnReferrals CacheEnabled CacheSize CacheTTL ConnectionRetryLimit ConnectTimeout Credential CredentialEncrypted

FollowReferrals Host ParallelConnectDelay Port Principal ResultsTimeLimit SSLEnabled

---

 

BindAnonymouslyOnReferrals

Returns whether to anonymously bind when following referrals within the LDAP directory. If set to false, then the current Principal and Credential will be used.

   

Privileges	Read/Write
Type	boolean

 

CacheEnabled

Returns whether to cache LDAP requests with the LDAP server.

   

Privileges	Read/Write
Type	boolean
Default Value	true

 

CacheSize

Returns the size of the cache in K.

   

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

 

CacheTTL

Returns the time-to-live (TTL) of the cache in seconds.

   

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

 

ConnectionRetryLimit

Specifies the number of times to attempt to connect to the LDAP server if the initial connection failed.

   

Privileges	Read/Write
Type	int
Default Value	1

 

ConnectTimeout

Returns the maximum number of seconds to wait for the LDAP connection to be established. If set to 0, there is no maximum time limit.

   

Privileges	Read/Write
Type	int
Default Value	0

 

Credential

Returns the credential (generally a password) used to authenticate the LDAP user that is defined in the Principal attribute.

For more information, see:

• getCredentialEncrypted()

   

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

 

CredentialEncrypted

Returns the credential (generally a password) used to authenticate the LDAP user that is defined in the Principal attribute.

For more information, see:

• weblogic.management.EncryptionHelper

   

Privileges	Read/Write
Type	byte[]
Encrypted	true

 

FollowReferrals

Returns whether referrals will automatically be followed within the LDAP Directory. If set to false, then a Referral exception will be thrown when referrals are encountered during LDAP requests.

   

Privileges	Read/Write
Type	boolean
Default Value	true

 

Host

Returns the host name or IP address of the LDAP server.

   

Privileges	Read/Write
Type	java.lang.String
Default Value	localhost

 

ParallelConnectDelay

Returns the number of seconds to delay when making concurrent attempts to connect to multiple servers.

If set to 0, connection attempts are serialized. An attempt is made to connect to the first server in the list. The next entry in the list is tried only if the attempt to connect to the current host fails. This might cause your application to block for unacceptably long time if a host is down. If set to greater than 0, another connection setup thread is started after this number of delay seconds has passed.

   

Privileges	Read/Write
Type	int
Default Value	0

 

Port

Returns the port number on which the LDAP server is listening.

   

Privileges	Read/Write
Type	int
Default Value	389
Minimum value	1
Maximum value	65534

 

Principal

Returns the Distinguished Name (DN) of the LDAP user that is used by WebLogic Server to connect to the LDAP server.

   

Privileges	Read/Write
Type	java.lang.String

 

ResultsTimeLimit

Returns the maximum number of milliseconds to wait for results before timing out. If set to 0, there is no maximum time limit.

   

Privileges	Read/Write
Type	int
Default Value	0

 

SSLEnabled

Returns whether SSL will be used to connect to the LDAP server.

   

Privileges	Read/Write
Type	boolean

---

Operations

This section describes the following operations:

isSet unSet

wls_getDisplayName

---

 

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
Exceptions	java.lang.IllegalArgumentException

 

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
Exceptions	java.lang.IllegalArgumentException UnsupportedOperationException if called on a runtime implementation.

 

wls_getDisplayName

Operation Name	"wls_getDisplayName"
Parameters	null
Signature	null
Returns	String