Node Director
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
sfi.director.repository.DBConnection Class Reference

subclasses implement a driver for accessing arbitrary databases. More...

Inheritance diagram for sfi.director.repository.DBConnection:
sfi.director.repository.CupsPPDDir sfi.director.repository.DirectoryDB sfi.director.repository.DivertDB sfi.director.repository.FileDB sfi.director.repository.JDBC sfi.director.repository.LDAP sfi.director.repository.LDAPndk sfi.director.repository.LDIFDir sfi.director.repository.LDIFTree sfi.director.repository.MemoryDB sfi.director.repository.NISTable sfi.director.repository.NullDB sfi.director.repository.OnDemandDBConnection sfi.director.repository.PseudoHomeDirs sfi.director.repository.SyncDB

Public Member Functions

void setCredentials (Credentials cred)
void setURL (String url) throws DirectorException
String getURL ()
void setContext (RemoteJob context)
void setOption (String option)
void setOption (String option, String val)
void setOption (Options opt)
void setOption (SURL url)
String getOption (String option)
void setError (Exception e)
Exception getError ()
DN completeDN (DN dn)
Enumeration search (String expr) throws DirectorException
abstract Enumeration search (String expr, Options searchopt) throws DirectorException
abstract void append (DBObject dbo) throws DirectorException
abstract void truncate () throws DirectorException
void replace (DBObject dbo) throws DirectorException
void remove (DBObject dbo) throws DirectorException
DBAccessor get (DN dn) throws DirectorException
void modify (DBObject dbo, Vector attrs) throws DirectorException
void close () throws DirectorException

Static Public Member Functions

static Enumeration unwrap (final Enumeration wrapped)
 Given an Enumeration of DBAccessor objects as returned by the search() method, returns an Enumeration of DBObject objects.
static String escapeSearchval (String val)

Static Public Attributes

static final String SEARCH_BASEDN = "BaseDN"
 used in conjunction with the search() method to set the base DN of the subtree we are about to search (option)
static final String SEARCH_NOSUB = "Sub"
static final String SEARCH_WITHSTRUCT = "WithStruct"
static final String SEARCH_SORT = "Sort"
static final String SEARCH_SCHEMA = "Schema"

Protected Attributes

String url
RemoteJob context
Options options = new Options()
Exception error = null

Detailed Description

subclasses implement a driver for accessing arbitrary databases.

Member Function Documentation

abstract void sfi.director.repository.DBConnection.append ( DBObject  dbo) throws DirectorException
pure virtual
void sfi.director.repository.DBConnection.close ( ) throws DirectorException
DN sfi.director.repository.DBConnection.completeDN ( DN  dn)
static String sfi.director.repository.DBConnection.escapeSearchval ( String  val)
static
DBAccessor sfi.director.repository.DBConnection.get ( DN  dn) throws DirectorException

Reimplemented in sfi.director.repository.LDAPndk, sfi.director.repository.JDBC, sfi.director.repository.LDAP, sfi.director.repository.OnDemandDBConnection, sfi.director.repository.LDIFDir, sfi.director.repository.CupsPPDDir, sfi.director.repository.DirectoryDB, sfi.director.repository.SyncDB, and sfi.director.repository.MemoryDB.

References sfi.director.repository.DN.equals(), sfi.director.repository.DBAccessor.getDBObject(), sfi.director.repository.DBObject.getDN(), and sfi.director.repository.DBConnection.search().

Referenced by sfi.director.application.DaemonObjectEdit.checkData(), sfi.director.application.HostPackages.computeInstalled(), sfi.director.application.scripttask.DomainBuild.create(), sfi.director.application.FrontendHTTPServer.db_decryptpw(), sfi.director.application.FrontendHTTPServer.db_event(), sfi.director.application.FrontendHTTPServer.db_get(), sfi.director.application.FrontendHTTPServer.db_listevents(), sfi.director.application.FrontendHTTPServer.db_remove(), sfi.director.application.objevents.Workflow.doEvent(), sfi.director.util.Tools.doEvent(), sfi.director.application.FrontendHTTPServer.edit_editor(), sfi.director.application.FrontendInterface.executeCommand(), sfi.director.repository.SyncDB.get(), sfi.director.repository.DirectoryDB.get(), sfi.director.repository.OnDemandDBConnection.get(), sfi.director.repository.config.DirectoryAccess.get(), sfi.director.util.Lock.inspect(), sfi.director.util.Lock.Lock(), sfi.director.cli.copy.run(), and sfi.director.util.Init.set_db().

Exception sfi.director.repository.DBConnection.getError ( )
String sfi.director.repository.DBConnection.getOption ( String  option)
String sfi.director.repository.DBConnection.getURL ( )
void sfi.director.repository.DBConnection.modify ( DBObject  dbo,
Vector  attrs 
) throws DirectorException
void sfi.director.repository.DBConnection.remove ( DBObject  dbo) throws DirectorException
void sfi.director.repository.DBConnection.replace ( DBObject  dbo) throws DirectorException

