WebdavNsNode (bw-webdav 4.0.5 API)

java.lang.Object
- org.bedework.webdav.servlet.shared.WebdavNsNode

All Implemented Interfaces:

Serializable, org.bedework.util.logging.Logged

Direct Known Subclasses:

WebdavPrincipalNode
```
public abstract class WebdavNsNode
extends Object
implements Serializable, org.bedework.util.logging.Logged
```
Represents a node in the underlying namespace for which this servlet is acting as a gateway. This could be a file system, a set of dynamically created objects or some sort of CMS for example.

Author:

Mike Douglass douglm rpi.edu

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`WebdavNsNode.PropertyTagEntry`
`static class`	`WebdavNsNode.PropVal`
`static class`	`WebdavNsNode.SetPropertyResult` Result from setting or removing property

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`alias` true if this is an alias
`protected boolean`	`allowsGet` True if GET is allowed
`protected boolean`	`collection` True if this node is a collection
`protected boolean`	`exists` Does the resource exist?
`protected boolean`	`groupPrincipal` True if this node is a group
`protected String`	`path` Suitable for display
`protected int`	`status` Can be set to indicate some sort of abnormal condition on this node, e.g.
`protected String`	`targetUri`
`protected String`	`uri` Uri of the node.
`protected UrlHandler`	`urlHandler`
`protected boolean`	`userPrincipal` True if this node is a user
`protected WdSysIntf`	`wdSysIntf`

Constructor Summary

Constructors
Constructor and Description
`WebdavNsNode(WdSysIntf sysi, UrlHandler urlHandler, String path, boolean collection, String uri)` Constructor

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected static void`	`addPropEntry(HashMap<QName,WebdavNsNode.PropertyTagEntry> propertyNames, QName tag)`
`protected static void`	`addPropEntry(HashMap<QName,WebdavNsNode.PropertyTagEntry> propertyNames, QName tag, boolean inAllProp)`
`abstract boolean`	`allowsSyncReport()`
`boolean`	`equals(Object o)`
`void`	`generateHref(org.bedework.util.xml.XmlEmit xml)`
`void`	`generateHref(org.bedework.util.xml.XmlEmit xml, String uri)`
`boolean`	`generatePropertyValue(QName tag, WebdavNsIntf intf, boolean allProp)` Emit the property indicated by the tag.
`void`	`generateUrl(org.bedework.util.xml.XmlEmit xml, QName tag, String uri, boolean exists)`
`boolean`	`getAlias()`
`boolean`	`getAllowsGet()`
`abstract Collection<? extends WdEntity>`	`getChildren(java.util.function.Supplier<Object> filterGetter)` Return a collection of children objects.
`abstract WdCollection`	`getCollection(boolean deref)` The node may refer to a collection object which may in fact be an alias to another.
`WebdavNsIntf.Content`	`getContent(String contentType)` Returns the content.
`abstract boolean`	`getContentBinary()`
`abstract String`	`getContentLang()`
`abstract long`	`getContentLen()`
`InputStream`	`getContentStream()` Returns an InputStream for the content.
`String`	`getContentString(String contentType)` Return string content
`abstract String`	`getContentType()` A content type of null implies no content (or we don't know)
`abstract String`	`getCreDate()`
`abstract org.bedework.access.CurrentAccess`	`getCurrentAccess()` Get the current access granted to this principal for this node.
`abstract boolean`	`getDeleted()`
`abstract String`	`getDisplayname()`
`String`	`getEncodedUri()`
`String`	`getEncodedUri(String uri)`
`abstract 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.
`boolean`	`getExists()`
`abstract WdCollection`	`getImmediateTargetCollection()`
`abstract String`	`getLastmodDate()`
`org.bedework.util.logging.BwLogger`	`getLogger()`
`abstract org.bedework.access.AccessPrincipal`	`getOwner()` Should return a value suitable for WebdavNsIntf.makeUserHref
`String`	`getPath()`
`String`	`getPrefixedUri()`
`String`	`getPrefixedUri(String uri)`
`Collection<WebdavNsNode.PropertyTagEntry>`	`getPropertyNames()` Return a set of PropertyTagEntry defining properties this node supports.
`int`	`getStatus()`
`Collection<QName>`	`getSupportedReports()` Return a set of QName defining reports this node supports.
`abstract String`	`getSyncToken()`
`String`	`getTargetUri()`
`String`	`getUri()` Get uri
`int`	`hashCode()`
`void`	`init(boolean content)` This method is called before each setter/getter takes any action.
`boolean`	`isCollection()`
`boolean`	`isPrincipal()` Return true if this represents a principal
`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.
`void`	`setAlias(boolean val)`
`void`	`setAllowsGet(boolean val)`
`void`	`setDefaults(QName methodTag)`
`void`	`setExists(boolean val)`
`boolean`	`setProperty(Element val, WebdavNsNode.SetPropertyResult spr)` Set the given property for this node.
`void`	`setStatus(int val)`
`void`	`setTargetUri(String val)`
`void`	`setUri(String val)` Set uri
`abstract boolean`	`trailSlash()` Trailing "/" on uri?
`abstract void`	`update()` Update this node after changes.
`abstract 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 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

