Package org.bedework.carddav.server.dirHandlers.db

Class DbDirHandler

java.lang.Object

org.bedework.carddav.common.AbstractDirHandler

org.bedework.carddav.server.dirHandlers.db.DbDirHandler

All Implemented Interfaces:

Serializable, org.bedework.access.PrivilegeDefs, DirHandler, org.bedework.util.logging.Logged

Direct Known Subclasses:

DbAddrBookDirHandler

public abstract class DbDirHandler
extends AbstractDirHandler
implements org.bedework.access.PrivilegeDefs

Provide some common methods for db based directory handlers.

Author:

douglm

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	DbDirHandler.CollectionsBatchImpl

Nested classes/interfaces inherited from class org.bedework.carddav.common.AbstractDirHandler

AbstractDirHandler.SplitResult

Nested classes/interfaces inherited from interface org.bedework.carddav.common.DirHandler

DirHandler.CollectionBatcher

Field Summary

Fields

Modifier and Type	Field	Description
protected DbDirHandlerConfig	dbConfig
protected Timestamp	objTimestamp	When we were created for debugging
protected HibSession	sess	Current hibernate session - exists only across one user interaction
protected String	userHomeRoot

Fields inherited from class org.bedework.carddav.common.AbstractDirHandler

account, cdConfig, dhConfig, open, principalNotFound, superUser, unknownPrincipalType, urlHandler

Fields inherited from interface org.bedework.carddav.common.DirHandler

statusChangeUid, statusCreated, statusDestinationExists, statusDuplicate, statusDuplicateUid, statusIllegal, statusNoAccess, statusOK

Fields inherited from interface org.bedework.access.PrivilegeDefs

allowed, allowedInherited, denied, deniedInherited, inheritedFlag, oldAllowed, oldDenied, privAll, privAny, privBind, privEncoding, privMaxType, privNone, privRead, privReadAcl, privReadCurrentUserPrivilegeSet, privReadFreeBusy, privSchedule, privScheduleDeliver, privScheduleDeliverInvite, privScheduleDeliverReply, privScheduleFreeBusy, privScheduleQueryFreebusy, privScheduleReply, privScheduleRequest, privScheduleSend, privScheduleSendFreebusy, privScheduleSendInvite, privScheduleSendReply, privUnbind, privUnlock, privWrite, privWriteAcl, privWriteContent, privWriteProperties, unspecified

Constructor Summary

Constructors

Constructor	Description
DbDirHandler()

Method Summary

Modifier and Type	Method	Description
protected void	beginTransaction()
protected org.bedework.webdav.servlet.access.SharedEntity	checkAccess(org.bedework.webdav.servlet.access.SharedEntity ent, int desiredAccess, boolean alwaysReturnResult)
protected void	checkOpen()
void	close()
protected void	closeSession()
protected void	deleteDbCard(DbCard dbcard)
protected int	deleteDbCollection(String path)
protected void	endTransaction()
protected String	ensureSlashAtEnd(String val)
Iterator<Card>	getAll(String path)
Card	getCard(String path, String name)
Card	getCardByUid(String path, String uid)
GetResult	getCards(String path, Filter filter, GetLimits limits)
CarddavCollection	getCollection(String path)
DirHandler.CollectionBatcher	getCollections(String path)
GetResult	getCollections(String path, GetLimits limits)
protected DbCard	getDbCard(String path)
protected DbCard	getDbCard(String parentPath, String name, int access)
protected DbCard	getDbCardByUid(String parentPath, String uid)
protected DbCollection	getDbCollection(String path, int access)
void	init(CardDAVConfigI cdConfig, DirHandlerConfig dhConfig, org.bedework.webdav.servlet.shared.UrlHandler urlHandler)
protected CarddavCollection	makeCdCollection(DbCollection col)
protected Card	makeVcard(DbCard dbcard)
void	open(String account)
protected void	openSession()
protected void	rollbackTransaction()
protected void	updateCollection(DbCollection col)

Methods inherited from class org.bedework.carddav.common.AbstractDirHandler

addToPrincipal, addValidUser, ensureEndSlash, exportData, getDirectoryInfo, getGroups, getLogger, getPrincipal, getprincipalHome, getprincipalHome, getToPrincipal, isOpen, isPrincipal, lookupUser, makePrincipalHref, makePrincipalUri, splitUri, verifyPath

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bedework.carddav.common.DirHandler

addCard, copyMove, deleteCard, deleteCollection, getPrincipalCard, makeCollection, rename, updateCard, updateCollection

Methods inherited from interface org.bedework.util.logging.Logged

audit, debug, debug, enableAuditLogger, enableErrorLogger, enableMetricsLogger, error, error, error, getLogLevel, info, isAuditLoggerEnabled, isErrorLoggerEnabled, isMetricsDebugEnabled, isMetricsLoggerEnabled, metrics, setLoggerClass, setLoggerClass, setLogLevel, trace, trace, warn

Field Detail

dbConfig

protected DbDirHandlerConfig dbConfig

userHomeRoot

protected String userHomeRoot

objTimestamp

protected Timestamp objTimestamp

When we were created for debugging

sess

protected HibSession sess

Current hibernate session - exists only across one user interaction

Constructor Detail

DbDirHandler

public DbDirHandler()

Method Detail

init

