Interface WebdavPolicyFilter

  • All Superinterfaces:
    java.lang.Comparable, PluginComponent, PolicyFilter
    All Known Implementing Classes:
    BasicWebdavPolicyFilter

    public interface WebdavPolicyFilter
    extends PolicyFilter
    This class is a hook to allow developer to add custom webdav behaviour without implementing a new WebdavContext, WebdavFileSystem, ...
    To handle read/write/upload rights for webdav the class RightPolicy may be used with JcmsContext Webdav.
    Since:
    jcms-5.7.0
    Version:
    $Revision: 18706 $
    Author:
    Jean-Philippe Encausse
    See Also:
    BasicRightPolicyFilter
    • Method Detail

      • handleWebdavHeaders

        void handleWebdavHeaders​(java.util.Map headers,
                                 WebdavContext ctxt)
        This method is called by WebdavManager to handle headers set to all Webdav response.
        Parameters:
        ctxt - the WebdavContext
        headers - a Map of headers to handle
      • handleWebdavProperties

        void handleWebdavProperties​(java.util.Set propAllSet)
        This method is called by WebdavContext to add properties to Set of properties used by PROPFIND method.
        Parameters:
        propAllSet - the Set of properties
      • handleWebdavProperty

        java.lang.String handleWebdavProperty​(java.lang.String property,
                                              java.lang.String jcms,
                                              WebdavResource res,
                                              WebdavContext ctxt)
        This method handle response for the given property. It is called before propert resolution. Custom properties must be declared using method WebdavPolicy#handleWebdavProperties(Set)
        Parameters:
        ctxt - the WebdavContext
        property - the working property
        res - the working webdav
        Returns:
        String the value to add to response
      • silentFilterResource

        boolean silentFilterResource​(boolean jcms,
                                     WebdavResource res,
                                     WebdavContext ctxt)
        This method is called by CatWebdavFileSystem to ignore custom files like windows thumb.db... that shound not be added to JCMS.
        Parameters:
        jcms - the choice of JCMS
        res - the WebdavResource
        ctxt - the WebdavContext
        Returns:
        boolean true to filter thr given resource