Reimplemented in sfi.director.repository.JDBC, sfi.director.repository.LDAPndk, sfi.director.repository.LDAP, sfi.director.repository.CupsPPDDir, sfi.director.repository.LDIFDir, sfi.director.repository.OnDemandDBConnection, sfi.director.repository.DirectoryDB, sfi.director.repository.SyncDB, sfi.director.repository.MemoryDB, and sfi.director.repository.NullDB.

References sfi.director.repository.DBConnection.append().

Referenced by sfi.director.repository.SyncDB.append(), sfi.director.application.FrontendHTTPServer.db_replace(), sfi.director.application.FrontendHTTPServer.edit_export(), sfi.director.application.scripttask.ApplyDomainTemplate.exec(), sfi.director.application.scripttask.InjectUserSettings.exec(), sfi.director.application.FrontendInterface.executeCommand(), sfi.director.schedule.Scheduler.executePendingDSUpdate(), sfi.director.application.InstallerOpenLDAP.installSchema(), sfi.director.repository.DBConnection.modify(), sfi.director.application.DaemonObjectEdit.ObjectDefine(), sfi.director.application.autodoc.InfoCollector.push(), sfi.director.repository.FileDB.readNext(), sfi.director.repository.GenericAccessor.replace(), sfi.director.repository.SyncDB.replace(), sfi.director.repository.DirectoryDB.replace(), sfi.director.repository.OnDemandDBConnection.replace(), sfi.director.repository.config.DirectoryAccess.replace(), sfi.director.cli.copy.run(), sfi.director.schedule.Scheduler.runThroughLockedQueue(), sfi.director.schedule.ParallelScheduler.saveQueue(), sfi.director.repository.LDIFTree.search(), sfi.director.util.Lock.setOption(), and sfi.director.application.InstallerOpenLDAP.setRandomPassword().

Enumeration sfi.director.repository.DBConnection.search ( String  expr) throws DirectorException
  * 
Exceptions
DirectorException
Parameters
expr

Reimplemented in sfi.director.repository.OnDemandDBConnection.

References sfi.director.repository.DBConnection.options.

Referenced by sfi.director.application.autodoc.DocInfo.addAdjuncts(), sfi.director.util.Tools.applyModifier(), sfi.director.application.FrontendHTTPServer.auth_login(), sfi.director.cli.app_dist.checkApp(), sfi.director.application.autodoc.CollectServices.collect(), sfi.director.application.scripttask.DomainBuild.create(), sfi.director.application.scripttask.PublishApplication.create(), sfi.director.application.FrontendHTTPServer.db_search(), sfi.director.repository.DirectoryServiceMerger.DirectoryServiceMerger(), sfi.director.application.FrontendHTTPServer.emulateRootUser(), sfi.director.application.scripttask.ApplyDomainTemplate.exec(), sfi.director.application.scripttask.BuildDependingDomains.exec(), sfi.director.application.FrontendInterface.executeCommand(), sfi.director.util.Tools.findAuth(), sfi.director.util.Tools.findFreeNumber(), sfi.director.application.PackageList.findPackage(), sfi.director.repository.DBConnection.get(), sfi.director.repository.config.DirectoryAccess.get(), sfi.director.repository.config.DirectoryAccess.getElements(), sfi.director.repository.SchemaEnforcer.getSchema(), sfi.director.schedule.ParallelScheduler.goThroughCmds(), sfi.director.gui.fields.Template.init(), sfi.director.application.InstallerOpenLDAP.installSchema(), sfi.director.application.objevents.EventEnvironment.loadevents(), sfi.director.cli.testdb.main(), sfi.director.schedule.Scheduler.purgeOldJobs(), sfi.director.application.autodoc.InfoCollector.push(), sfi.director.application.config.GenericFileHandler.readConfig(), sfi.director.application.FilePackageHandler.readList(), sfi.director.application.Report.reportInfo(), sfi.director.application.PackageList.requiredPackage(), sfi.director.jobs.JobMonitor.retrieveFrom(), sfi.director.cli.init.run(), sfi.director.cli.copy.run(), sfi.director.cli.build.run(), sfi.director.repository.SyncDB.search(), sfi.director.repository.OnDemandDBConnection.search(), sfi.director.repository.config.DirectoryAccess.search(), sfi.director.application.SetPassword.setPasswordByFilter(), sfi.director.util.Init.setup_objectregistry(), sfi.director.application.scripttask.EmulateRoot.sysRoot(), and sfi.director.repository.transform.Script.transform().

