Package org.bedework.carddav.server.dirHandlers.ldap

Class LdapDirHandler

java.lang.Object

org.bedework.carddav.common.AbstractDirHandler

org.bedework.carddav.server.dirHandlers.ldap.LdapDirHandler

All Implemented Interfaces:

DirHandler, org.bedework.util.logging.Logged

Direct Known Subclasses:

LdapAddrBookDirHandler, LdapPrincipalDirHandler

public abstract class LdapDirHandler
extends AbstractDirHandler

Provide some common methods for ldap based directory handlers.

Author:

douglm

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	LdapDirHandler.CardObject
protected static class	LdapDirHandler.CollectionObject
static class	LdapDirHandler.LdapObject

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 DirContext	ctx
protected LdapDirHandlerConfig	ldapConfig

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

Constructor Summary

Constructors

Constructor	Description
LdapDirHandler()

Method Summary

Modifier and Type	Method	Description
protected void	closeContext()
protected String	dnEscape(String val)
protected String[]	getAttrIdList()
Card	getCard(String path, String name)
Card	getCardByUid(String path, String uid)
GetResult	getCards(String path, Filter filter, GetLimits limits)
CarddavCollection	getCollection(String path)
GetResult	getCollections(String path, GetLimits limits)
protected LdapDirHandler.LdapObject	getObject(String path, boolean isCollection)
void	init(CardDAVConfigI cdConfig, DirHandlerConfig<?> dhConfig, org.bedework.webdav.servlet.shared.UrlHandler urlHandler)
protected String	makeAddrbookDn(String path, boolean isCollection)
protected CarddavCollection	makeCdCollection(String path, boolean fullPath, Attributes attrs)
protected String	makePrincipalDn(String account)
protected Card	makeVcard(String path, boolean fullPath, Attributes attrs, String dn)
protected LdapDirHandler.CardObject	nextCard(String path, boolean fullPath)
protected LdapDirHandler.CollectionObject	nextCdCollection(String path, boolean fullPath)
protected void	openContext()
protected GetResult	search(String base, String filter, GetLimits limits, int scope)
protected GetResult	searchChildren(String path, String filter, GetLimits limits, boolean cards)

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

addToPrincipal, addValidUser, close, ensureEndSlash, exportData, getCollections, getDirectoryInfo, getGroups, getLogger, getPrincipal, getprincipalHome, getprincipalHome, getToPrincipal, isOpen, isPrincipal, lookupUser, makePrincipalHref, makePrincipalUri, open, 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, getAll, 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

ldapConfig

protected LdapDirHandlerConfig ldapConfig

ctx

protected DirContext ctx

Constructor Details

LdapDirHandler

public LdapDirHandler()

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

getCard

public Card getCard(String path,
 String name)

getCardByUid

public Card getCardByUid(String path,
 String uid)

getCards

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

getCollection

public CarddavCollection getCollection(String path)

getCollections

public GetResult getCollections(String path,
 GetLimits limits)

search

protected GetResult search(String base,
 String filter,
 GetLimits limits,
 int scope)

nextCard

protected LdapDirHandler.CardObject nextCard(String path,
 boolean fullPath)

nextCdCollection

protected LdapDirHandler.CollectionObject nextCdCollection(String path,
 boolean fullPath)

makeCdCollection

protected CarddavCollection makeCdCollection(String path,
 boolean fullPath,
 Attributes attrs)

makeVcard

protected Card makeVcard(String path,
 boolean fullPath,
 Attributes attrs,
 String dn)

Parameters:

path - path to this card

fullPath - - path includes card name

attrs - attributes for the entry

Returns:

a card

getObject

protected LdapDirHandler.LdapObject getObject(String path,
 boolean isCollection)

searchChildren

protected GetResult searchChildren(String path,
 String filter,
 GetLimits limits,
 boolean cards)

makePrincipalDn

protected String makePrincipalDn(String account)

makeAddrbookDn

protected String makeAddrbookDn(String path,
 boolean isCollection)

dnEscape

protected String dnEscape(String val)

openContext

protected void openContext()

closeContext

protected void closeContext()

getAttrIdList

protected String[] getAttrIdList()