Java tutorial
/* * 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 com.ucap.uccc.cmis.impl.atompub; import static com.ucap.uccc.cmis.impl.atompub.AbstractAtomPubServiceCall.*; import static com.ucap.uccc.server.shared.Dispatcher.*; import static com.ucap.uccc.server.main.DefaultConsts.*; import java.io.IOException; import java.io.PrintWriter; import javax.servlet.ServletConfig; import javax.servlet.ServletException; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import org.apache.chemistry.opencmis.commons.enums.CmisVersion; import org.apache.chemistry.opencmis.commons.exceptions.CmisBaseException; import org.apache.chemistry.opencmis.commons.exceptions.CmisConstraintException; import org.apache.chemistry.opencmis.commons.exceptions.CmisContentAlreadyExistsException; import org.apache.chemistry.opencmis.commons.exceptions.CmisFilterNotValidException; import org.apache.chemistry.opencmis.commons.exceptions.CmisInvalidArgumentException; import org.apache.chemistry.opencmis.commons.exceptions.CmisNameConstraintViolationException; import org.apache.chemistry.opencmis.commons.exceptions.CmisNotSupportedException; import org.apache.chemistry.opencmis.commons.exceptions.CmisObjectNotFoundException; import org.apache.chemistry.opencmis.commons.exceptions.CmisPermissionDeniedException; import org.apache.chemistry.opencmis.commons.exceptions.CmisRuntimeException; import org.apache.chemistry.opencmis.commons.exceptions.CmisStorageException; import org.apache.chemistry.opencmis.commons.exceptions.CmisStreamNotSupportedException; import org.apache.chemistry.opencmis.commons.exceptions.CmisUnauthorizedException; import org.apache.chemistry.opencmis.commons.exceptions.CmisUpdateConflictException; import org.apache.chemistry.opencmis.commons.exceptions.CmisVersioningException; import org.apache.chemistry.opencmis.commons.impl.IOUtils; import org.apache.chemistry.opencmis.commons.server.CallContext; import org.apache.chemistry.opencmis.commons.server.CmisService; import com.ucap.uccc.server.shared.ServerVersion; import com.ucap.uccc.server.shared.AbstractCmisHttpServlet; import com.ucap.uccc.server.shared.Dispatcher; import com.ucap.uccc.server.shared.ExceptionHelper; import com.ucap.uccc.server.shared.HEADHttpServletRequestWrapper; import com.ucap.uccc.server.shared.HttpUtils; import com.ucap.uccc.server.shared.NoBodyHttpServletResponseWrapper; import com.ucap.uccc.server.shared.QueryStringHttpServletRequestWrapper; import com.ucap.uccc.server.shared.ServiceCall; import org.apache.commons.lang.StringEscapeUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * CMIS AtomPub servlet. */ public class CmisAtomPubServlet extends AbstractCmisHttpServlet { private static final Logger LOG = LoggerFactory.getLogger(CmisAtomPubServlet.class); private static final long serialVersionUID = 1L; private final Dispatcher dispatcher = new Dispatcher(); @Override public void init(ServletConfig config) throws ServletException { super.init(config); // set the binding setBinding(CallContext.BINDING_ATOMPUB); // get and CMIS version String cmisVersionStr = config.getInitParameter(CNPRM_CMIS_VERSION); if (cmisVersionStr != null) { try { setCmisVersion(CmisVersion.fromValue(cmisVersionStr)); } catch (IllegalArgumentException e) { LOG.warn("CMIS version is invalid! Setting it to CMIS 1.0."); setCmisVersion(CmisVersion.CMIS_1_0); } } else { LOG.warn("CMIS version is not defined! Setting it to CMIS 1.0."); setCmisVersion(CmisVersion.CMIS_1_0); } // initialize resources addResource("", METHOD_GET, new RepositoryService.GetRepositories()); addResource(RESOURCE_TYPES, METHOD_GET, new RepositoryService.GetTypeChildren()); addResource(RESOURCE_TYPES, METHOD_POST, new RepositoryService.CreateType()); addResource(RESOURCE_TYPESDESC, METHOD_GET, new RepositoryService.GetTypeDescendants()); addResource(RESOURCE_TYPE, METHOD_GET, new RepositoryService.GetTypeDefinition()); addResource(RESOURCE_TYPE, METHOD_PUT, new RepositoryService.UpdateType()); addResource(RESOURCE_TYPE, METHOD_DELETE, new RepositoryService.DeleteType()); addResource(RESOURCE_CHILDREN, METHOD_GET, new NavigationService.GetChildren()); addResource(RESOURCE_DESCENDANTS, METHOD_GET, new NavigationService.GetDescendants()); addResource(RESOURCE_FOLDERTREE, METHOD_GET, new NavigationService.GetFolderTree()); addResource(RESOURCE_PARENTS, METHOD_GET, new NavigationService.GetObjectParents()); addResource(RESOURCE_CHECKEDOUT, METHOD_GET, new NavigationService.GetCheckedOutDocs()); addResource(RESOURCE_ENTRY, METHOD_GET, new ObjectService.GetObject()); addResource(RESOURCE_OBJECTBYID, METHOD_GET, new ObjectService.GetObject()); addResource(RESOURCE_OBJECTBYPATH, METHOD_GET, new ObjectService.GetObjectByPath()); addResource(RESOURCE_ALLOWABLEACIONS, METHOD_GET, new ObjectService.GetAllowableActions()); addResource(RESOURCE_CONTENT, METHOD_GET, new ObjectService.GetContentStream()); addResource(RESOURCE_CONTENT, METHOD_PUT, new ObjectService.SetOrAppendContentStream()); addResource(RESOURCE_CONTENT, METHOD_DELETE, new ObjectService.DeleteContentStream()); addResource(RESOURCE_CHILDREN, METHOD_POST, new ObjectService.Create()); addResource(RESOURCE_RELATIONSHIPS, METHOD_POST, new ObjectService.CreateRelationship()); addResource(RESOURCE_ENTRY, METHOD_PUT, new ObjectService.UpdateProperties()); addResource(RESOURCE_ENTRY, METHOD_DELETE, new ObjectService.DeleteObject()); addResource(RESOURCE_CHILDREN, METHOD_DELETE, new ObjectService.DeleteTree()); // 1.1 addResource(RESOURCE_DESCENDANTS, METHOD_DELETE, new ObjectService.DeleteTree()); addResource(RESOURCE_FOLDERTREE, METHOD_DELETE, new ObjectService.DeleteTree()); addResource(RESOURCE_BULK_UPDATE, METHOD_POST, new ObjectService.BulkUpdateProperties()); addResource(RESOURCE_CHECKEDOUT, METHOD_POST, new VersioningService.CheckOut()); addResource(RESOURCE_VERSIONS, METHOD_GET, new VersioningService.GetAllVersions()); addResource(RESOURCE_VERSIONS, METHOD_DELETE, new VersioningService.DeleteAllVersions()); addResource(RESOURCE_QUERY, METHOD_GET, new DiscoveryService.Query()); addResource(RESOURCE_QUERY, METHOD_POST, new DiscoveryService.Query()); addResource(RESOURCE_CHANGES, METHOD_GET, new DiscoveryService.GetContentChanges()); addResource(RESOURCE_RELATIONSHIPS, METHOD_GET, new RelationshipService.GetObjectRelationships()); addResource(RESOURCE_UNFILED, METHOD_POST, new MultiFilingService.RemoveObjectFromFolder()); addResource(RESOURCE_ACL, METHOD_GET, new AclService.GetAcl()); addResource(RESOURCE_ACL, METHOD_PUT, new AclService.ApplyAcl()); addResource(RESOURCE_POLICIES, METHOD_GET, new PolicyService.GetAppliedPolicies()); addResource(RESOURCE_POLICIES, METHOD_POST, new PolicyService.ApplyPolicy()); addResource(RESOURCE_POLICIES, METHOD_DELETE, new PolicyService.RemovePolicy()); } @Override protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { CallContext context = null; try { if (METHOD_HEAD.equals(request.getMethod())) { request = new HEADHttpServletRequestWrapper(request); response = new NoBodyHttpServletResponseWrapper(response); } else { request = new QueryStringHttpServletRequestWrapper(request); } // set default headers response.addHeader("Cache-Control", "private, max-age=0"); response.addHeader("Server", ServerVersion.OPENCMIS_SERVER); context = createContext(getServletContext(), request, response); dispatch(context, request, response); } catch (Exception e) { if (e instanceof CmisUnauthorizedException) { response.setHeader("WWW-Authenticate", "Basic realm=\"CMIS\""); response.sendError(HttpServletResponse.SC_UNAUTHORIZED, "Authorization Required"); } else if (e instanceof CmisPermissionDeniedException) { if ((context == null) || (context.getUsername() == null)) { response.setHeader("WWW-Authenticate", "Basic realm=\"CMIS\""); response.sendError(HttpServletResponse.SC_UNAUTHORIZED, "Authorization Required"); } else { response.sendError(getErrorCode((CmisPermissionDeniedException) e), e.getMessage()); } } else { printError(e, response); } } finally { // we are done. response.flushBuffer(); } } /** * Registers a new resource. */ protected void addResource(String resource, String httpMethod, ServiceCall serviceCall) { dispatcher.addResource(resource, httpMethod, serviceCall); } /** * Dispatches to feed, entry or whatever. */ private void dispatch(CallContext context, HttpServletRequest request, HttpServletResponse response) throws Exception { CmisService service = null; try { // get the service service = getServiceFactory().getService(context); // analyze the path String[] pathFragments = HttpUtils.splitPath(request); if (pathFragments.length < 2) { // root -> service document dispatcher.dispatch("", METHOD_GET, context, service, null, request, response); return; } String method = request.getMethod(); String repositoryId = pathFragments[0]; String resource = pathFragments[1]; // dispatch boolean callServiceFound = dispatcher.dispatch(resource, method, context, service, repositoryId, request, response); // if the dispatcher couldn't find a matching service // -> return an error message if (!callServiceFound) { response.sendError(HttpServletResponse.SC_METHOD_NOT_ALLOWED, "Unknown operation"); } } finally { if (service != null) { service.close(); } } } /** * Translates an exception in an appropriate HTTP error code. */ protected int getErrorCode(CmisBaseException ex) { if (ex instanceof CmisConstraintException) { return 409; } else if (ex instanceof CmisContentAlreadyExistsException) { return 409; } else if (ex instanceof CmisFilterNotValidException) { return 400; } else if (ex instanceof CmisInvalidArgumentException) { return 400; } else if (ex instanceof CmisNameConstraintViolationException) { return 409; } else if (ex instanceof CmisNotSupportedException) { return 405; } else if (ex instanceof CmisObjectNotFoundException) { return 404; } else if (ex instanceof CmisPermissionDeniedException) { return 403; } else if (ex instanceof CmisStorageException) { return 500; } else if (ex instanceof CmisStreamNotSupportedException) { return 403; } else if (ex instanceof CmisUpdateConflictException) { return 409; } else if (ex instanceof CmisVersioningException) { return 409; } return 500; } /** * Prints the error HTML page. */ protected void printError(Exception ex, HttpServletResponse response) { int statusCode = HttpServletResponse.SC_INTERNAL_SERVER_ERROR; String exceptionName = "runtime"; if (ex instanceof CmisRuntimeException) { LOG.error(ex.getMessage(), ex); } else if (ex instanceof CmisStorageException) { LOG.error(ex.getMessage(), ex); statusCode = getErrorCode((CmisStorageException) ex); exceptionName = ((CmisStorageException) ex).getExceptionName(); } else if (ex instanceof CmisBaseException) { statusCode = getErrorCode((CmisBaseException) ex); exceptionName = ((CmisBaseException) ex).getExceptionName(); } else if (ex instanceof IOException) { LOG.warn(ex.getMessage(), ex); } else { LOG.error(ex.getMessage(), ex); } if (response.isCommitted()) { LOG.warn("Failed to send error message to client. Response is already committed.", ex); return; } String message = ex.getMessage(); if (!(ex instanceof CmisBaseException)) { message = "An error occurred!"; } try { response.resetBuffer(); response.setStatus(statusCode); response.setContentType("text/html"); response.setCharacterEncoding(IOUtils.UTF8); PrintWriter pw = response.getWriter(); pw.print("<html><head><title>Apache Chemistry OpenCMIS - " + exceptionName + " error</title>" + "<style><!--H1 {font-size:24px;line-height:normal;font-weight:bold;background-color:#f0f0f0;color:#003366;border-bottom:1px solid #3c78b5;padding:2px;} " + "BODY {font-family:Verdana,arial,sans-serif;color:black;font-size:14px;} " + "HR {color:#3c78b5;height:1px;}--></style></head><body>"); pw.print("<h1>HTTP Status " + statusCode + " - <!--exception-->" + exceptionName + "<!--/exception--></h1>"); pw.print("<p><!--message-->" + StringEscapeUtils.escapeHtml(message) + "<!--/message--></p>"); String st = ExceptionHelper.getStacktraceAsString(ex); if (st != null) { pw.print("<hr noshade='noshade'/><!--stacktrace--><pre>\n" + st + "\n</pre><!--/stacktrace--><hr noshade='noshade'/>"); } pw.print("</body></html>"); } catch (Exception e) { LOG.error(e.getMessage(), e); try { response.sendError(statusCode, message); } catch (Exception en) { // there is nothing else we can do } } } }