Package org.bedework.caldav.server

Class CaldavBwNode

java.lang.Object

org.bedework.webdav.servlet.shared.WebdavNsNode

org.bedework.caldav.server.CaldavBwNode

All Implemented Interfaces:

Serializable, org.bedework.util.logging.Logged

Direct Known Subclasses:

CaldavCalNode, CaldavComponentNode, CaldavResourceNode

public abstract class CaldavBwNode
extends org.bedework.webdav.servlet.shared.WebdavNsNode

Class to represent a caldav node.

Author:

Mike Douglass douglm - rpi.edu

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CaldavBwNode.PropertyTagXrdEntry	Information about properties returned in an XRD object for the restful protocol

Nested classes/interfaces inherited from class org.bedework.webdav.servlet.shared.WebdavNsNode

org.bedework.webdav.servlet.shared.WebdavNsNode.PropertyTagEntry, org.bedework.webdav.servlet.shared.WebdavNsNode.PropVal, org.bedework.webdav.servlet.shared.WebdavNsNode.SetPropertyResult

Field Summary

Fields

Modifier and Type	Field	Description
protected CalDAVCollection<?>	col
protected boolean	rootNode

Fields inherited from class org.bedework.webdav.servlet.shared.WebdavNsNode

alias, allowsGet, collection, exists, groupPrincipal, path, status, targetUri, uri, urlHandler, userPrincipal, wdSysIntf

Method Summary

Modifier and Type	Method	Description
protected static void	addCalWSSoapName(QName tag, boolean inAllProp)
protected static void	addPropEntry(HashMap<QName,org.bedework.webdav.servlet.shared.WebdavNsNode.PropertyTagEntry> propertyNames, HashMap<String,CaldavBwNode.PropertyTagXrdEntry> xrdNames, QName tag, String xrdName)
protected static void	addPropEntry(HashMap<QName,org.bedework.webdav.servlet.shared.WebdavNsNode.PropertyTagEntry> propertyNames, HashMap<String,CaldavBwNode.PropertyTagXrdEntry> xrdNames, QName tag, String xrdName, boolean inAllProp)
protected static void	addXrdEntry(HashMap<String,CaldavBwNode.PropertyTagXrdEntry> xrdNames, String xrdName)
protected static void	addXrdEntry(HashMap<String,CaldavBwNode.PropertyTagXrdEntry> xrdNames, String xrdName, boolean inAllProp, boolean inLink)
protected String	concatEtoken(String... val)
boolean	generateCalWsProperty(List<org.oasis_open.docs.ws_calendar.ns.soap.GetPropertiesBasePropertyType> props, QName tag, org.bedework.webdav.servlet.shared.WebdavNsIntf intf, boolean allProp)
boolean	generatePropertyValue(QName tag, org.bedework.webdav.servlet.shared.WebdavNsIntf intf, boolean allProp)
boolean	generateXrdProperties(List<Object> props, String name, org.bedework.webdav.servlet.shared.WebdavNsIntf intf, boolean allProp)
Collection<org.bedework.webdav.servlet.shared.WebdavNsNode.PropertyTagEntry>	getCalWSSoapNames()	Return a set of PropertyTagEntry defining CalWS-SOAP properties this node supports.
Collection<? extends org.bedework.webdav.servlet.shared.WdEntity<?>>	getChildren(Supplier<Object> filterGetter)
org.bedework.webdav.servlet.shared.WdCollection<?>	getCollection(boolean deref)
boolean	getContentBinary()
abstract String	getEtokenValue()	Returns a string value suitable for the web service token
org.bedework.webdav.servlet.shared.WdCollection<?>	getImmediateTargetCollection()
SysIntf	getIntf()
Collection<QName>	getSupportedReports()	Return a set of Qname defining reports this node supports.
String	getSyncToken()
SysIntf	getSysi()
String	getUrlValue()
String	getUrlValue(String uri, boolean exists)
Collection<CaldavBwNode.PropertyTagXrdEntry>	getXrdNames()	Return a set of PropertyTagEntry defining properties this node supports.
boolean	isCalendarCollection()
boolean	knownProperty(QName tag)
protected String[]	splitEtoken(String val)
String	toString()
protected javax.xml.bind.JAXBElement<org.oasis_open.docs.ns.xri.xrd_1.PropertyType>	xrdEmptyProperty(String name)
protected javax.xml.bind.JAXBElement<org.oasis_open.docs.ns.xri.xrd_1.LinkType>	xrdLink(String name, Object val)
protected javax.xml.bind.JAXBElement<org.oasis_open.docs.ns.xri.xrd_1.PropertyType>	xrdProperty(String name, String val)

