WebLogic Server 8.1 API Reference

weblogic.management.utils
Interface LDAPServerMBean

All Known Subinterfaces:

ActiveDirectoryAuthenticatorMBean, IPlanetAuthenticatorMBean, LDAPAuthenticatorMBean, NovellAuthenticatorMBean, OpenLDAPAuthenticatorMBean

public interface LDAPServerMBean

extends weblogic.management.commo.StandardInterface

Defines configuration information for an LDAP server.

@author Copyright (c) 2002 BEA Systems, Inc. All Rights Reserved.

Author:

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

Method Summary

int	getCacheSize() The size of the cache in K.
int	getCacheTTL() The time-to-live (TTL) of the cache in seconds.
int	getConnectTimeout() Specifies the maximum time in seconds to wait for the LDAP connection to be established.
java.lang.String	getCredential() The credential (generally a password) used to authenticate the LDAP user defined in the Principal attribute.
java.lang.String	getHost() The host name or IP address of the LDAP server.
int	getParallelConnectDelay() Specifies the delay in seconds when making concurrent attempts to connect to multiple servers.
int	getPort() The port number on which the LDAP server is listening.
java.lang.String	getPrincipal() Distinguished Name (DN) of the LDAP user used by WebLogic Server to connect to the LDAP server.
int	getResultsTimeLimit() Specifies the maximum number of milliseconds to wait for results before timing out.
boolean	isBindAnonymouslyOnReferrals() Enables anonymous binding when following referrals within the LDAP directory.
boolean	isCacheEnabled() Enables the use of a cache with the LDAP server.
boolean	isFollowReferrals() Enables automatic following of referrals within the LDAP directory.
boolean	isSSLEnabled() The option to enable the use of the SSL protocol when connecting to the LDAP server.
void	setBindAnonymouslyOnReferrals(boolean newValue) Enables anonymous binding when following referrals within the LDAP directory.
void	setCacheEnabled(boolean newValue) Enables the use of a cache with the LDAP server.
void	setCacheSize(int newValue) The size of the cache in K.
void	setCacheTTL(int newValue) The time-to-live (TTL) of the cache in seconds.
void	setConnectTimeout(int newValue) Specifies the maximum time in seconds to wait for the LDAP connection to be established.
void	setCredential(java.lang.String newValue) The credential (generally a password) used to authenticate the LDAP user defined in the Principal attribute.
void	setFollowReferrals(boolean newValue) Enables automatic following of referrals within the LDAP directory.
void	setHost(java.lang.String newValue) The host name or IP address of the LDAP server.
void	setParallelConnectDelay(int newValue) Specifies the delay in seconds when making concurrent attempts to connect to multiple servers.
void	setPort(int newValue) The port number on which the LDAP server is listening.
void	setPrincipal(java.lang.String newValue) Distinguished Name (DN) of the LDAP user used by WebLogic Server to connect to the LDAP server.
void	setResultsTimeLimit(int newValue) Specifies the maximum number of milliseconds to wait for results before timing out.
void	setSSLEnabled(boolean newValue) The option to enable the use of the SSL protocol when connecting to the LDAP server.

Methods inherited from interface weblogic.management.commo.StandardInterface

wls_getAttributeTag, wls_getConstructorTag, wls_getDisplayName, wls_getInterfaceClassName, wls_getMBeanTag, wls_getNotificationTag, wls_getObjectName, wls_getOperationTag, wls_instanceOf

Method Detail

getHost

public java.lang.String getHost()

The host name or IP address of the LDAP server.

Default Value: "localhost"

setHost

public void setHost(java.lang.String newValue)
             throws javax.management.InvalidAttributeValueException

The host name or IP address of the LDAP server.

Default Value: "localhost"

Parameters:

newValue - - new value for attribute Host

Throws:

javax.management.InvalidAttributeValueException -

getPort

public int getPort()

The port number on which the LDAP server is listening.

Default Value: new java.lang.Integer(389)

Legal Minimum Value: 1

Legal Maximum Value: 65534

setPort

public void setPort(int newValue)
             throws javax.management.InvalidAttributeValueException

The port number on which the LDAP server is listening.

Default Value: new java.lang.Integer(389)

Legal Minimum Value: 1

Legal Maximum Value: 65534

Parameters:

newValue - - new value for attribute Port

Throws:

javax.management.InvalidAttributeValueException -

isSSLEnabled

public boolean isSSLEnabled()

The option to enable the use of the SSL protocol when connecting to the LDAP server.

Default Value: new java.lang.Boolean(false)

setSSLEnabled

public void setSSLEnabled(boolean newValue)
                   throws javax.management.InvalidAttributeValueException

The option to enable the use of the SSL protocol when connecting to the LDAP server.

Default Value: new java.lang.Boolean(false)

Parameters:

newValue - - new value for attribute SSLEnabled

Throws:

javax.management.InvalidAttributeValueException -

getPrincipal

public java.lang.String getPrincipal()

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

setPrincipal

public void setPrincipal(java.lang.String newValue)
                  throws javax.management.InvalidAttributeValueException

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

Parameters:

newValue - - new value for attribute Principal

Throws:

javax.management.InvalidAttributeValueException -

getCredential

public java.lang.String getCredential()

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

