Class UpdateInfo

  • All Implemented Interfaces:
    DeltaVConstants, XmlSerializable

    public class UpdateInfo
    extends Object
    implements DeltaVConstants, XmlSerializable
    UpdateInfo encapsulates the request body of an UPDATE request. RFC 3253 defines the request body as follows:
     <!ELEMENT update ANY>
     ANY value: A sequence of elements with at most one DAV:label-name or
     DAV:version element (but not both).
     In addition at one DAV:prop element can be present.
     <!ELEMENT version (href)>
     <!ELEMENT label-name (#PCDATA)> PCDATA value: string
     prop: see RFC 2518, Section 12.11
    In order to reflect the complete range of version restoring and updating of nodes defined by JSR170 the definition has been extended:
     <!ELEMENT update ( (version | label-name | workspace ) , (prop)?, (removeExisting)? ) >
     <!ELEMENT version (href+) >
     <!ELEMENT label-name (#PCDATA) >
     <!ELEMENT workspace (href) >
     <!ELEMENT prop ANY >
     <!ELEMENT removeExisting EMPTY >
    • Constructor Detail

      • UpdateInfo

        public UpdateInfo​(Element updateElement)
                   throws DavException
        Create a new UpdateInfo object.
        updateElement -
        DavException - if the updateElement is null or not a DAV:update element or if the element does not match the required structure.
    • Method Detail

      • getVersionHref

        public String[] getVersionHref()
      • getLabelName

        public String[] getLabelName()
      • getWorkspaceHref

        public String getWorkspaceHref()
      • getPropertyNameSet

        public DavPropertyNameSet getPropertyNameSet()
        Returns a DavPropertyNameSet. If the DAV:update element contains a DAV:prop child element the properties specified therein are included in the set. Otherwise an empty set is returned.

        WARNING: modifying the DavPropertyNameSet returned by this method does not modify this UpdateInfo.

        set listing the properties specified in the DAV:prop element indicating those properties that must be reported in the response body.
      • getUpdateElement

        public Element getUpdateElement()
      • createUpdateElement

        public static Element createUpdateElement​(String[] updateSource,
                                                  int updateType,
                                                  Document factory)
        Factory method to create the basic structure of an UpdateInfo object.
        updateSource -
        updateType -
        factory -