public interface LDAPServerMBean extends StandardInterface, DescriptorBean
Modifier and Type | Method and Description |
---|---|
int |
getCacheSize()
Returns the size of the cache in K.
|
int |
getCacheTTL()
Returns the time-to-live (TTL) of the cache in seconds.
|
int |
getConnectionPoolSize()
The LDAP connection pool size.
|
int |
getConnectionRetryLimit()
Specifies the number of times to attempt to connect to the LDAP server
if the initial connection failed.
|
int |
getConnectTimeout()
Returns the maximum number of seconds to wait for the LDAP connection to be established.
|
String |
getCredential()
Returns the credential (generally a password) used to authenticate
the LDAP user that is defined in the Principal attribute.
|
byte[] |
getCredentialEncrypted()
Returns the credential (generally a password) used to authenticate
the LDAP user that is defined in the Principal attribute.
|
String |
getHost()
Returns the host name or IP address of the LDAP server.
|
int |
getParallelConnectDelay()
Returns the number of seconds to delay when making concurrent attempts to connect to multiple servers.
|
int |
getPort()
Returns the port number on which the LDAP server is listening.
|
String |
getPrincipal()
Returns the Distinguished Name (DN) of the LDAP user that is
used by WebLogic Server to connect to the LDAP server.
|
int |
getResultsTimeLimit()
Returns the maximum number of milliseconds to wait for results before timing out.
|
boolean |
isBindAnonymouslyOnReferrals()
Returns whether to anonymously bind when following referrals within the LDAP directory.
|
boolean |
isCacheEnabled()
Returns whether to cache LDAP requests with the LDAP server.
|
boolean |
isFollowReferrals()
Returns whether referrals will automatically be followed within the LDAP Directory.
|
boolean |
isSSLEnabled()
Returns whether SSL will be used to connect to the LDAP server.
|
void |
setBindAnonymouslyOnReferrals(boolean bindAnonymouslyOnReferrals)
Sets whether to anonymously bind when following referrals within the LDAP directory.
|
void |
setCacheEnabled(boolean enabled)
Sets whether to cache LDAP requests with the LDAP server.
|
void |
setCacheSize(int size)
Sets the size of the cache in K.
|
void |
setCacheTTL(int TTL)
Sets the time-to-live (TTL) of the cache in seconds.
|
void |
setConnectionPoolSize(int size) |
void |
setConnectionRetryLimit(int limit) |
void |
setConnectTimeout(int timeout)
Sets the maximum number of seconds to wait for the LDAP connection to be established.
|
void |
setCredential(String credential)
Sets the credential (generally a password) used to authenticate
the LDAP user that is defined in the Principal attribute.
|
void |
setCredentialEncrypted(byte[] bytes)
Sets the credential (generally a password) used to authenticate
the LDAP user that is defined in the Principal attribute.
|
void |
setFollowReferrals(boolean followReferrals)
Sets whether referrals will automatically be followed within the LDAP Directory.
|
void |
setHost(String host)
Sets the host name or IP address of the LDAP server.
|
void |
setParallelConnectDelay(int delay)
Sets the number of seconds to delay when making concurrent attempts to connect to multiple servers.
|
void |
setPort(int port)
Sets the port number on which the LDAP server is listening.
|
void |
setPrincipal(String principal)
Sets the Distinguished Name (DN) of the LDAP user that is
used by WebLogic Server to connect to the LDAP server.
|
void |
setResultsTimeLimit(int timeLimit)
Sets the maximum number of milliseconds to wait for results before timing out.
|
void |
setSSLEnabled(boolean enabled)
Sets whether SSL will be used to connect to the LDAP server.
|
getName
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener
String getHost()
void setHost(String host) throws InvalidAttributeValueException
host
- - the new host nameInvalidAttributeValueException
LDAPServerMBean.getHost()
int getPort()
void setPort(int port) throws InvalidAttributeValueException
port
- - the new port numberInvalidAttributeValueException
LDAPServerMBean.getPort()
boolean isSSLEnabled()
void setSSLEnabled(boolean enabled) throws InvalidAttributeValueException
enabled
- - the new SSL enabled valueInvalidAttributeValueException
LDAPServerMBean.isSSLEnabled()
String getPrincipal()
void setPrincipal(String principal) throws InvalidAttributeValueException
principal
- - the new principal nameInvalidAttributeValueException
LDAPServerMBean.getPrincipal()
String getCredential()
LDAPServerMBean.getCredentialEncrypted()
void setCredential(String credential) throws InvalidAttributeValueException
credential
- - the new credentialInvalidAttributeValueException
LDAPServerMBean.getCredential()
,
LDAPServerMBean.setCredentialEncrypted(byte[])
byte[] getCredentialEncrypted()
void setCredentialEncrypted(byte[] bytes) throws InvalidAttributeValueException
bytes
- The new credential value as a byte array.InvalidAttributeValueException
LDAPServerMBean.getCredentialEncrypted()
boolean isCacheEnabled()
void setCacheEnabled(boolean enabled) throws InvalidAttributeValueException
enabled
- - the new cache enabled valueInvalidAttributeValueException
LDAPServerMBean.isCacheEnabled()
int getCacheSize()
void setCacheSize(int size) throws InvalidAttributeValueException
size
- - the new cache sizeInvalidAttributeValueException
LDAPServerMBean.getCacheSize()
int getCacheTTL()
void setCacheTTL(int TTL) throws InvalidAttributeValueException
TTL
- - the new cache time to liveInvalidAttributeValueException
LDAPServerMBean.getCacheTTL()
boolean isFollowReferrals()
void setFollowReferrals(boolean followReferrals) throws InvalidAttributeValueException
followReferrals
- - the new follow referrals valueInvalidAttributeValueException
LDAPServerMBean.isFollowReferrals()
boolean isBindAnonymouslyOnReferrals()
void setBindAnonymouslyOnReferrals(boolean bindAnonymouslyOnReferrals) throws InvalidAttributeValueException
bindAnonymouslyOnReferrals
- - the new bind anonymously on referrals valueInvalidAttributeValueException
LDAPServerMBean.isBindAnonymouslyOnReferrals()
int getResultsTimeLimit()
void setResultsTimeLimit(int timeLimit) throws InvalidAttributeValueException
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.
timeLimit
- - the new results time limitInvalidAttributeValueException
LDAPServerMBean.getResultsTimeLimit()
int getConnectTimeout()
void setConnectTimeout(int timeout) throws InvalidAttributeValueException
timeout
- - the new connect timeoutInvalidAttributeValueException
LDAPServerMBean.getConnectTimeout()
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.
void setParallelConnectDelay(int delay) throws InvalidAttributeValueException
delay
- - the new parallel connect delayInvalidAttributeValueException
LDAPServerMBean.getParallelConnectDelay()
int getConnectionRetryLimit()
void setConnectionRetryLimit(int limit) throws InvalidAttributeValueException
limit
- - number of times connection should tried.InvalidAttributeValueException
LDAPServerMBean.getConnectionRetryLimit()
int getConnectionPoolSize()
void setConnectionPoolSize(int size) throws InvalidAttributeValueException
size
- the LDAP connection pool sizeInvalidAttributeValueException