| /* |
| * Copyright 2005 The Apache Software Foundation. |
| * |
| * Licensed 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; |
| |
| import org.apache.jackrabbit.webdav.xml.XmlSerializable; |
| import org.apache.jackrabbit.webdav.xml.DomUtil; |
| import org.apache.jackrabbit.webdav.xml.ElementIterator; |
| import org.apache.jackrabbit.webdav.property.DavProperty; |
| import org.apache.jackrabbit.webdav.property.DefaultDavProperty; |
| import org.apache.jackrabbit.webdav.property.DavPropertyName; |
| import org.apache.jackrabbit.webdav.property.DavPropertyNameSet; |
| import org.apache.jackrabbit.webdav.property.PropContainer; |
| import org.apache.jackrabbit.webdav.property.DavPropertyIterator; |
| import org.apache.jackrabbit.webdav.property.DavPropertyNameIterator; |
| import org.apache.jackrabbit.webdav.property.DavPropertySet; |
| import org.w3c.dom.Element; |
| import org.w3c.dom.Document; |
| |
| import java.util.HashMap; |
| import java.util.Iterator; |
| |
| /** |
| * <code>Response</code>... |
| */ |
| public class MultiStatusResponse implements XmlSerializable, DavConstants { |
| |
| private static final int TYPE_PROPSTAT = 0; |
| private static final int TYPE_HREFSTATUS = 1; |
| |
| /** |
| * The type of MultiStatusResponse |
| */ |
| private final int type; |
| |
| /** |
| * The content the 'href' element for this response |
| */ |
| private final String href; |
| |
| /** |
| * An optional response description. |
| */ |
| private final String responseDescription; |
| |
| /** |
| * Type of MultiStatus response: Href + Status |
| */ |
| private Status status; |
| |
| /** |
| * Type of MultiStatus response: PropStat |
| * Hashmap containing all status |
| */ |
| private HashMap statusMap = new HashMap(); |
| |
| private MultiStatusResponse(String href, String responseDescription, int type) { |
| if (!isValidHref(href)) { |
| throw new IllegalArgumentException("Invalid href ('" + href + "')"); |
| } |
| this.href = href; |
| this.responseDescription = responseDescription; |
| this.type = type; |
| } |
| |
| /** |
| * Constructs an WebDAV multistatus response |
| * |
| * @param href |
| * @param status |
| * @param responseDescription |
| */ |
| public MultiStatusResponse(String href, Status status, String responseDescription) { |
| this(href, responseDescription, TYPE_HREFSTATUS); |
| if (status == null) { |
| throw new IllegalArgumentException("Status must not be null in case of a multistatus reponse that consists of href + status only."); |
| } |
| this.status = status; |
| } |
| |
| /** |
| * Constructs an WebDAV multistatus response for a given resource. This |
| * would be used by COPY, MOVE, DELETE, LOCK that require a multistatus |
| * in case of error with a resource other than the resource identified in the |
| * Request-URI.<br> |
| * The response description is set to <code>null</code>. |
| * |
| * @param href |
| * @param statusCode |
| */ |
| public MultiStatusResponse(String href, int statusCode) { |
| this(href, statusCode, null); |
| } |
| |
| /** |
| * Constructs an WebDAV multistatus response for a given resource. This |
| * would be used by COPY, MOVE, DELETE, LOCK that require a multistatus |
| * in case of error with a resource other than the resource identified in the |
| * Request-URI. |
| * |
| * @param href |
| * @param statusCode |
| * @param responseDescription |
| */ |
| public MultiStatusResponse(String href, int statusCode, String responseDescription) { |
| this(href, new Status(statusCode), responseDescription); |
| } |
| |
| /** |
| * Constructs an empty WebDAV multistatus response of type 'PropStat' |
| */ |
| public MultiStatusResponse(String href, String responseDescription) { |
| this(href, responseDescription, TYPE_PROPSTAT); |
| } |
| |
| /** |
| * Constucts a WebDAV multistatus response and retrieves the resource properties |
| * according to the given <code>DavPropertyNameSet</code>. |
| * |
| * @param resource |
| * @param propNameSet |
| */ |
| public MultiStatusResponse(DavResource resource, DavPropertyNameSet propNameSet) { |
| this(resource, propNameSet, PROPFIND_BY_PROPERTY); |
| } |
| |
| /** |
| * Constucts a WebDAV multistatus response and retrieves the resource properties |
| * according to the given <code>DavPropertyNameSet</code>. It adds all known |
| * property to the '200' set, while unknown properties are added to the '404' set. |
| * <p/> |
| * Note, that the set of property names is ignored in case of a {@link #PROPFIND_ALL_PROP} |
| * and {@link #PROPFIND_PROPERTY_NAMES} propFindType. |
| * |
| * @param resource The resource to retrieve the property from |
| * @param propNameSet The property name set as obtained from the request body. |
| * @param propFindType any of the following values: {@link #PROPFIND_ALL_PROP}, |
| * {@link #PROPFIND_BY_PROPERTY}, {@link #PROPFIND_PROPERTY_NAMES} |
| */ |
| public MultiStatusResponse(DavResource resource, DavPropertyNameSet propNameSet, |
| int propFindType) { |
| this(resource.getHref(), null, TYPE_PROPSTAT); |
| |
| // only property names requested |
| if (propFindType == PROPFIND_PROPERTY_NAMES) { |
| PropContainer status200 = getPropContainer(DavServletResponse.SC_OK, true); |
| DavPropertyName[] propNames = resource.getPropertyNames(); |
| for (int i = 0; i < propNames.length; i++) { |
| status200.addContent(propNames[i]); |
| } |
| // all or a specified set of property and their values requested. |
| } else { |
| PropContainer status200 = getPropContainer(DavServletResponse.SC_OK, false); |
| // clone set of property, since several resources could use this again |
| propNameSet = new DavPropertyNameSet(propNameSet); |
| // Add requested properties or all non-protected properties |
| DavPropertyIterator iter = resource.getProperties().iterator(); |
| while (iter.hasNext()) { |
| DavProperty property = iter.nextProperty(); |
| if ((propFindType == PROPFIND_ALL_PROP && !property.isProtected()) || propNameSet.remove(property.getName())) { |
| status200.addContent(property); |
| } |
| } |
| |
| if (!propNameSet.isEmpty() && propFindType != PROPFIND_ALL_PROP) { |
| PropContainer status404 = getPropContainer(DavServletResponse.SC_NOT_FOUND, true); |
| DavPropertyNameIterator iter1 = propNameSet.iterator(); |
| while (iter1.hasNext()) { |
| DavPropertyName propName = iter1.nextPropertyName(); |
| status404.addContent(propName); |
| } |
| } |
| } |
| } |
| |
| /** |
| * Returns the href |
| * |
| * @return href |
| * @see MultiStatusResponse#getHref() |
| */ |
| public String getHref() { |
| return href; |
| } |
| |
| /** |
| * @return responseDescription |
| * @see MultiStatusResponse#getResponseDescription() |
| */ |
| public String getResponseDescription() { |
| return responseDescription; |
| } |
| |
| /** |
| * @see org.apache.jackrabbit.webdav.xml.XmlSerializable#toXml(org.w3c.dom.Document) |
| * @param document |
| */ |
| public Element toXml(Document document) { |
| Element response = DomUtil.createElement(document, XML_RESPONSE, NAMESPACE); |
| // add '<href>' |
| response.appendChild(DomUtil.hrefToXml(getHref(), document)); |
| if (type == TYPE_PROPSTAT) { |
| // add '<propstat>' elements |
| Iterator iter = statusMap.keySet().iterator(); |
| while (iter.hasNext()) { |
| Integer statusKey = (Integer) iter.next(); |
| Status status = new Status(statusKey.intValue()); |
| PropContainer propCont = (PropContainer) statusMap.get(statusKey); |
| |
| Element propstat = DomUtil.createElement(document, XML_PROPSTAT, NAMESPACE); |
| propstat.appendChild(propCont.toXml(document)); |
| propstat.appendChild(status.toXml(document)); |
| response.appendChild(propstat); |
| } |
| } else { |
| // add a single '<status>' element |
| // NOTE: a href+status response cannot be created with 'null' status |
| response.appendChild(status.toXml(document)); |
| } |
| // add the optional '<responsedescription>' element |
| String description = getResponseDescription(); |
| if (description != null) { |
| Element desc = DomUtil.createElement(document, XML_RESPONSEDESCRIPTION, NAMESPACE); |
| DomUtil.setText(desc, description); |
| response.appendChild(desc); |
| } |
| return response; |
| } |
| //----------------------------------------------< type specific methods >--- |
| /** |
| * Adds a property to this response '200' propstat set. |
| * |
| * @param property the property to add |
| */ |
| public void add(DavProperty property) { |
| checkType(TYPE_PROPSTAT); |
| PropContainer status200 = getPropContainer(DavServletResponse.SC_OK, false); |
| status200.addContent(property); |
| } |
| |
| /** |
| * Adds a property name to this response '200' propstat set. |
| * |
| * @param propertyName the property name to add |
| */ |
| public void add(DavPropertyName propertyName) { |
| checkType(TYPE_PROPSTAT); |
| PropContainer status200 = getPropContainer(DavServletResponse.SC_OK, true); |
| status200.addContent(propertyName); |
| } |
| |
| /** |
| * Adds a property to this response |
| * |
| * @param property the property to add |
| * @param status the status of the response set to select |
| */ |
| public void add(DavProperty property, int status) { |
| checkType(TYPE_PROPSTAT); |
| PropContainer propCont = getPropContainer(status, false); |
| propCont.addContent(property); |
| } |
| |
| /** |
| * Adds a property name to this response |
| * |
| * @param propertyName the property name to add |
| * @param status the status of the response set to select |
| */ |
| public void add(DavPropertyName propertyName, int status) { |
| checkType(TYPE_PROPSTAT); |
| PropContainer propCont = getPropContainer(status, true); |
| propCont.addContent(propertyName); |
| } |
| |
| /** |
| * |
| * @param status |
| * @return |
| */ |
| private PropContainer getPropContainer(int status, boolean forNames) { |
| Integer statusKey = new Integer(status); |
| PropContainer propContainer; |
| Object entry = statusMap.get(statusKey); |
| if (entry == null) { |
| if (forNames) { |
| propContainer = new DavPropertyNameSet(); |
| } else { |
| propContainer = new DavPropertySet(); |
| } |
| statusMap.put(statusKey, propContainer); |
| } else { |
| propContainer = (PropContainer) entry; |
| } |
| return propContainer; |
| } |
| |
| private void checkType(int type) { |
| if (this.type != type) { |
| throw new IllegalStateException("The given MultiStatusResponse is not of the required type."); |
| } |
| } |
| |
| /** |
| * Get properties present in this response for the given status code. In case |
| * this MultiStatusResponse does not represent a 'propstat' response, always |
| * an empty {@link DavPropertySet} will be returned. |
| * |
| * @param status |
| * @return property set |
| */ |
| public DavPropertySet getProperties(int status) { |
| Integer key = new Integer(status); |
| if (statusMap.containsKey(key)) { |
| Object mapEntry = statusMap.get(key); |
| if (mapEntry != null && mapEntry instanceof DavPropertySet) { |
| return (DavPropertySet)mapEntry; |
| } |
| } |
| return new DavPropertySet(); |
| } |
| |
| /** |
| * Get property names present in this response for the given status code. In case |
| * this MultiStatusResponse does not represent a 'propstat' response, always |
| * an empty {@link DavPropertyNameSet} will be returned. |
| * |
| * @param status |
| * @return property names |
| */ |
| public DavPropertyNameSet getPropertyNames(int status) { |
| Integer key = new Integer(status); |
| if (statusMap.containsKey(key)) { |
| Object mapEntry = statusMap.get(key); |
| if (mapEntry != null && mapEntry instanceof DavPropertyNameSet) { |
| return (DavPropertyNameSet)mapEntry; |
| } |
| } |
| return new DavPropertyNameSet(); |
| } |
| |
| /** |
| * Build a new response object from the given xml element. |
| * |
| * @param responseElement |
| * @return new <code>MultiStatusResponse</code> instance |
| * @throws IllegalArgumentException if the specified element is <code>null</code> |
| * or not a DAV:response element or if the mandatory DAV:href child is |
| * missing. |
| */ |
| public static MultiStatusResponse createFromXml(Element responseElement) { |
| if (!DomUtil.matches(responseElement, XML_RESPONSE, NAMESPACE)) { |
| throw new IllegalArgumentException("DAV:response element required."); |
| } |
| String href = DomUtil.getChildTextTrim(responseElement, XML_HREF, NAMESPACE); |
| if (href == null) { |
| throw new IllegalArgumentException("DAV:response element must contain a DAV:href element expected."); |
| } |
| String statusLine = DomUtil.getChildText(responseElement, XML_STATUS, NAMESPACE); |
| String responseDescription = DomUtil.getChildText(responseElement, XML_RESPONSEDESCRIPTION, NAMESPACE); |
| |
| MultiStatusResponse response; |
| if (statusLine != null) { |
| Status status = Status.parse(statusLine); |
| response = new MultiStatusResponse(href, status, responseDescription); |
| } else { |
| response = new MultiStatusResponse(href, responseDescription, TYPE_PROPSTAT); |
| // read propstat elements |
| ElementIterator it = DomUtil.getChildren(responseElement, XML_PROPSTAT, NAMESPACE); |
| while (it.hasNext()) { |
| Element propstat = it.nextElement(); |
| String propstatus = DomUtil.getChildText(propstat, XML_STATUS, NAMESPACE); |
| Element prop = DomUtil.getChildElement(propstat, XML_PROP, NAMESPACE); |
| if (propstatus != null && prop != null) { |
| int statusCode = Status.parse(propstatus).getStatusCode(); |
| ElementIterator propIt = DomUtil.getChildren(prop); |
| while (propIt.hasNext()) { |
| Element el = propIt.nextElement(); |
| // current elem is now either a dav property xml representation |
| // or the xml representation of a davpropertyname |
| if (DomUtil.hasContent(el)) { |
| // property |
| DavProperty property = DefaultDavProperty.createFromXml(el); |
| response.add(property, statusCode); |
| } else { |
| // property-name only |
| DavPropertyName propName = DavPropertyName.createFromXml(el); |
| response.add(propName, statusCode); |
| } |
| } |
| } |
| } |
| } |
| return response; |
| } |
| |
| /** |
| * @param href |
| * @return false if the given href is <code>null</code> or empty string. |
| */ |
| private static boolean isValidHref(String href) { |
| return href != null && !"".equals(href); |
| } |
| } |