- Field Detail
  - exists
```
protected boolean exists
```
    Does the resource exist?
  - wdSysIntf
```
protected WdSysIntf wdSysIntf
```
  - uri
```
protected String uri
```
    Uri of the node. These are relative to the root of the namespace this interface represents and should start with a "/". For example, if this namespace is part of a file system starting at uabc in /var/local/uabc and we are referring to a directory x at /var/local/uabc/a/x then the uri should be /a/x/
  - path
```
protected String path
```
    Suitable for display
  - collection
```
protected boolean collection
```
    True if this node is a collection
  - userPrincipal
```
protected boolean userPrincipal
```
    True if this node is a user
  - groupPrincipal
```
protected boolean groupPrincipal
```
    True if this node is a group
  - allowsGet
```
protected boolean allowsGet
```
    True if GET is allowed
  - status
```
protected int status
```
    Can be set to indicate some sort of abnormal condition on this node, e.g. no access.
  - alias
```
protected boolean alias
```
    true if this is an alias
  - targetUri
```
protected String targetUri
```
  - urlHandler
```
protected UrlHandler urlHandler
```
- Constructor Detail
  - WebdavNsNode
```
public WebdavNsNode(WdSysIntf sysi,
                    UrlHandler urlHandler,
                    String path,
                    boolean collection,
                    String uri)
```
    Constructor
    
    Parameters:
    
    sysi - system interface
    
    urlHandler - - needed for building hrefs.
    
    path - - resource path
    
    collection - - true if this is a collection
    
    uri - - the uri (XXX is that the same as the path?)
- Method Detail
  - getCurrentAccess
```
public abstract org.bedework.access.CurrentAccess getCurrentAccess()
                                                            throws WebdavException
```
    Get the current access granted to this principal for this node.
    
    Returns:
    
    CurrentAccess
    
    Throws:
    
    WebdavException
  - update
```
public abstract void update()
                     throws WebdavException
```
    Update this node after changes.
    
    Throws:
    
    WebdavException
  - trailSlash
```
public abstract boolean trailSlash()
```
    Trailing "/" on uri?
    
    Returns:
    
    boolean
  - getChildren
```
public abstract Collection<? extends WdEntity> getChildren(java.util.function.Supplier<Object> filterGetter)
                                                    throws WebdavException
```
    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
    
    Parameters:
    
    filterGetter - non-null if there is a filter
    
    Returns:
    
    Collection of children
    
    Throws:
    
    WebdavException - on fatal error
  - getPath
```
public String getPath()
```
    Returns:
    
    String
  - generateHref
```
public void generateHref(org.bedework.util.xml.XmlEmit xml)
                  throws WebdavException
```
    Parameters:
    
    xml - emitter
    
    Throws:
    
    WebdavException
  - generateHref
```
public void generateHref(org.bedework.util.xml.XmlEmit xml,
                         String uri)
                  throws WebdavException
```
    Parameters:
    
    xml - emitter
    
    uri -
    
    Throws:
    
    WebdavException
  - getPrefixedUri
```
public String getPrefixedUri()
                      throws WebdavException
```
    Returns:
    
    this nodes fully prefixed uri
    
    Throws:
    
    WebdavException
  - getPrefixedUri
```
public String getPrefixedUri(String uri)
                      throws WebdavException
```
    Parameters:
    
    uri -
    
    Returns:
    
    fully prefixed uri
    
    Throws:
    
    WebdavException
  - generateUrl
```
public void generateUrl(org.bedework.util.xml.XmlEmit xml,
                        QName tag,
                        String uri,
                        boolean exists)
                 throws WebdavException
```
    Parameters:
    
    xml - emitter
    
    tag -
    
    uri -
    
    exists - - true if we KNOW it exists
    
    Throws:
    
    WebdavException
  - removeProperty
```
public boolean removeProperty(Element val,
                              WebdavNsNode.SetPropertyResult spr)
                       throws WebdavException
```
    Remove the given property for this node.
    
    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
```
    Set the given property for this node.
    
    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)
```
    Return true if a call to generatePropertyValue will return a value.
    
    Parameters:
    
    tag -
    
    Returns:
    
    boolean
  - generatePropertyValue