Methods inherited from class org.bedework.webdav.servlet.shared.WebdavNsNode

addPropEntry, addPropEntry, allowsSyncReport, equals, generateHref, generateHref, generateUrl, getAlias, getAllowsGet, getContent, getContentLang, getContentLen, getContentStream, getContentString, getContentType, getCreDate, getCurrentAccess, getDeleted, getDisplayname, getEncodedUri, getEncodedUri, getEtagValue, getExists, getLastmodDate, getLogger, getOwner, getPath, getPrefixedUri, getPrefixedUri, getPropertyNames, getStatus, getTargetUri, getUri, hashCode, init, isCollection, isPrincipal, removeProperty, setAlias, setAllowsGet, setDefaults, setExists, setProperty, setStatus, setTargetUri, setUri, trailSlash, update, writeContent

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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, trace, trace, warn

Field Detail

rootNode

protected boolean rootNode

col

protected CalDAVCollection<?> col

Method Detail

getEtokenValue

public abstract String getEtokenValue()
                               throws org.bedework.webdav.servlet.shared.WebdavException

Returns a string value suitable for the web service token

Returns:

String token

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getIntf

public SysIntf getIntf()

Returns:

the interface

getCollection

public org.bedework.webdav.servlet.shared.WdCollection<?> getCollection(boolean deref)
                                                                 throws org.bedework.webdav.servlet.shared.WebdavException

Specified by:

getCollection in class org.bedework.webdav.servlet.shared.WebdavNsNode

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getImmediateTargetCollection

public org.bedework.webdav.servlet.shared.WdCollection<?> getImmediateTargetCollection()
                                                                                throws org.bedework.webdav.servlet.shared.WebdavException

Specified by:

getImmediateTargetCollection in class org.bedework.webdav.servlet.shared.WebdavNsNode

Throws:

org.bedework.webdav.servlet.shared.WebdavException

isCalendarCollection

public boolean isCalendarCollection()
                             throws org.bedework.webdav.servlet.shared.WebdavException

Returns:

boolean if this is a calendar

Throws:

org.bedework.webdav.servlet.shared.WebdavException - on fatal error

getSysi

public SysIntf getSysi()

Returns:

CalSvcI

getSupportedReports

public Collection<QName> getSupportedReports()
                                      throws org.bedework.webdav.servlet.shared.WebdavException

Return a set of Qname defining reports this node supports.

Overrides:

getSupportedReports in class org.bedework.webdav.servlet.shared.WebdavNsNode

Returns:

Collection of QName

Throws:

org.bedework.webdav.servlet.shared.WebdavException - on fatal error

getSyncToken

public String getSyncToken()
                    throws org.bedework.webdav.servlet.shared.WebdavException

Specified by:

getSyncToken in class org.bedework.webdav.servlet.shared.WebdavNsNode

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getContentBinary

public boolean getContentBinary()
                         throws org.bedework.webdav.servlet.shared.WebdavException

Specified by:

getContentBinary in class org.bedework.webdav.servlet.shared.WebdavNsNode

Throws:

org.bedework.webdav.servlet.shared.WebdavException

getChildren

public Collection<? extends org.bedework.webdav.servlet.shared.WdEntity<?>> getChildren(Supplier<Object> filterGetter)
                                                                                 throws org.bedework.webdav.servlet.shared.WebdavException

Specified by:

getChildren in class org.bedework.webdav.servlet.shared.WebdavNsNode

Throws:

org.bedework.webdav.servlet.shared.WebdavException

knownProperty

public boolean knownProperty(QName tag)

Overrides:

knownProperty in class org.bedework.webdav.servlet.shared.WebdavNsNode

generatePropertyValue

public boolean generatePropertyValue(QName tag,
                                     org.bedework.webdav.servlet.shared.WebdavNsIntf intf,
                                     boolean allProp)
                              throws org.bedework.webdav.servlet.shared.WebdavException

Overrides:

generatePropertyValue in class org.bedework.webdav.servlet.shared.WebdavNsNode

Throws:

