org.bedework.webdav.servlet.shared

Class WebdavPrincipalNode

java.lang.Object

org.bedework.webdav.servlet.shared.WebdavNsNode

org.bedework.webdav.servlet.shared.WebdavPrincipalNode

All Implemented Interfaces:

Serializable, org.bedework.util.logging.Logged

public class WebdavPrincipalNode
extends WebdavNsNode

Class to represent a principal in webdav.

Author:

Mike Douglass douglm rpi.edu

See Also:

Serialized Form

Nested Class Summary

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

WebdavNsNode.PropertyTagEntry, WebdavNsNode.PropVal, WebdavNsNode.SetPropertyResult

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
WebdavPrincipalNode(WdSysIntf sysi, UrlHandler urlHandler, String path, org.bedework.access.AccessPrincipal account, boolean collection, String uri)

Method Summary

Modifier and Type	Method and Description
boolean	allowsSyncReport()
boolean	generatePropertyValue(QName tag, WebdavNsIntf intf, boolean allProp) Emit the property indicated by the tag.
Collection<? extends WdEntity>	getChildren(java.util.function.Supplier<Object> filterGetter) Return a collection of children objects.
WdCollection	getCollection(boolean deref) The node may refer to a collection object which may in fact be an alias to another.
boolean	getContentBinary()
String	getContentLang()
long	getContentLen()
String	getContentType() A content type of null implies no content (or we don't know)
String	getCreDate()
org.bedework.access.CurrentAccess	getCurrentAccess() Get the current access granted to this principal for this node.
boolean	getDeleted()
String	getDisplayname()
String	getEtagValue(boolean strong) Entity tags are defined in RFC2068 - they are supposed to provide some sort of indication the data has changed - e.g.
WdCollection	getImmediateTargetCollection()
String	getLastmodDate()
org.bedework.util.logging.BwLogger	getLogger()
org.bedework.access.AccessPrincipal	getOwner() Should return a value suitable for WebdavNsIntf.makeUserHref
String	getSyncToken()
boolean	knownProperty(QName tag) Return true if a call to generatePropertyValue will return a value.
boolean	removeProperty(Element val, WebdavNsNode.SetPropertyResult spr) Remove the given property for this node.
boolean	setProperty(Element val, WebdavNsNode.SetPropertyResult spr) Set the given property for this node.
boolean	trailSlash() Trailing "/" on uri?
void	update() Update this node after changes.
String	writeContent(org.bedework.util.xml.XmlEmit xml, Writer wtr, String contentType) Called during xml emission to write the content for the node.

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

addPropEntry, addPropEntry, equals, generateHref, generateHref, generateUrl, getAlias, getAllowsGet, getContent, getContentStream, getContentString, getEncodedUri, getEncodedUri, getExists, getPath, getPrefixedUri, getPrefixedUri, getPropertyNames, getStatus, getSupportedReports, getTargetUri, getUri, hashCode, init, isCollection, isPrincipal, setAlias, setAllowsGet, setDefaults, setExists, setStatus, setTargetUri, setUri

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

WebdavPrincipalNode

public WebdavPrincipalNode(WdSysIntf sysi,
                           UrlHandler urlHandler,
                           String path,
                           org.bedework.access.AccessPrincipal account,
                           boolean collection,
                           String uri)
                    throws WebdavException

Parameters:

sysi - system interface

urlHandler - - needed for building hrefs.

path - - resource path

account - - the principal

collection - - true if this is a collection

uri - of request

Throws:

WebdavException

Method Detail

getOwner

public org.bedework.access.AccessPrincipal getOwner()
                                             throws WebdavException

Description copied from class: WebdavNsNode

Should return a value suitable for WebdavNsIntf.makeUserHref

Specified by:

getOwner in class WebdavNsNode

Returns:

AccessPrincipal owner

Throws:

WebdavException

update

public void update()
            throws WebdavException

Description copied from class: WebdavNsNode

Update this node after changes.

Specified by:

update in class WebdavNsNode

Throws:

WebdavException

getCurrentAccess

public org.bedework.access.CurrentAccess getCurrentAccess()
                                                   throws WebdavException

Description copied from class: WebdavNsNode

Get the current access granted to this principal for this node.

Specified by:

getCurrentAccess in class WebdavNsNode

Returns:

CurrentAccess

Throws:

WebdavException

getEtagValue

public String getEtagValue(boolean strong)
                    throws WebdavException

Description copied from class: WebdavNsNode

Entity tags are defined in RFC2068 - they are supposed to provide some sort of indication the data has changed - e.g. a checksum.

There are weak and strong tags

This methods should return a suitable value for that tag.

Specified by:

getEtagValue in class WebdavNsNode

Returns:

String

Throws:

WebdavException

trailSlash

public boolean trailSlash()

Description copied from class: WebdavNsNode

Trailing "/" on uri?

Specified by:

trailSlash in class WebdavNsNode

Returns:

boolean

getChildren

public Collection<? extends WdEntity> getChildren(java.util.function.Supplier<Object> filterGetter)
                                           throws WebdavException

Description copied from class: WebdavNsNode

Return a collection of children objects. For example, this is object represents a folder, they may be file objects or a mix of file and folder objects. These are not node objects.

Default is to return null

Specified by:

getChildren in class WebdavNsNode

Parameters:

filterGetter - non-null if there is a filter

Returns:

Collection of children

Throws:

WebdavException - on fatal error

getCollection

public WdCollection getCollection(boolean deref)
                           throws WebdavException

Description copied from class: WebdavNsNode

The node may refer to a collection object which may in fact be an alias to another. For deletions we want to remove the alias itself.

Move and rename are also targetted at the alias.

Other operations are probably intended to work on the underlying target of the alias.

Specified by:

getCollection in class WebdavNsNode

Parameters:

deref - true if we want to act upon the target of an alias.

Returns:

Collection this node represents

Throws:

WebdavException

getImmediateTargetCollection

public WdCollection getImmediateTargetCollection()
                                          throws WebdavException

Specified by:

getImmediateTargetCollection in class WebdavNsNode

Throws:

WebdavException

allowsSyncReport

public boolean allowsSyncReport()
                         throws WebdavException

Specified by:

allowsSyncReport in class WebdavNsNode

Returns:

true if this node allows a sync-report.

Throws:

WebdavException

getDeleted

public boolean getDeleted()
                   throws WebdavException

Specified by:

getDeleted in class WebdavNsNode

Returns:

true if this represents a deleted resource.

Throws:

WebdavException

getSyncToken

public String getSyncToken()
                    throws WebdavException

Specified by:

getSyncToken in class WebdavNsNode

Returns:

String sync-token, a URI

Throws:

WebdavException

writeContent

public String writeContent(org.bedework.util.xml.XmlEmit xml,
                           Writer wtr,
                           String contentType)
                    throws WebdavException

Description copied from class: WebdavNsNode

Called during xml emission to write the content for the node.

Specified by:

writeContent in class WebdavNsNode

Parameters:

xml - - if this is embedded in an xml stream

wtr - - if standalone output or no xml stream initialized.

contentType - desired content type or null for default.

Returns:

actual contentType

Throws:

WebdavException

getContentBinary

public boolean getContentBinary()
                         throws WebdavException

Specified by:

getContentBinary in class WebdavNsNode

Returns:

boolean true if this is binary content

Throws:

WebdavException

getContentLang

public String getContentLang()
                      throws WebdavException

Specified by:

getContentLang in class WebdavNsNode

Returns:

String lang

Throws:

WebdavException

getContentLen

public long getContentLen()
                   throws WebdavException

Specified by:

getContentLen in class WebdavNsNode

Returns:

long content length

Throws:

WebdavException

getContentType

public String getContentType()
                      throws WebdavException

Description copied from class: WebdavNsNode

A content type of null implies no content (or we don't know)

Specified by:

getContentType in class WebdavNsNode

Returns:

String content type

Throws:

WebdavException

getCreDate

public String getCreDate()
                  throws WebdavException

Specified by:

getCreDate in class WebdavNsNode

Returns:

String credate

Throws:

WebdavException

getDisplayname

public String getDisplayname()
                      throws WebdavException

Specified by:

getDisplayname in class WebdavNsNode

Returns:

String name

Throws:

WebdavException

getLastmodDate

public String getLastmodDate()
                      throws WebdavException

Specified by:

getLastmodDate in class WebdavNsNode

Returns:

String last mod date

Throws:

WebdavException

removeProperty

public boolean removeProperty(Element val,
                              WebdavNsNode.SetPropertyResult spr)
                       throws WebdavException

Description copied from class: WebdavNsNode

Remove the given property for this node.

Overrides:

removeProperty in class WebdavNsNode

Parameters:

val - Element defining property to remove

spr - Holds reult of removing property

Returns:

boolean true if property recognized.

Throws:

WebdavException

setProperty

public boolean setProperty(Element val,
                           WebdavNsNode.SetPropertyResult spr)
                    throws WebdavException

Description copied from class: WebdavNsNode

Set the given property for this node.

Overrides:

setProperty in class WebdavNsNode

Parameters:

val - Element defining property to set

spr - Holds result of setting property

Returns:

boolean true if property recognized and processed.

Throws:

WebdavException

knownProperty

public boolean knownProperty(QName tag)

Description copied from class: WebdavNsNode

Return true if a call to generatePropertyValue will return a value.

Overrides:

knownProperty in class WebdavNsNode

Returns:

boolean

generatePropertyValue

public boolean generatePropertyValue(QName tag,
                                     WebdavNsIntf intf,
                                     boolean allProp)
                              throws WebdavException

Description copied from class: WebdavNsNode

Emit the property indicated by the tag.

Overrides:

generatePropertyValue in class WebdavNsNode

Parameters:

tag - QName defining property

intf - WebdavNsIntf

allProp - true if we're doing allprop

Returns:

boolean true if emitted

Throws:

WebdavException

getLogger

public org.bedework.util.logging.BwLogger getLogger()

Specified by:

getLogger in interface org.bedework.util.logging.Logged

Overrides:

getLogger in class WebdavNsNode