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 NameIf 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:


Attributes

This section describes the following attributes:


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
Typeboolean

CacheEnabled

Returns whether to cache LDAP requests with the LDAP server.

       
Privileges Read/Write
Typeboolean
Default Valuetrue

CacheSize

Returns the size of the cache in K.

       
Privileges Read/Write
Typeint
Default Value32
Minimum value0

CacheTTL

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

       
Privileges Read/Write
Typeint
Default Value60
Minimum value0

ConnectionPoolSize

The LDAP connection pool size. Default is 6.

       
Privileges Read/Write
Typeint
Default Value6

ConnectionRetryLimit

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

       
Privileges Read/Write
Typeint
Default Value1

ConnectTimeout

Returns the maximum number of seconds to wait for the LDAP connection to be established.

       
Privileges Read/Write
Typeint
Default Value0

Credential

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

For more information, see:

       
Privileges Read/Write
Typejava.lang.String
Encryptedtrue

CredentialEncrypted

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

       
Privileges Read/Write
Typebyte[]
Encryptedtrue

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
Typeboolean
Default Valuetrue

Host

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

       
Privileges Read/Write
Typejava.lang.String
Default Valuelocalhost

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
Typeint
Default Value0

Port

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

       
Privileges Read/Write
Typeint
Default Value389
Minimum value1
Maximum value65534

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
Typejava.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
Typeint
Default Value0

SSLEnabled

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

       
Privileges Read/Write
Typeboolean


Operations

This section describes the following operations:


isSet

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

   
Operation Name"isSet"
ParametersObject [] {  propertyName }

where:

  • propertyName is an object of type java.lang.String that specifies:

    property to check

SignatureString [] { "java.lang.String" }
Returns boolean
Exceptions
  • java.lang.IllegalArgumentException

unSet

Restore the given property to its default value.

   
Operation Name"unSet"
ParametersObject [] {  propertyName }

where:

  • propertyName is an object of type java.lang.String that specifies:

    property to restore

SignatureString [] { "java.lang.String" }
Returns void
Exceptions
  • java.lang.IllegalArgumentException
    UnsupportedOperationException if called on a runtime implementation.

wls_getDisplayName

Returns the display name of an MBean.

Deprecated 9.0.0.0

   
Operation Name"wls_getDisplayName"
Parametersnull
Signaturenull
ReturnsString