```
public boolean generatePropertyValue(QName tag,
                                     WebdavNsIntf intf,
                                     boolean allProp)
                              throws WebdavException
```
    Emit the property indicated by the tag.
    
    Parameters:
    
    tag - QName defining property
    
    intf - WebdavNsIntf
    
    allProp - true if we're doing allprop
    
    Returns:
    
    boolean true if emitted
    
    Throws:
    
    WebdavException
  - init
```
public void init(boolean content)
          throws WebdavException
```
    This method is called before each setter/getter takes any action. It allows the concrete implementation to defer some expensive operation to just before the first call.
    
    Parameters:
    
    content - boolean flag indicating if this is a content related property - that is a property which requires fetching and/or rendering the content
    
    Throws:
    
    WebdavException
  - isPrincipal
```
public boolean isPrincipal()
                    throws WebdavException
```
    Return true if this represents a principal
    
    Returns:
    
    boolean
    
    Throws:
    
    WebdavException
  - getPropertyNames
```
public Collection<WebdavNsNode.PropertyTagEntry> getPropertyNames()
                                                           throws WebdavException
```
    Return a set of PropertyTagEntry defining properties this node supports.
    
    Returns:
    
    Collection of PropertyTagEntry
    
    Throws:
    
    WebdavException
  - getSupportedReports
```
public Collection<QName> getSupportedReports()
                                      throws WebdavException
```
    Return a set of QName defining reports this node supports.
    
    Returns:
    
    Collection of QName
    
    Throws:
    
    WebdavException
  - setExists
```
public void setExists(boolean val)
               throws WebdavException
```
    Parameters:
    
    val - boolean true if node exists
    
    Throws:
    
    WebdavException
  - getExists
```
public boolean getExists()
                  throws WebdavException
```
    Returns:
    
    boolean true if node exists
    
    Throws:
    
    WebdavException
  - setUri
```
public void setUri(String val)
            throws WebdavException
```
    Set uri
    
    Parameters:
    
    val -
    
    Throws:
    
    WebdavException
  - getUri
```
public String getUri()
              throws WebdavException
```
    Get uri
    
    Returns:
    
    String uri
    
    Throws:
    
    WebdavException
  - getEncodedUri
```
public String getEncodedUri()
                     throws WebdavException
```
    Returns:
    
    String encoded uri
    
    Throws:
    
    WebdavException
  - getEncodedUri
```
public String getEncodedUri(String uri)
                     throws WebdavException
```
    Parameters:
    
    uri - to be encoded
    
    Returns:
    
    String encoded uri
    
    Throws:
    
    WebdavException
  - isCollection
```
public boolean isCollection()
                     throws WebdavException
```
    Returns:
    
    boolean true for a collection
    
    Throws:
    
    WebdavException
  - setAllowsGet
```
public void setAllowsGet(boolean val)
                  throws WebdavException
```
    Parameters:
    
    val - boolean true if node allows get
    
    Throws:
    
    WebdavException
  - getAllowsGet
```
public boolean getAllowsGet()
                     throws WebdavException
```
    Returns:
    
    true if node allows get
    
    Throws:
    
    WebdavException
  - setStatus
```
public void setStatus(int val)
```
    Parameters:
    
    val - in status
  - getStatus
```
public int getStatus()
```
    Returns:
    
    int sttaus
  - setAlias
```
public void setAlias(boolean val)
              throws WebdavException
```
    Parameters:
    
    val -
    
    Throws:
    
    WebdavException
  - getAlias
```
public boolean getAlias()
                 throws WebdavException
```
    Returns:
    
    boolean true if an alias
    
    Throws:
    
    WebdavException
  - setTargetUri
```
public void setTargetUri(String val)
                  throws WebdavException
```
    Parameters:
    
    val -
    
    Throws:
    
    WebdavException
  - getTargetUri
```
public String getTargetUri()
                    throws WebdavException
```
    Returns:
    
    String uri
    
    Throws:
    
    WebdavException
  - getContent
```
public WebdavNsIntf.Content getContent(String contentType)
                                throws WebdavException
```
    Returns the content.
    
    Parameters:
    
    contentType -
    
    Returns:
    
    Content object
    
    Throws:
    
    WebdavException
  - getContentStream
```
public InputStream getContentStream()
                             throws WebdavException
```
    Returns an InputStream for the content.
    
    Returns:
    
    InputStream A reader for the content.
    
    Throws:
    
    WebdavException
  - getContentString
```
public String getContentString(String contentType)
                        throws WebdavException
```
    Return string content
    
    Returns:
    
    String content.
    
    Throws:
    
    WebdavException
  - setDefaults
