|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EmbeddedLDAPMBean
The MBean that defines the configuration properties for the embedded LDAP server for the WebLogic domain.
Field Summary |
---|
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean |
---|
DEFAULT_EMPTY_BYTE_ARRAY |
Method Summary | |
---|---|
abstract int |
getBackupCopies() The maximum number of backup copies that should be made for the embedded LDAP server. |
abstract int |
getBackupHour() The hour at which the embedded LDAP server should be backed up. |
abstract int |
getBackupMinute() The minute at which the embedded LDAP server should be backed up. |
abstract int |
getCacheSize() The size of the cache (in kilobytes) that is used with the embedded LDAP server. |
abstract int |
getCacheTTL() The time-to-live of the cache (in seconds) that is used with the embedded LDAP server. |
abstract String |
getCredential() The credential (usually a password) used to connect to the embedded LDAP server. |
abstract byte[] |
getCredentialEncrypted() The credential (usually password) used to connect to the embedded LDAP server. |
abstract int |
getTimeout() Specifies the maximum number of seconds to wait for results from the embedded LDAP server before timing out. |
abstract boolean |
isCacheEnabled() Specifies whether a cache is used with the embedded LDAP server. |
abstract boolean |
isKeepAliveEnabled() Whether keep alive is enabled in the socket connection |
abstract boolean |
isMasterFirst() Specifies whether a Managed Server should always connect to the master LDAP server (contained in the Administration Server), instead of connecting to the local replicated LDAP server (contained in the Managed Server). |
abstract boolean |
isRefreshReplicaAtStartup() Specifies whether a Managed Server should refresh all replicated data at boot time. |
abstract void |
setAnonymousBindAllowed(boolean allowed) Set whether anonymous connection to the embedded LDAP server is allowed. |
abstract void |
setBackupCopies(int copies) Sets the value of the BackupCopies attribute. |
abstract void |
setBackupHour(int hour) Sets the value of the BackupHour attribute. |
abstract void |
setBackupMinute(int minute) Sets the value of the BackupMinute attribute. |
abstract void |
setCacheEnabled(boolean enable) Sets the value of the isCacheEnabled attribute. |
abstract void |
setCacheSize(int size) Sets the value of the setCacheSize attribute. |
abstract void |
setCacheTTL(int ttl) Set the value for the setCacheTTL attribute. |
abstract void |
setCredential(String credential) Sets the value of the Credential attribute. |
abstract void |
setCredentialEncrypted(byte[] bytes) Encrypts the credential and sets the value of the Credential and CredentialEncrypted attributes. |
abstract void |
setKeepAliveEnabled(boolean keepAliveEnabled) |
abstract void |
setMasterFirst(boolean enable) Sets the value for the MasterFirst attribute. |
abstract void |
setRefreshReplicaAtStartup(boolean enable) Sets the value for the RefreshReplicaAtStartup attribute. |
abstract void |
setTimeout(int seconds) Sets the value of the Timeout attribute. |
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean |
---|
freezeCurrentValue, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet |
Methods inherited from interface weblogic.management.WebLogicMBean |
---|
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent |
Methods inherited from interface javax.management.DynamicMBean |
---|
getAttribute, getAttributes, invoke, setAttribute, setAttributes |
Methods inherited from interface javax.management.MBeanRegistration |
---|
postDeregister, postRegister, preDeregister, preRegister |
Methods inherited from interface javax.management.NotificationBroadcaster |
---|
addNotificationListener, getNotificationInfo, removeNotificationListener |
Methods inherited from interface weblogic.descriptor.DescriptorBean |
---|
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener |
Method Detail |
---|
String getCredential()
The credential (usually a password) used to connect to the embedded LDAP server.
If this credential has not been set, WebLogic Server generates a password at startup, initializes the attribute, and saves the configuration to the config.xml file. If you want to connect to the embedded LDAP server using an external LDAP browser and the embedded LDAP administrator account (cn=Admin), change this attribute from the generated value.
As of 8.1 sp4, when you get the value of this attribute, WebLogic Server does the following:
CredentialEncrypted
attribute.When you set the value of this attribute, WebLogic Server does the following:
CredentialEncrypted
attribute to the encrypted value.Using the Credential
attribute is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.
Instead of using this attribute, use CredentialEncrypted()
.
EmbeddedLDAPMBean.getCredentialEncrypted()
void setCredential(String credential) throws InvalidAttributeValueException
Sets the value of the Credential attribute.
credential
- The new credential valueInvalidAttributeValueException
# @see #setCredentialEncrypted(byte[])
byte[] getCredentialEncrypted()
The credential (usually password) used to connect to the embedded LDAP server.
If this credential has not been set, WebLogic Server generates a password at startup, initializes the attribute, and saves the configuration to the config.xml file. If you want to connect to the embedded LDAP server using an external LDAP browser and the embedded LDAP administrator account (cn=Admin), change this attribute from the generated value.
To set this attribute, use weblogic.management.EncryptionHelper.encrypt()
to encrypt the value. Then set this attribute to the output of the encrypt() method.
To compare a password that a user enters with the encrypted value of this attribute, go to the same WebLogic Server instance that you used to set and encrypt this attribute and use weblogic.management.EncryptionHelper.encrypt()
to encrypt the user-supplied password. Then compare the encrypted values.
void setCredentialEncrypted(byte[] bytes) throws InvalidAttributeValueException
bytes
- The new credential valueInvalidAttributeValueException
EmbeddedLDAPMBean.getCredentialEncrypted()
int getBackupHour()
The hour at which the embedded LDAP server should be backed up.
The Backup Hour value is used in conjunction with the Backup Minute value to determine the time at which the embedded LDAP server data files are backed up. At the specified time, WebLogic Server suspends writes to the embedded LDAP server, backs up the data files into a zip files in the ldap/backup directory, and then resumes writes.
void setBackupHour(int hour) throws InvalidAttributeValueException
Sets the value of the BackupHour attribute.
hour
- The new backupHour valueInvalidAttributeValueException
EmbeddedLDAPMBean.getBackupHour()
int getBackupMinute()
The minute at which the embedded LDAP server should be backed up.
The Backup Minute value is used in conjunction with the Back Up Hour value to determine the time at which the embedded LDAP server data files are backed up
void setBackupMinute(int minute) throws InvalidAttributeValueException
Sets the value of the BackupMinute attribute.
minute
- The new backupMinute valueInvalidAttributeValueException
EmbeddedLDAPMBean.getBackupMinute()
int getBackupCopies()
The maximum number of backup copies that should be made for the embedded LDAP server.
This value limits the number of zip files in the ldap/backup directory.
void setBackupCopies(int copies) throws InvalidAttributeValueException
Sets the value of the BackupCopies attribute.
copies
- The new backupCopies valueInvalidAttributeValueException
EmbeddedLDAPMBean.getBackupCopies()
boolean isCacheEnabled()
Specifies whether a cache is used with the embedded LDAP server.
This cache is used when a managed server is reading or writing to the master embedded LDAP server that is running on the Administration server.
void setCacheEnabled(boolean enable)
Sets the value of the isCacheEnabled attribute.
enable
- The new cacheEnabled valueEmbeddedLDAPMBean.isCacheEnabled()
int getCacheSize()
The size of the cache (in kilobytes) that is used with the embedded LDAP server.
void setCacheSize(int size) throws InvalidAttributeValueException
Sets the value of the setCacheSize attribute.
size
- The new cacheSize valueInvalidAttributeValueException
EmbeddedLDAPMBean.getCacheSize()
int getCacheTTL()
The time-to-live of the cache (in seconds) that is used with the embedded LDAP server.
void setCacheTTL(int ttl) throws InvalidAttributeValueException
Set the value for the setCacheTTL attribute.
ttl
- The new cacheTTL valueInvalidAttributeValueException
EmbeddedLDAPMBean.getCacheTTL()
boolean isRefreshReplicaAtStartup()
Specifies whether a Managed Server should refresh all replicated data at boot time. (This is useful if you have made a large amount of changes when the Managed Server was not active, and you want to download the entire replica instead of having the Administration Server push each change to the Managed Server.)
void setRefreshReplicaAtStartup(boolean enable)
Sets the value for the RefreshReplicaAtStartup attribute.
enable
- The new refreshReplicaAtStartup valueEmbeddedLDAPMBean.isRefreshReplicaAtStartup()
boolean isMasterFirst()
Specifies whether a Managed Server should always connect to the master LDAP server (contained in the Administration Server), instead of connecting to the local replicated LDAP server (contained in the Managed Server).
void setMasterFirst(boolean enable)
Sets the value for the MasterFirst attribute.
enable
- The new masterFirst valueEmbeddedLDAPMBean.isMasterFirst()
int getTimeout()
Specifies the maximum number of seconds to wait for results from the embedded LDAP server before timing out. If this option is set to 0, there is no maximum time limit.
void setTimeout(int seconds)
Sets the value of the Timeout attribute.
seconds
- The new timeout valueEmbeddedLDAPMBean.getTimeout()
boolean isKeepAliveEnabled()
void setKeepAliveEnabled(boolean keepAliveEnabled)
keepAliveEnabled
- whether to enable socket keep alivevoid setAnonymousBindAllowed(boolean allowed)
allowed
- whether anonymous connection is allowedEmbeddedLDAPMBean.isAnonymousBindAllowed()
|
Copyright 1996, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |