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 static 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 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()
org.bedework.database.db.DbSession	createQuery(String query)
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)
org.bedework.database.db.DbSession	getSess()
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, debug, enableAuditLogger, enableErrorLogger, enableMetricsLogger, error, error, error, getLogLevel, info, info, isAuditLoggerEnabled, isErrorLoggerEnabled, isMetricsDebugEnabled, isMetricsLoggerEnabled, metrics, setLoggerClass, setLoggerClass, trace, trace, trace, warn, warn

Field Details

dbConfig

protected DbDirHandlerConfig dbConfig

userHomeRoot

protected String userHomeRoot

objTimestamp

protected Timestamp objTimestamp

When we were created for debugging

Constructor Details

DbDirHandler

public DbDirHandler()

Method Details

init

public void init(CardDAVConfigI cdConfig,
 DirHandlerConfig<?> dhConfig,
 org.bedework.webdav.servlet.shared.UrlHandler urlHandler)

Specified by:

init in interface DirHandler

Overrides:

init in class AbstractDirHandler

open

public void open(String account)

Specified by:

open in interface DirHandler

Overrides:

open in class AbstractDirHandler

close

public void close()

Specified by:

close in interface DirHandler

Overrides:

close in class AbstractDirHandler

getCard

public Card getCard(String path,
 String name)

Specified by:

getCard in interface DirHandler

getCardByUid

public Card getCardByUid(String path,
 String uid)

Specified by:

getCardByUid in interface DirHandler

getSess

public org.bedework.database.db.DbSession getSess()

createQuery

public org.bedework.database.db.DbSession createQuery(String query)

getCards

public GetResult getCards(String path,
 Filter filter,
 GetLimits limits)

Specified by:

getCards in interface DirHandler

getAll

public Iterator<Card> getAll(String path)

Specified by:

getAll in interface DirHandler

getCollection

public CarddavCollection getCollection(String path)

Specified by:

getCollection in interface DirHandler

getCollections

public GetResult getCollections(String path,
 GetLimits limits)

Specified by:

getCollections in interface DirHandler

getCollections

public DirHandler.CollectionBatcher getCollections(String path)

Specified by:

getCollections in interface DirHandler

Overrides:

getCollections in class AbstractDirHandler

updateCollection

protected void updateCollection(DbCollection col)

getDbCard

protected DbCard getDbCard(String parentPath,
 String name,
 int access)

getDbCardByUid

protected DbCard getDbCardByUid(String parentPath,
 String uid)

getDbCard

protected DbCard getDbCard(String path)

getDbCollection

protected DbCollection getDbCollection(String path,
 int access)

makeCdCollection

protected CarddavCollection makeCdCollection(DbCollection col)

deleteDbCollection

protected int deleteDbCollection(String path)

makeVcard

protected Card makeVcard(DbCard dbcard)

Parameters:

dbcard - dbcopy

Returns:

a Card object

deleteDbCard

protected void deleteDbCard(DbCard dbcard)

checkOpen

protected void checkOpen()

openSession

protected void openSession()

closeSession

protected void closeSession()

beginTransaction

protected void beginTransaction()

endTransaction

protected void endTransaction()

rollbackTransaction

protected void rollbackTransaction()

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)