weblogic.management.utils
Interface LDAPServerMBean

All Known Subinterfaces:

ActiveDirectoryAuthenticatorMBean, IPlanetAuthenticatorMBean, LDAPAuthenticatorMBean, LDAPX509IdentityAsserterMBean, NovellAuthenticatorMBean, OpenLDAPAuthenticatorMBean, OracleInternetDirectoryAuthenticatorMBean, OracleVirtualDirectoryAuthenticatorMBean

public interface LDAPServerMBean

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

Deprecation of MBeanHome and Type-Safe Interfaces

In addition to being used as a base class that provides functionality to security provider MBeans, JMX applications can use this class directly as a type-safe interface. When used as a type-safe interface, a JMX application imports this class and accesses it through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, JMX applications that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime.

getHost

String getHost()

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

Default Value:

"localhost"

setHost

void setHost(String host)
             throws InvalidAttributeValueException

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

Parameters:

host - - the new host name

Throws:

InvalidAttributeValueException

See Also:

LDAPServerMBean.getHost()

getPort

int getPort()

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

Default Value:

389

Maximum Value:

65534

Minimum Value:

1

setPort

void setPort(int port)
             throws InvalidAttributeValueException

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

Parameters:

port - - the new port number

Throws:

InvalidAttributeValueException

See Also:

LDAPServerMBean.getPort()

isSSLEnabled

boolean isSSLEnabled()

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

Default Value:

false

setSSLEnabled

void setSSLEnabled(boolean enabled)
                   throws InvalidAttributeValueException

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

Parameters:

enabled - - the new SSL enabled value

Throws:

InvalidAttributeValueException

See Also:

LDAPServerMBean.isSSLEnabled()

getPrincipal

String getPrincipal()

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

setPrincipal

void setPrincipal(String principal)
                  throws InvalidAttributeValueException

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

Parameters:

principal - - the new principal name

Throws:

InvalidAttributeValueException

See Also:

LDAPServerMBean.getPrincipal()

getCredential

String getCredential()

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

See Also:

LDAPServerMBean.getCredentialEncrypted()

setCredential

void setCredential(String credential)
                   throws InvalidAttributeValueException

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

Parameters:

credential - - the new credential

Throws:

InvalidAttributeValueException

See Also:

LDAPServerMBean.getCredential(), LDAPServerMBean.setCredentialEncrypted(byte[])

getCredentialEncrypted

byte[] getCredentialEncrypted()

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

Returns:

The credential value as an encrypted byte array.

Default Value:

null

setCredentialEncrypted

void setCredentialEncrypted(byte[] bytes)
                            throws InvalidAttributeValueException

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

Parameters:

bytes - The new credential value as a byte array.

Throws:

InvalidAttributeValueException

See Also:

LDAPServerMBean.getCredentialEncrypted()

isCacheEnabled

boolean isCacheEnabled()

Returns whether to cache LDAP requests with the LDAP server.

Default Value:

true

setCacheEnabled

void setCacheEnabled(boolean enabled)
                     throws InvalidAttributeValueException

Sets whether to cache LDAP requests with the LDAP server.

Parameters:

enabled - - the new cache enabled value

Throws:

InvalidAttributeValueException

See Also:

LDAPServerMBean.isCacheEnabled()

getCacheSize

int getCacheSize()

Returns the size of the cache in K.

Default Value:

32

Minimum Value:

0

setCacheSize

void setCacheSize(int size)
                  throws InvalidAttributeValueException

Sets the size of the cache in K.

Parameters:

size - - the new cache size

Throws:

InvalidAttributeValueException

See Also:

LDAPServerMBean.getCacheSize()

getCacheTTL

int getCacheTTL()

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

Default Value:

60

Minimum Value:

0

setCacheTTL

void setCacheTTL(int TTL)
                 throws InvalidAttributeValueException

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

Parameters:

TTL - - the new cache time to live

Throws:

InvalidAttributeValueException

See Also:

LDAPServerMBean.getCacheTTL()

isFollowReferrals

boolean isFollowReferrals()

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.

Default Value:

true

setFollowReferrals

void setFollowReferrals(boolean followReferrals)
                        throws InvalidAttributeValueException

Sets whether referrals will automatically be followed within the LDAP Directory.

Parameters:

followReferrals - - the new follow referrals value

Throws:

InvalidAttributeValueException

See Also:

LDAPServerMBean.isFollowReferrals()

isBindAnonymouslyOnReferrals

boolean isBindAnonymouslyOnReferrals()

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.

Default Value:

false

setBindAnonymouslyOnReferrals

void setBindAnonymouslyOnReferrals(boolean bindAnonymouslyOnReferrals)
                                   throws InvalidAttributeValueException

Sets whether to anonymously bind when following referrals within the LDAP directory.

Parameters:

bindAnonymouslyOnReferrals - - the new bind anonymously on referrals value

Throws:

InvalidAttributeValueException

See Also:

LDAPServerMBean.isBindAnonymouslyOnReferrals()

getResultsTimeLimit

int getResultsTimeLimit()

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

Default Value:

0

setResultsTimeLimit

void setResultsTimeLimit(int timeLimit)
                         throws InvalidAttributeValueException

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

The default setting is 0. This default value can result in a slowdown in WebLogic Server execution if the LDAP server is unavailable. In addition, if WebLogic Server has multiple LDAP Authentication providers configured, the failure to connect to one LDAP server may block the use of the other LDAP Authentication providers.

Oracle recommends that you specify a non-zero value; for example, 60 seconds.

Parameters:

timeLimit - - the new results time limit

Throws:

InvalidAttributeValueException

See Also:

LDAPServerMBean.getResultsTimeLimit()

getConnectTimeout

int getConnectTimeout()

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

Default Value:

0

setConnectTimeout

void setConnectTimeout(int timeout)
                       throws InvalidAttributeValueException

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

Parameters:

timeout - - the new connect timeout

Throws:

InvalidAttributeValueException

See Also:

LDAPServerMBean.getConnectTimeout()

getParallelConnectDelay

int getParallelConnectDelay()

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.

Default Value:

0

setParallelConnectDelay

void setParallelConnectDelay(int delay)
                             throws InvalidAttributeValueException

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

Parameters:

delay - - the new parallel connect delay

Throws:

InvalidAttributeValueException

See Also:

LDAPServerMBean.getParallelConnectDelay()

getConnectionRetryLimit

int getConnectionRetryLimit()

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

Default Value:

1

setConnectionRetryLimit

void setConnectionRetryLimit(int limit)
                             throws InvalidAttributeValueException

Parameters:

limit - - number of times connection should tried.

Throws:

InvalidAttributeValueException

See Also:

LDAPServerMBean.getConnectionRetryLimit()

getConnectionPoolSize

int getConnectionPoolSize()

The LDAP connection pool size. Default is 6.

Changes take effect after you redeploy the module or restart the server.

Default Value:

6

setConnectionPoolSize

void setConnectionPoolSize(int size)
                           throws InvalidAttributeValueException

Parameters:

size - the LDAP connection pool size

Throws:

InvalidAttributeValueException