abstract Enumeration sfi.director.repository.DBConnection.search ( String  expr,
Options  searchopt 
) throws DirectorException
pure virtual
void sfi.director.repository.DBConnection.setContext ( RemoteJob  context)
void sfi.director.repository.DBConnection.setCredentials ( Credentials  cred)
void sfi.director.repository.DBConnection.setError ( Exception  e)
void sfi.director.repository.DBConnection.setOption ( String  option)
void sfi.director.repository.DBConnection.setOption ( String  option,
String  val 
)
void sfi.director.repository.DBConnection.setOption ( Options  opt)
void sfi.director.repository.DBConnection.setOption ( SURL  url)
void sfi.director.repository.DBConnection.setURL ( String  url) throws DirectorException
abstract void sfi.director.repository.DBConnection.truncate ( ) throws DirectorException
pure virtual
static Enumeration sfi.director.repository.DBConnection.unwrap ( final Enumeration  wrapped)
static

Given an Enumeration of DBAccessor objects as returned by the search() method, returns an Enumeration of DBObject objects.

Parameters
wrappedan Enumeration of DBAccessor, null is acceptable as argument value and is interpreted as an empty enumeration

Referenced by sfi.director.application.FrontendHTTPServer._recurse(), sfi.director.application.autodoc.DocInfo.addAdjuncts(), sfi.director.util.Tools.applyModifier(), sfi.director.application.FrontendHTTPServer.auth_login(), sfi.director.cli.build.buildAll(), sfi.director.application.autodoc.DocBuilder.cleanDocMedia(), sfi.director.repository.SyncDB.close(), sfi.director.application.autodoc.CollectServices.collect(), sfi.director.application.scripttask.UpdateDomainsFor.create(), sfi.director.application.scripttask.RemoveUserRef.create(), sfi.director.application.scripttask.SetUserRef.create(), sfi.director.application.scripttask.DomainBuild.create(), sfi.director.application.scripttask.PublishApplication.create(), sfi.director.application.InstallerOpenLDAP.createDB(), sfi.director.application.FrontendHTTPServer.db_search(), sfi.director.application.InstallerOpenLDAP.delDB(), sfi.director.repository.DirectoryServiceMerger.DirectoryServiceMerger(), sfi.director.application.autodoc.DocBuilder.domaindoc(), sfi.director.cli.create.edit(), sfi.director.application.FrontendHTTPServer.edit_editor(), sfi.director.application.FrontendHTTPServer.emulateRootUser(), sfi.director.application.scripttask.ApplyDomainTemplate.exec(), sfi.director.application.scripttask.BuildDependingDomains.exec(), sfi.director.application.FrontendInterface.executeCommand(), sfi.director.application.PackageList.findPackage(), sfi.director.util.ObjectRegistry.fromSearch(), sfi.director.application.autodoc.DocBuilder.genericDocu(), sfi.director.repository.SchemaEnforcer.getSchema(), sfi.director.schedule.ParallelScheduler.goThroughCmds(), sfi.director.application.autodoc.DocBuilder.hostdoc(), sfi.director.gui.fields.Template.init(), sfi.director.gui.fields.DBChoice.init(), sfi.director.application.InstallerOpenLDAP.installSchema(), sfi.director.application.objevents.EventEnvironment.loadevents(), sfi.director.schedule.Scheduler.loadQueue(), sfi.director.application.autodoc.DocBuilder.locations(), sfi.director.cli.testdb.main(), sfi.director.application.scripttask.DomainDepends.mkdepend(), sfi.director.application.AdminServer.oneConnection(), sfi.director.schedule.Scheduler.purgeOldJobs(), sfi.director.application.autodoc.InfoCollector.push(), sfi.director.application.config.GenericFileHandler.readConfig(), sfi.director.application.FilePackageHandler.readList(), sfi.director.application.Report.reportInfo(), sfi.director.application.PackageList.requiredPackage(), sfi.director.jobs.JobMonitor.retrieveFrom(), sfi.director.cli.docrefetch.run(), sfi.director.cli.init.run(), sfi.director.cli.mkdepend.run(), sfi.director.cli.copy.run(), sfi.director.cli.build.run(), sfi.director.cli.app_dist.run(), sfi.director.schedule.Scheduler.runThroughCmdQueue(), sfi.director.application.scripttask.EmulateRoot.sysRoot(), and sfi.director.repository.transform.Script.transform().

Member Data Documentation

RemoteJob sfi.director.repository.DBConnection.context
protected
Exception sfi.director.repository.DBConnection.error = null
protected
Options sfi.director.repository.DBConnection.options = new Options()
protected
final String sfi.director.repository.DBConnection.SEARCH_BASEDN = "BaseDN"
static
final String sfi.director.repository.DBConnection.SEARCH_NOSUB = "Sub"
static
final String sfi.director.repository.DBConnection.SEARCH_SCHEMA = "Schema"
static
final String sfi.director.repository.DBConnection.SEARCH_SORT = "Sort"
static
final String sfi.director.repository.DBConnection.SEARCH_WITHSTRUCT = "WithStruct"
static
String sfi.director.repository.DBConnection.url
protected

The documentation for this class was generated from the following file: