org.apache.jackrabbit.webdav.version.DeltaVServletRequest Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jackrabbit.webdav.version;
import org.apache.jackrabbit.webdav.DavException;
import org.apache.jackrabbit.webdav.DavServletRequest;
import org.apache.jackrabbit.webdav.version.report.ReportInfo;
/**
* DeltaVServletRequest provides extension useful for functionality
* related to RFC 3253.
*/
public interface DeltaVServletRequest extends DavServletRequest {
/**
* Returns the Label header or null
*
* @return label header or null
* @see DeltaVConstants#HEADER_LABEL
*/
public String getLabel();
/**
* Return the request body as LabelInfo object or null
* if parsing the request body or the creation of the label info failed.
*
* @return LabelInfo object or null
* @throws DavException in case of an invalid request body
*/
public LabelInfo getLabelInfo() throws DavException;
/**
* Return the request body as MergeInfo object or null
* if the creation failed due to invalid format.
*
* @return MergeInfo object or null
* @throws DavException in case of an invalid request body
*/
public MergeInfo getMergeInfo() throws DavException;
/**
* Parses the UPDATE request body a build the corresponding UpdateInfo
* object. If the request body is missing or does not of the required format
* null is returned.
*
* @return the parsed update request body or null
* @throws DavException in case of an invalid request body
*/
public UpdateInfo getUpdateInfo() throws DavException;
/**
* Returns the request body and the Depth header as ReportInfo
* object. The default depth, if no {@link org.apache.jackrabbit.webdav.DavConstants#HEADER_DEPTH
* Depth header}, is {@link org.apache.jackrabbit.webdav.DavConstants#DEPTH_0}.
* If the request body could not be parsed into an {@link org.w3c.dom.Element}
* null is returned.
*
* @return ReportInfo or null
* @throws DavException in case of an invalid request body
*/
public ReportInfo getReportInfo() throws DavException;
/**
* Returns the {@link OptionsInfo} present with the request or null.
*
* @return {@link OptionsInfo} or null
* @throws DavException in case of an invalid request body
*/
public OptionsInfo getOptionsInfo() throws DavException;
}