smbdav
Interface PropertiesBuilder

All Known Implementing Classes:
DefaultPropertiesBuilder

public interface PropertiesBuilder

This interface provides operations for constructing and retrieving a PROPFIND result XML document.

Author:
Eric Glass

Method Summary
 void addAllProps(org.w3c.dom.Document document, jcifs.smb.SmbFile file, java.lang.String href)
          Adds a response containing the names and values of all properties supported by the given resource.
 void addPropNames(org.w3c.dom.Document document, jcifs.smb.SmbFile file, java.lang.String href)
          Adds a response containing the property names supported by the given resource.
 void addProps(org.w3c.dom.Document document, jcifs.smb.SmbFile file, java.lang.String href, org.w3c.dom.Element[] props)
          Adds a response containing the names and values of the properties specified by the given Element array.
 org.w3c.dom.Document createDocument()
          Creates an XML document in which a result can be built.
 void destroy()
           
 void init(javax.servlet.ServletConfig config)
           
 

Method Detail

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException
Throws:
javax.servlet.ServletException

destroy

public void destroy()

addPropNames

public void addPropNames(org.w3c.dom.Document document,
                         jcifs.smb.SmbFile file,
                         java.lang.String href)
                  throws java.io.IOException
Adds a response containing the property names supported by the given resource.

Parameters:
document - The document to which modifications are made.
file - The SmbFile resource whose property names are to be retrieved.
href - The HTTP URL by which the resource was accessed.
Throws:
java.io.IOException - If an IO error occurs while adding the property names.

addAllProps

public void addAllProps(org.w3c.dom.Document document,
                        jcifs.smb.SmbFile file,
                        java.lang.String href)
                 throws java.io.IOException
Adds a response containing the names and values of all properties supported by the given resource.

Parameters:
file - The SmbFile resource whose property names and values are to be retrieved.
href - The HTTP URL by which the resource was accessed.
Throws:
java.io.IOException - If an IO error occurs while adding the properties.

addProps

public void addProps(org.w3c.dom.Document document,
                     jcifs.smb.SmbFile file,
                     java.lang.String href,
                     org.w3c.dom.Element[] props)
              throws java.io.IOException
Adds a response containing the names and values of the properties specified by the given Element array.

Parameters:
file - The SmbFile resource whose properties are to be retrieved.
href - The HTTP URL by which the resource was accessed.
props - An array of Elements, each of which specifies the name of a property to be retrieved.
Throws:
java.io.IOException - If an IO error occurs while adding the properties.

createDocument

public org.w3c.dom.Document createDocument()
Creates an XML document in which a result can be built.

Returns:
A Document object to hold the resulting XML.


Copyright © 2004 Eric Glass