sfi.director.repository.DBConnection Class Reference

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 List of all members.

Detailed Description

subclasses implement a driver for accessing arbitrary databases.


Public Member Functions

void setCredentials (Credentials cred)
void setURL (String url) throws DirectorException
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
 *
Exceptions:
DirectorException 

abstract Enumeration search (String expr, Options searchopt) throws DirectorException
 *
Exceptions:
DirectorException 

abstract void append (DBObject dbo) throws DirectorException
 *
Exceptions:
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


Member Function Documentation

abstract void sfi.director.repository.DBConnection.append DBObject  dbo  )  throws DirectorException [pure virtual]
 

*

Exceptions:
DirectorException 

Parameters:
dbo 

Implemented in 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, and sfi.director.repository.SyncDB.

void sfi.director.repository.DBConnection.close  )  throws DirectorException
 

Reimplemented in sfi.director.repository.DirectoryDB, sfi.director.repository.DivertDB, sfi.director.repository.FileDB, sfi.director.repository.NCUserCfgFile, sfi.director.repository.NISTable, sfi.director.repository.OnDemandDBConnection, and sfi.director.repository.SyncDB.

DN sfi.director.repository.DBConnection.completeDN DN  dn  ) 
 

Reimplemented in sfi.director.repository.DirectoryDB, sfi.director.repository.LDAP, sfi.director.repository.LDAPndk, and sfi.director.repository.OnDemandDBConnection.

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.CupsPPDDir, sfi.director.repository.DirectoryDB, sfi.director.repository.JDBC, sfi.director.repository.LDAP, sfi.director.repository.LDAPndk, sfi.director.repository.LDIFDir, sfi.director.repository.MemoryDB, sfi.director.repository.OnDemandDBConnection, and sfi.director.repository.SyncDB.

Exception sfi.director.repository.DBConnection.getError  ) 
 

Reimplemented in sfi.director.repository.OnDemandDBConnection.

String sfi.director.repository.DBConnection.getOption String  option  ) 
 

*

Parameters:
option 

void sfi.director.repository.DBConnection.modify DBObject  dbo,
Vector  attrs
throws DirectorException
 

Reimplemented in sfi.director.repository.DirectoryDB, sfi.director.repository.LDAP, sfi.director.repository.LDAPndk, sfi.director.repository.OnDemandDBConnection, and sfi.director.repository.SyncDB.

void sfi.director.repository.DBConnection.remove DBObject  dbo  )  throws DirectorException
 

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

void sfi.director.repository.DBConnection.replace DBObject  dbo  )  throws DirectorException
 

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

abstract Enumeration sfi.director.repository.DBConnection.search String  expr,
Options  searchopt
throws DirectorException [pure virtual]
 

*

Exceptions:
DirectorException 

Parameters:
expr 
searchopt 

Implemented in sfi.director.repository.MemoryDB, sfi.director.repository.NullDB, sfi.director.repository.OnDemandDBConnection, and sfi.director.repository.PseudoHomeDirs.

Enumeration sfi.director.repository.DBConnection.search String  expr  )  throws DirectorException
 

*

Exceptions:
DirectorException 

Parameters:
expr 

Reimplemented in sfi.director.repository.OnDemandDBConnection.

void sfi.director.repository.DBConnection.setContext RemoteJob  context  ) 
 

*

Parameters:
context 

Reimplemented in sfi.director.repository.OnDemandDBConnection.

void sfi.director.repository.DBConnection.setCredentials Credentials  cred  ) 
 

Reimplemented in sfi.director.repository.JDBC, sfi.director.repository.LDAP, sfi.director.repository.LDAPndk, and sfi.director.repository.OnDemandDBConnection.

void sfi.director.repository.DBConnection.setError Exception  e  ) 
 

Reimplemented in sfi.director.repository.OnDemandDBConnection.

void sfi.director.repository.DBConnection.setOption SURL  url  ) 
 

Reimplemented in sfi.director.repository.OnDemandDBConnection.

void sfi.director.repository.DBConnection.setOption Options  opt  ) 
 

*

Parameters:
opt 

Reimplemented in sfi.director.repository.OnDemandDBConnection.

void sfi.director.repository.DBConnection.setOption String  option,
String  val
 

*

Parameters:
option 
val 

Reimplemented in sfi.director.repository.OnDemandDBConnection.

void sfi.director.repository.DBConnection.setOption String  option  ) 
 

*

Parameters:
option 

Reimplemented in sfi.director.repository.OnDemandDBConnection.

void sfi.director.repository.DBConnection.setURL String  url  )  throws DirectorException
 

Reimplemented in 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.NISTable, and sfi.director.repository.SyncDB.

abstract void sfi.director.repository.DBConnection.truncate  )  throws DirectorException [pure virtual]
 

Implemented in 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, and sfi.director.repository.SyncDB.

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:
wrapped an Enumeration of DBAccessor, null is acceptable as argument value and is interpreted as an empty enumeration


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]
 

used in conjunction with the search() method to set the base DN of the subtree we are about to search (option)

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]
 

Reimplemented in sfi.director.repository.JDBC, and sfi.director.repository.NISTable.


The documentation for this class was generated from the following file:
Generated on Sat Feb 11 01:20:22 2012 for Node Director by  doxygen 1.4.5