org.bedework.webdav.servlet.shared.WebdavException

generateCalWsProperty

public boolean generateCalWsProperty(List<org.oasis_open.docs.ws_calendar.ns.soap.GetPropertiesBasePropertyType> props,
                                     QName tag,
                                     org.bedework.webdav.servlet.shared.WebdavNsIntf intf,
                                     boolean allProp)
                              throws org.bedework.webdav.servlet.shared.WebdavException

Parameters:

props -

tag -

intf -

allProp -

Returns:

true if property emitted

Throws:

org.bedework.webdav.servlet.shared.WebdavException - on fatal error

generateXrdProperties

public boolean generateXrdProperties(List<Object> props,
                                     String name,
                                     org.bedework.webdav.servlet.shared.WebdavNsIntf intf,
                                     boolean allProp)
                              throws org.bedework.webdav.servlet.shared.WebdavException

Parameters:

props -

name -

intf -

allProp -

Returns:

true if proeprty emitted

Throws:

org.bedework.webdav.servlet.shared.WebdavException - on fatal error

getXrdNames

public Collection<CaldavBwNode.PropertyTagXrdEntry> getXrdNames()
                                                         throws org.bedework.webdav.servlet.shared.WebdavException

Return a set of PropertyTagEntry defining properties this node supports.

Returns:

Collection of PropertyTagEntry

Throws:

org.bedework.webdav.servlet.shared.WebdavException - on fatal error

getCalWSSoapNames

public Collection<org.bedework.webdav.servlet.shared.WebdavNsNode.PropertyTagEntry> getCalWSSoapNames()
                                                                                               throws org.bedework.webdav.servlet.shared.WebdavException

Return a set of PropertyTagEntry defining CalWS-SOAP properties this node supports.

Returns:

Collection of PropertyTagEntry

Throws:

org.bedework.webdav.servlet.shared.WebdavException - on fatal error

xrdProperty

protected javax.xml.bind.JAXBElement<org.oasis_open.docs.ns.xri.xrd_1.PropertyType> xrdProperty(String name,
                                                                                                String val)

xrdLink

protected javax.xml.bind.JAXBElement<org.oasis_open.docs.ns.xri.xrd_1.LinkType> xrdLink(String name,
                                                                                        Object val)

xrdEmptyProperty

protected javax.xml.bind.JAXBElement<org.oasis_open.docs.ns.xri.xrd_1.PropertyType> xrdEmptyProperty(String name)

getUrlValue

public String getUrlValue()
                   throws org.bedework.webdav.servlet.shared.WebdavException

Returns:

formatted url value for the node

Throws:

org.bedework.webdav.servlet.shared.WebdavException - on fatal error

getUrlValue

public String getUrlValue(String uri,
                          boolean exists)
                   throws org.bedework.webdav.servlet.shared.WebdavException

Parameters:

uri - the value

exists - - true if we KNOW it exists

Returns:

formatted url value

Throws:

org.bedework.webdav.servlet.shared.WebdavException - on fatal error

addCalWSSoapName

protected static void addCalWSSoapName(QName tag,
                                       boolean inAllProp)

addPropEntry

protected static void addPropEntry(HashMap<QName,org.bedework.webdav.servlet.shared.WebdavNsNode.PropertyTagEntry> propertyNames,
                                   HashMap<String,CaldavBwNode.PropertyTagXrdEntry> xrdNames,
                                   QName tag,
                                   String xrdName)

addPropEntry

protected static void addPropEntry(HashMap<QName,org.bedework.webdav.servlet.shared.WebdavNsNode.PropertyTagEntry> propertyNames,
                                   HashMap<String,CaldavBwNode.PropertyTagXrdEntry> xrdNames,
                                   QName tag,
                                   String xrdName,
                                   boolean inAllProp)

addXrdEntry

protected static void addXrdEntry(HashMap<String,CaldavBwNode.PropertyTagXrdEntry> xrdNames,
                                  String xrdName)

addXrdEntry

protected static void addXrdEntry(HashMap<String,CaldavBwNode.PropertyTagXrdEntry> xrdNames,
                                  String xrdName,
                                  boolean inAllProp,
                                  boolean inLink)

concatEtoken

protected String concatEtoken(String... val)

splitEtoken

protected String[] splitEtoken(String val)

toString

public String toString()

Overrides:

toString in class Object