Class LDAPConfigStorage

java.lang.Object

com.netscape.cmscore.base.ConfigStorage

com.netscape.cmscore.base.LDAPConfigStorage

public class LDAPConfigStorage
extends ConfigStorage

LDAPConfigStorage: Extends ConfigStore with methods to load/save from/to file for persistent storage. This is a configuration store agent who reads data from an LDAP entry.

See Also:

• ConfigStore

Field Summary

Fields

Modifier and Type	Field	Description
static org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor	Description
LDAPConfigStorage(LdapBoundConnFactory connFactory, String dn, netscape.ldap.LDAPAttribute[] createAttrs, String attr)	Constructs an LDAP configuration store.

Method Summary

Modifier and Type	Method	Description
void	commit(ConfigStore config, boolean createBackup)	Commit the configuration to the database.
netscape.ldap.LDAPEntry	commitReturn(ConfigStore config, boolean createBackup, String[] attrs)	This version of commit also returns the post-read entry that the change resulted in.

Methods inherited from class ConfigStorage

load

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

logger

public static org.slf4j.Logger logger

Constructor Details

LDAPConfigStorage

public LDAPConfigStorage(LdapBoundConnFactory connFactory,
 String dn,
 netscape.ldap.LDAPAttribute[] createAttrs,
 String attr)
                  throws Exception

Constructs an LDAP configuration store.

Parameters:

connFactory - Database connection factory

dn - Distinguished name of record containing config store

createAttrs - Set of initial attributes if creating the entry. Should contain cn, objectclass and possibly other attributes.

attr - Name of attribute containing config store

Throws:

Exception

Method Details

commit

public void commit(ConfigStore config,
 boolean createBackup)
            throws EBaseException

Commit the configuration to the database. All uses of LDAPProfileStore at time of writing call with createBackup=false, so the argument is ignored. If backup becomes necessary, the constructor should be modified to take a String backupAttr, and the existing content be copied to that attribute.

Overrides:

commit in class ConfigStorage

Parameters:

createBackup - Ignored.

Throws:

EBaseException

commitReturn

public netscape.ldap.LDAPEntry commitReturn(ConfigStore config,
 boolean createBackup,
 String[] attrs)
                                     throws EBaseException

This version of commit also returns the post-read entry that the change resulted in.

Throws:

EBaseException