public void init(CardDAVConfigI cdConfig,
                 DirHandlerConfig dhConfig,
                 org.bedework.webdav.servlet.shared.UrlHandler urlHandler)
          throws org.bedework.webdav.servlet.shared.WebdavException

Specified by:

init in interface DirHandler

Overrides:

init in class AbstractDirHandler

Throws:

org.bedework.webdav.servlet.shared.WebdavException

open

public void open(String account)
          throws org.bedework.webdav.servlet.shared.WebdavException

Specified by:

open in interface DirHandler

Overrides:

open in class AbstractDirHandler

Throws:

org.bedework.webdav.servlet.shared.WebdavException

close

public void close()
           throws org.bedework.webdav.servlet.shared.WebdavException

Specified by:

close in interface DirHandler

Overrides:

close in class AbstractDirHandler

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getCard

public Card getCard(String path,
                    String name)
             throws org.bedework.webdav.servlet.shared.WebdavException

Specified by:

getCard in interface DirHandler

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getCardByUid

public Card getCardByUid(String path,
                         String uid)
                  throws org.bedework.webdav.servlet.shared.WebdavException

Specified by:

getCardByUid in interface DirHandler

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getCards

public GetResult getCards(String path,
                          Filter filter,
                          GetLimits limits)
                   throws org.bedework.webdav.servlet.shared.WebdavException

Specified by:

getCards in interface DirHandler

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getAll

public Iterator<Card> getAll(String path)
                      throws org.bedework.webdav.servlet.shared.WebdavException

Specified by:

getAll in interface DirHandler

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getCollection

public CarddavCollection getCollection(String path)
                                throws org.bedework.webdav.servlet.shared.WebdavException

Specified by:

getCollection in interface DirHandler

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getCollections

public GetResult getCollections(String path,
                                GetLimits limits)
                         throws org.bedework.webdav.servlet.shared.WebdavException

Specified by:

getCollections in interface DirHandler

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getCollections

public DirHandler.CollectionBatcher getCollections(String path)
                                            throws org.bedework.webdav.servlet.shared.WebdavException

Specified by:

getCollections in interface DirHandler

Overrides:

getCollections in class AbstractDirHandler

Throws:

org.bedework.webdav.servlet.shared.WebdavException

updateCollection

protected void updateCollection(DbCollection col)
                         throws org.bedework.webdav.servlet.shared.WebdavException

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getDbCard

protected DbCard getDbCard(String parentPath,
                           String name,
                           int access)
                    throws org.bedework.webdav.servlet.shared.WebdavException

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getDbCardByUid

protected DbCard getDbCardByUid(String parentPath,
                                String uid)
                         throws org.bedework.webdav.servlet.shared.WebdavException

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getDbCard

protected DbCard getDbCard(String path)
                    throws org.bedework.webdav.servlet.shared.WebdavException

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getDbCollection

protected DbCollection getDbCollection(String path,
                                       int access)
                                throws org.bedework.webdav.servlet.shared.WebdavException

Throws:

org.bedework.webdav.servlet.shared.WebdavException

makeCdCollection

protected CarddavCollection makeCdCollection(DbCollection col)
                                      throws org.bedework.webdav.servlet.shared.WebdavException

Throws:

org.bedework.webdav.servlet.shared.WebdavException

deleteDbCollection

protected int deleteDbCollection(String path)
                          throws org.bedework.webdav.servlet.shared.WebdavException

Throws:

org.bedework.webdav.servlet.shared.WebdavException

makeVcard

protected Card makeVcard(DbCard dbcard)
                  throws org.bedework.webdav.servlet.shared.WebdavException

Parameters:

dbcard - dbcopy

Returns:

a Card object

Throws:

org.bedework.webdav.servlet.shared.WebdavException

deleteDbCard

protected void deleteDbCard(DbCard dbcard)
                     throws org.bedework.webdav.servlet.shared.WebdavException

Throws:

org.bedework.webdav.servlet.shared.WebdavException

checkOpen

protected void checkOpen()
                  throws org.bedework.webdav.servlet.shared.WebdavException

Throws:

org.bedework.webdav.servlet.shared.WebdavException

openSession

protected void openSession()
                    throws org.bedework.webdav.servlet.shared.WebdavException

Throws:

org.bedework.webdav.servlet.shared.WebdavException

closeSession

protected void closeSession()
                     throws org.bedework.webdav.servlet.shared.WebdavException

Throws:

org.bedework.webdav.servlet.shared.WebdavException

beginTransaction

protected void beginTransaction()
                         throws org.bedework.webdav.servlet.shared.WebdavException

Throws:

org.bedework.webdav.servlet.shared.WebdavException

endTransaction

protected void endTransaction()
                       throws org.bedework.webdav.servlet.shared.WebdavException

Throws:

org.bedework.webdav.servlet.shared.WebdavException

rollbackTransaction

protected void rollbackTransaction()
                            throws org.bedework.webdav.servlet.shared.WebdavException

Throws:

org.bedework.webdav.servlet.shared.WebdavException

ensureSlashAtEnd

protected String ensureSlashAtEnd(String val)

checkAccess

protected org.bedework.webdav.servlet.access.SharedEntity checkAccess(org.bedework.webdav.servlet.access.SharedEntity ent,
                                                                      int desiredAccess,
                                                                      boolean alwaysReturnResult)
                                                               throws org.bedework.webdav.servlet.shared.WebdavException

Throws:

org.bedework.webdav.servlet.shared.WebdavException