setCredential

public void setCredential(java.lang.String newValue)
                   throws javax.management.InvalidAttributeValueException

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

Parameters:

newValue - - new value for attribute Credential

Throws:

javax.management.InvalidAttributeValueException -

isCacheEnabled

public boolean isCacheEnabled()

Enables the use of a cache with the LDAP server. This is a cache of the LDAP requests.

Default Value: new java.lang.Boolean(true)

setCacheEnabled

public void setCacheEnabled(boolean newValue)
                     throws javax.management.InvalidAttributeValueException

Enables the use of a cache with the LDAP server. This is a cache of the LDAP requests.

Default Value: new java.lang.Boolean(true)

Parameters:

newValue - - new value for attribute CacheEnabled

Throws:

javax.management.InvalidAttributeValueException -

getCacheSize

public int getCacheSize()

The size of the cache in K.

Default Value: new java.lang.Integer(32)

Legal Minimum Value: 0

setCacheSize

public void setCacheSize(int newValue)
                  throws javax.management.InvalidAttributeValueException

The size of the cache in K.

Default Value: new java.lang.Integer(32)

Legal Minimum Value: 0

Parameters:

newValue - - new value for attribute CacheSize

Throws:

javax.management.InvalidAttributeValueException -

getCacheTTL

public int getCacheTTL()

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

Default Value: new java.lang.Integer(60)

Legal Minimum Value: 0

setCacheTTL

public void setCacheTTL(int newValue)
                 throws javax.management.InvalidAttributeValueException

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

Default Value: new java.lang.Integer(60)

Legal Minimum Value: 0

Parameters:

newValue - - new value for attribute CacheTTL

Throws:

javax.management.InvalidAttributeValueException -

isFollowReferrals

public boolean isFollowReferrals()

Enables automatic following of referrals within the LDAP directory. If set to false, then a Referral exception will be thrown when referrals are encountered during LDAP requests.

Default Value: new java.lang.Boolean(true)

setFollowReferrals

public void setFollowReferrals(boolean newValue)
                        throws javax.management.InvalidAttributeValueException

Enables automatic following of referrals within the LDAP directory. If set to false, then a Referral exception will be thrown when referrals are encountered during LDAP requests.

Default Value: new java.lang.Boolean(true)

Parameters:

newValue - - new value for attribute FollowReferrals

Throws:

javax.management.InvalidAttributeValueException -

isBindAnonymouslyOnReferrals

public boolean isBindAnonymouslyOnReferrals()

Enables anonymous binding when following referrals within the LDAP directory. If set to false, then the current principal and credential will be used.

Default Value: new java.lang.Boolean(false)

setBindAnonymouslyOnReferrals

public void setBindAnonymouslyOnReferrals(boolean newValue)
                                   throws javax.management.InvalidAttributeValueException

Enables anonymous binding when following referrals within the LDAP directory. If set to false, then the current principal and credential will be used.

Default Value: new java.lang.Boolean(false)

Parameters:

newValue - - new value for attribute BindAnonymouslyOnReferrals

Throws:

javax.management.InvalidAttributeValueException -

getResultsTimeLimit

public int getResultsTimeLimit()

Specifies the maximum number of milliseconds to wait for results before timing out. If this option is set to 0, there is no maximum time limit. The default is 0.

Default Value: new java.lang.Integer(0)

setResultsTimeLimit

public void setResultsTimeLimit(int newValue)
                         throws javax.management.InvalidAttributeValueException

Specifies the maximum number of milliseconds to wait for results before timing out. If this option is set to 0, there is no maximum time limit. The default is 0.

Default Value: new java.lang.Integer(0)

Parameters:

newValue - - new value for attribute ResultsTimeLimit

Throws:

javax.management.InvalidAttributeValueException -

getConnectTimeout

public int getConnectTimeout()

Specifies the maximum time in seconds to wait for the LDAP connection to be established. If the value is 0, the time is not limited. The default is 0.

Default Value: new java.lang.Integer(0)

setConnectTimeout

public void setConnectTimeout(int newValue)
                       throws javax.management.InvalidAttributeValueException

Specifies the maximum time in seconds to wait for the LDAP connection to be established. If the value is 0, the time is not limited. The default is 0.

Default Value: new java.lang.Integer(0)

Parameters:

newValue - - new value for attribute ConnectTimeout

Throws:

javax.management.InvalidAttributeValueException -

getParallelConnectDelay

public int getParallelConnectDelay()

Specifies the delay in seconds when making concurrent attempts to connect to multiple servers. If the attribute is 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. If a server is might cause your application to block for unacceptably long time if a host is down. If set to greater than 0, then start another connection setup thread after delay seconds.

Default Value: new java.lang.Integer(0)

setParallelConnectDelay

public void setParallelConnectDelay(int newValue)
                             throws javax.management.InvalidAttributeValueException

Specifies the delay in seconds when making concurrent attempts to connect to multiple servers. If the attribute is 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. If a server is might cause your application to block for unacceptably long time if a host is down. If set to greater than 0, then start another connection setup thread after delay seconds.

Default Value: new java.lang.Integer(0)

Parameters:

newValue - - new value for attribute ParallelConnectDelay

Throws:

javax.management.InvalidAttributeValueException -