Package com.netscape.cmscore.dbs

Class DBSubsystem

java.lang.Object

com.netscape.cmscore.dbs.DBSubsystem

public class DBSubsystem
extends Object

A class represents the database subsystem that manages the backend data storage. This subsystem maintains multiple sessions that allows operations to be performed, and provide a registry where all the schema information is stored.

Version:

$Revision$, $Date$

Author:

thomask

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<String>	DEFAULT_EXCLUDED_LDAP_ATTRS
protected CMSEngine	engine
protected EngineConfig	engineConfig
protected Set<String>	excludedLdapAttrs
static final String	ID
static final org.slf4j.Logger	logger
static final String	PROP_NEXT_RANGE

Constructor Summary

Constructors

Constructor	Description
DBSubsystem()	Constructs database subsystem.

Method Summary

Modifier and Type	Method	Description
void	configureExcludedLdapAttrs()	Configure LDAP attributes that need to be excluded from enrollment records.
DBSSession	createSession()	Creates a database session.
boolean	enableSerialNumberRecovery()
String	getBaseDN()	Retrieves base DN of backend database.
CMSEngine	getCMSEngine()
DatabaseConfig	getDBConfigStore()	Retrieves DB subsystem configuration store.
boolean	getEnableSerialMgmt()
EngineConfig	getEngineConfig()
String	getEntryAttribute(String dn, String attrName, String defaultValue, String errorValue)
Set<String>	getExcludedLdapAttr()
String	getId()	Retrieves subsystem identifier.
LdapAuthInfo	getLdapAuthInfo()
LDAPConfig	getLDAPConfig()	Retrieves internal DB configuration store.
LdapConnInfo	getLdapConnInfo()	Retrieves LDAP connection info (host, port, secure)
DBRegistry	getRegistry()	Retrieves the registry.
void	init(DatabaseConfig dbConfig, LDAPConfig ldapConfig, PKISocketConfig socketConfig, PasswordStore passwordStore)	Initializes the internal registry.
void	returnConn(netscape.ldap.LDAPConnection conn)
void	setCMSEngine(CMSEngine engine)
void	setEnableSerialMgmt(boolean v)
void	setEngineConfig(EngineConfig engineConfig)
void	setId(String id)	Sets subsystem identifier.
void	setNextSerialConfig(BigInteger serial)
void	shutdown()	Shutdowns this subsystem gracefully.

Methods inherited from class java.lang.Object

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

Field Details

logger

public static final org.slf4j.Logger logger

ID

public static final String ID

See Also:

• Constant Field Values

PROP_NEXT_RANGE

public static final String PROP_NEXT_RANGE

See Also:

• Constant Field Values

DEFAULT_EXCLUDED_LDAP_ATTRS

public static final Set<String> DEFAULT_EXCLUDED_LDAP_ATTRS

engine

protected CMSEngine engine

engineConfig

protected EngineConfig engineConfig

excludedLdapAttrs

protected Set<String> excludedLdapAttrs

Constructor Details

DBSubsystem

public DBSubsystem()

Constructs database subsystem.

Method Details

getCMSEngine

public CMSEngine getCMSEngine()

setCMSEngine

public void setCMSEngine(CMSEngine engine)

getEngineConfig

public EngineConfig getEngineConfig()

setEngineConfig

public void setEngineConfig(EngineConfig engineConfig)

getId

public String getId()

Retrieves subsystem identifier.

setId

public void setId(String id)
           throws EBaseException

Sets subsystem identifier.

Throws:

EBaseException

enableSerialNumberRecovery

public boolean enableSerialNumberRecovery()

getEnableSerialMgmt

public boolean getEnableSerialMgmt()

setEnableSerialMgmt

public void setEnableSerialMgmt(boolean v)
                         throws EBaseException

Throws:

EBaseException

setNextSerialConfig

public void setNextSerialConfig(BigInteger serial)
                         throws EBaseException

Throws:

EBaseException

getExcludedLdapAttr

public Set<String> getExcludedLdapAttr()

configureExcludedLdapAttrs

public void configureExcludedLdapAttrs()
                                throws EBaseException

Configure LDAP attributes that need to be excluded from enrollment records. Default config: excludedLdapAttrs.enabled=false; (excludedLdapAttrs.attrs unspecified to take default)

Throws:

EBaseException

init

public void init(DatabaseConfig dbConfig,
 LDAPConfig ldapConfig,
 PKISocketConfig socketConfig,
 PasswordStore passwordStore)
          throws EBaseException

Initializes the internal registry. Connects to the data source, and create a pool of connection of which applications can use. Optionally, check the integrity of the database.

Throws:

EBaseException

getEntryAttribute

public String getEntryAttribute(String dn,
 String attrName,
 String defaultValue,
 String errorValue)

getLDAPConfig

public LDAPConfig getLDAPConfig()

Retrieves internal DB configuration store.

getDBConfigStore

public DatabaseConfig getDBConfigStore()

Retrieves DB subsystem configuration store.

getBaseDN

public String getBaseDN()

Retrieves base DN of backend database.

getLdapConnInfo

public LdapConnInfo getLdapConnInfo()

Retrieves LDAP connection info (host, port, secure)

getLdapAuthInfo

public LdapAuthInfo getLdapAuthInfo()

shutdown

public void shutdown()

Shutdowns this subsystem gracefully.

getRegistry

public DBRegistry getRegistry()

Retrieves the registry.

createSession

public DBSSession createSession()
                         throws EDBException

Creates a database session.

Throws:

EDBException

returnConn

public void returnConn(netscape.ldap.LDAPConnection conn)