org.apache.jackrabbit.webdav.jcr.RootCollection Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jackrabbit-jcr-server Show documentation
Show all versions of jackrabbit-jcr-server Show documentation
WebDAV server implementations for JCR
/*
* 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.jcr;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import javax.jcr.Repository;
import javax.jcr.RepositoryException;
import javax.jcr.Session;
import javax.jcr.Workspace;
import org.apache.jackrabbit.util.Text;
import org.apache.jackrabbit.webdav.DavException;
import org.apache.jackrabbit.webdav.DavResource;
import org.apache.jackrabbit.webdav.DavResourceFactory;
import org.apache.jackrabbit.webdav.DavResourceIterator;
import org.apache.jackrabbit.webdav.DavResourceIteratorImpl;
import org.apache.jackrabbit.webdav.DavResourceLocator;
import org.apache.jackrabbit.webdav.DavServletResponse;
import org.apache.jackrabbit.webdav.io.InputContext;
import org.apache.jackrabbit.webdav.io.OutputContext;
import org.apache.jackrabbit.webdav.jcr.security.JcrSupportedPrivilegesProperty;
import org.apache.jackrabbit.webdav.jcr.security.SecurityUtils;
import org.apache.jackrabbit.webdav.property.DavProperty;
import org.apache.jackrabbit.webdav.property.DavPropertyName;
import org.apache.jackrabbit.webdav.search.SearchResource;
import org.apache.jackrabbit.webdav.security.SecurityConstants;
import org.apache.jackrabbit.webdav.version.DeltaVResource;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* RootCollection represent the WebDAV root resource that does not
* represent any repository item. A call to getMembers() returns a
* DavResourceIterator containing only workspace resources
* resources, thus revealing the names of the accessible JCR workspaces.
*/
public class RootCollection extends AbstractResource {
private static Logger log = LoggerFactory.getLogger(RootCollection.class);
/**
* Create a new RootCollection.
*
* @param locator
* @param session
* @param factory
*/
protected RootCollection(DavResourceLocator locator, JcrDavSession session,
DavResourceFactory factory) {
super(locator, session, factory);
// initialize the supported locks and reports
initLockSupport();
initSupportedReports();
}
//--------------------------------------------------------< DavResource >---
/**
* Returns a string listing the METHODS for this resource as it
* is required for the "Allow" response header.
*
* @return string listing the METHODS allowed
* @see org.apache.jackrabbit.webdav.DavResource#getSupportedMethods()
*/
@Override
public String getSupportedMethods() {
StringBuilder sb = new StringBuilder(DavResource.METHODS);
sb.append(", ");
sb.append(DeltaVResource.METHODS_INCL_MKWORKSPACE);
sb.append(", ");
sb.append(SearchResource.METHODS);
return sb.toString();
}
/**
* Returns true
*
* @return true
* @see org.apache.jackrabbit.webdav.DavResource#exists()
*/
@Override
public boolean exists() {
return true;
}
@Override
public DavProperty getProperty(DavPropertyName name) {
DavProperty prop = super.getProperty(name);
if (prop == null) {
try {
if (SecurityConstants.SUPPORTED_PRIVILEGE_SET.equals(name)) {
prop = new JcrSupportedPrivilegesProperty(getRepositorySession()).asDavProperty();
}
} catch (RepositoryException e) {
log.error("Failed to build SupportedPrivilegeSet property: " + e.getMessage());
}
}
return prop;
}
/**
* Returns true
*
* @return true
* @see org.apache.jackrabbit.webdav.DavResource#isCollection()
*/
@Override
public boolean isCollection() {
return true;
}
/**
* Returns an empty string.
*
* @return empty string
* @see org.apache.jackrabbit.webdav.DavResource#getDisplayName()
*/
@Override
public String getDisplayName() {
return "";
}
/**
* Always returns 'now'
*
* @return
* @see org.apache.jackrabbit.webdav.DavResource#getModificationTime()
*/
@Override
public long getModificationTime() {
return new Date().getTime();
}
/**
* Sets content lengths to '0' and retrieves the modification time.
*
* @param outputContext
* @throws IOException
* @see DavResource#spool(org.apache.jackrabbit.webdav.io.OutputContext)
*/
@Override
public void spool(OutputContext outputContext) throws IOException {
if (outputContext.hasStream()) {
Session session = getRepositorySession();
Repository rep = session.getRepository();
String repName = rep.getDescriptor(Repository.REP_NAME_DESC);
String repURL = rep.getDescriptor(Repository.REP_VENDOR_URL_DESC);
String repVersion = rep.getDescriptor(Repository.REP_VERSION_DESC);
String repostr = repName + " " + repVersion;
StringBuilder sb = new StringBuilder();
sb.append("");
sb.append(repostr);
sb.append(" ");
sb.append("").append(repostr).append("
");
sb.append("Available Workspace Resources:
");
DavResourceIterator it = getMembers();
while (it.hasNext()) {
DavResource res = it.nextResource();
sb.append("- ");
sb.append(res.getDisplayName());
sb.append("
");
}
sb.append("
Powered by ").append(repName);
sb.append(" ").append(repVersion);
sb.append("");
outputContext.setContentLength(sb.length());
outputContext.setModificationTime(getModificationTime());
PrintWriter writer = new PrintWriter(new OutputStreamWriter(outputContext.getOutputStream(), "utf8"));
writer.print(sb.toString());
writer.close();
} else {
outputContext.setContentLength(0);
outputContext.setModificationTime(getModificationTime());
}
}
/**
* Always returns null
*
* @return null for the root resource is not internal member
* of any resource.
* @see org.apache.jackrabbit.webdav.DavResource#getCollection()
*/
@Override
public DavResource getCollection() {
return null;
}
/**
* Throws exception: 403 Forbidden.
* @see DavResource#addMember(DavResource, InputContext)
*/
@Override
public void addMember(DavResource resource, InputContext inputContext) throws DavException {
throw new DavException(DavServletResponse.SC_FORBIDDEN);
}
/**
* Returns an iterator over the member resources, which are all
* workspace resources available.
*
* @return members of this collection
* @see org.apache.jackrabbit.webdav.DavResource#getMembers()
*/
@Override
public DavResourceIterator getMembers() {
List memberList = new ArrayList();
try {
String[] wsNames = getRepositorySession().getWorkspace().getAccessibleWorkspaceNames();
for (String wsName : wsNames) {
String wspPath = "/" + wsName;
DavResourceLocator childLoc = getLocator().getFactory().createResourceLocator(getLocator().getPrefix(), wspPath, wspPath);
memberList.add(createResourceFromLocator(childLoc));
}
} catch (RepositoryException e) {
log.error(e.getMessage());
} catch (DavException e) {
// should never occur
log.error(e.getMessage());
}
return new DavResourceIteratorImpl(memberList);
}
/**
* Calls {@link Workspace#deleteWorkspace(String)} for the workspace with
* the name as indicated by the specified member.
*
* @see DavResource#removeMember(org.apache.jackrabbit.webdav.DavResource)
*/
@Override
public void removeMember(DavResource member) throws DavException {
Workspace wsp = getRepositorySession().getWorkspace();
String name = Text.getName(member.getResourcePath());
try {
wsp.deleteWorkspace(name);
} catch (RepositoryException e) {
throw new JcrDavException(e);
}
}
//-----------------------------------------------------< DeltaVResource >---
/**
* @see DeltaVResource#addWorkspace(org.apache.jackrabbit.webdav.DavResource)
*/
@Override
public void addWorkspace(DavResource workspace) throws DavException {
Workspace wsp = getRepositorySession().getWorkspace();
String name = workspace.getDisplayName();
try {
wsp.createWorkspace(name);
} catch (RepositoryException e) {
throw new JcrDavException(e);
}
}
//--------------------------------------------------------------------------
/**
* @see AbstractResource#initLockSupport()
*/
@Override
protected void initLockSupport() {
// no locking supported
}
/**
* Since the root resource does not represent a repository item and therefore
* is not member of a workspace resource, this method always returns
* null.
*
* @return null
* @see AbstractResource#getWorkspaceHref()
*/
@Override
protected String getWorkspaceHref() {
return null;
}
@Override
protected void initPropertyNames() {
super.initPropertyNames();
if (SecurityUtils.supportsAccessControl(getRepositorySession())) {
names.add(SecurityConstants.SUPPORTED_PRIVILEGE_SET);
}
}
}