```
public void setDefaults(QName methodTag)
                 throws WebdavException
```
    Parameters:
    
    methodTag - - acts as a flag for the method type
    
    Throws:
    
    WebdavException
  - writeContent
```
public abstract String writeContent(org.bedework.util.xml.XmlEmit xml,
                                    Writer wtr,
                                    String contentType)
                             throws WebdavException
```
    Called during xml emission to write the content for the node.
    
    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 abstract boolean getContentBinary()
                                  throws WebdavException
```
    Returns:
    
    boolean true if this is binary content
    
    Throws:
    
    WebdavException
  - getContentLang
```
public abstract String getContentLang()
                               throws WebdavException
```
    Returns:
    
    String lang
    
    Throws:
    
    WebdavException
  - getContentLen
```
public abstract long getContentLen()
                            throws WebdavException
```
    Returns:
    
    long content length
    
    Throws:
    
    WebdavException
  - getContentType
```
public abstract String getContentType()
                               throws WebdavException
```
    A content type of null implies no content (or we don't know)
    
    Returns:
    
    String content type
    
    Throws:
    
    WebdavException
  - getCreDate
```
public abstract String getCreDate()
                           throws WebdavException
```
    Returns:
    
    String credate
    
    Throws:
    
    WebdavException
  - getDisplayname
```
public abstract String getDisplayname()
                               throws WebdavException
```
    Returns:
    
    String name
    
    Throws:
    
    WebdavException
  - getEtagValue
```
public abstract String getEtagValue(boolean strong)
                             throws WebdavException
```
    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.
    
    Parameters:
    
    strong -
    
    Returns:
    
    String
    
    Throws:
    
    WebdavException
  - getLastmodDate
```
public abstract String getLastmodDate()
                               throws WebdavException
```
    Returns:
    
    String last mod date
    
    Throws:
    
    WebdavException
  - getOwner
```
public abstract org.bedework.access.AccessPrincipal getOwner()
                                                      throws WebdavException
```
    Should return a value suitable for WebdavNsIntf.makeUserHref
    
    Returns:
    
    AccessPrincipal owner
    
    Throws:
    
    WebdavException
  - getCollection
```
public abstract WdCollection getCollection(boolean deref)
                                    throws WebdavException
```
    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.
    
    Parameters:
    
    deref - true if we want to act upon the target of an alias.
    
    Returns:
    
    Collection this node represents
    
    Throws:
    
    WebdavException
  - getImmediateTargetCollection
```
public abstract WdCollection getImmediateTargetCollection()
                                                   throws WebdavException
```
    Throws:
    
    WebdavException
  - allowsSyncReport
```
public abstract boolean allowsSyncReport()
                                  throws WebdavException
```
    Returns:
    
    true if this node allows a sync-report.
    
    Throws:
    
    WebdavException
  - getDeleted
```
public abstract boolean getDeleted()
                            throws WebdavException
```
    Returns:
    
    true if this represents a deleted resource.
    
    Throws:
    
    WebdavException
  - getSyncToken
```
public abstract String getSyncToken()
                             throws WebdavException
```
    Returns:
    
    String sync-token, a URI
    
    Throws:
    
    WebdavException
  - addPropEntry
```
protected static void addPropEntry(HashMap<QName,WebdavNsNode.PropertyTagEntry> propertyNames,
                                   QName tag)
```
  - addPropEntry
```
protected static void addPropEntry(HashMap<QName,WebdavNsNode.PropertyTagEntry> propertyNames,
                                   QName tag,
                                   boolean inAllProp)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - getLogger
```
public org.bedework.util.logging.BwLogger getLogger()
```
    Specified by:
    
    getLogger in interface org.bedework.util.logging.Logged

Class WebdavNsNode

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

exists

wdSysIntf

uri

path

collection

userPrincipal

groupPrincipal

allowsGet

status

alias

targetUri

urlHandler

Constructor Detail

WebdavNsNode

Method Detail

getCurrentAccess

update

trailSlash

getChildren

getPath

generateHref

generateHref

getPrefixedUri

getPrefixedUri

generateUrl

removeProperty

setProperty

knownProperty

generatePropertyValue

init

isPrincipal

getPropertyNames

getSupportedReports

setExists

getExists

setUri

getUri

getEncodedUri

getEncodedUri

isCollection

setAllowsGet

getAllowsGet

setStatus

getStatus

setAlias

getAlias

setTargetUri

getTargetUri

getContent

getContentStream

getContentString

setDefaults

writeContent

getContentBinary

getContentLang

getContentLen

getContentType

getCreDate

getDisplayname

getEtagValue

getLastmodDate

getOwner

getCollection

getImmediateTargetCollection

allowsSyncReport

getDeleted

getSyncToken

addPropEntry

addPropEntry

hashCode

equals

getLogger