Moved remote-api master into its own directory

2025-07-31 17:39:05 +00:00 · 2020-07-21 10:44:10 +01:00
parent f0485147b7
commit e0291f29eb
2274 changed files with 0 additions and 0 deletions
--- a/remote-api/src/main/java/org/alfresco/opencmis/CMISServletDispatcher.java
+++ b/remote-api/src/main/java/org/alfresco/opencmis/CMISServletDispatcher.java
@@ -0,0 +1,601 @@
+/*
+ * #%L
+ * Alfresco Remote API
+ * %%
+ * Copyright (C) 2005 - 2016 Alfresco Software Limited
+ * %%
+ * This file is part of the Alfresco software. 
+ * If the software was purchased under a paid Alfresco license, the terms of 
+ * the paid license agreement will prevail.  Otherwise, the software is 
+ * provided under the following open source license terms:
+ * 
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ * #L%
+ */
+package org.alfresco.opencmis;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.PrintWriter;
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Enumeration;
+import java.util.EventListener;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Locale;
+import java.util.Map;
+import java.util.Set;
+
+import javax.servlet.Filter;
+import javax.servlet.FilterRegistration;
+import javax.servlet.RequestDispatcher;
+import javax.servlet.Servlet;
+import javax.servlet.ServletConfig;
+import javax.servlet.ServletContext;
+import javax.servlet.ServletException;
+import javax.servlet.ServletOutputStream;
+import javax.servlet.ServletRegistration;
+import javax.servlet.SessionCookieConfig;
+import javax.servlet.SessionTrackingMode;
+import javax.servlet.descriptor.JspConfigDescriptor;
+import javax.servlet.http.Cookie;
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletResponse;
+
+import org.alfresco.error.AlfrescoRuntimeException;
+import org.alfresco.opencmis.CMISDispatcherRegistry.Binding;
+import org.alfresco.opencmis.CMISDispatcherRegistry.Endpoint;
+import org.alfresco.repo.tenant.TenantAdminService;
+import org.alfresco.service.descriptor.Descriptor;
+import org.alfresco.service.descriptor.DescriptorService;
+import org.apache.chemistry.opencmis.commons.enums.CmisVersion;
+import org.apache.chemistry.opencmis.commons.server.CmisServiceFactory;
+import org.apache.chemistry.opencmis.server.impl.CmisRepositoryContextListener;
+import org.apache.chemistry.opencmis.server.impl.atompub.CmisAtomPubServlet;
+import org.springframework.extensions.webscripts.WebScriptRequest;
+import org.springframework.extensions.webscripts.WebScriptResponse;
+import org.springframework.extensions.webscripts.servlet.WebScriptServletRuntime;
+
+/**
+ * Dispatches OpenCMIS requests to a servlet e.g. the OpenCMIS AtomPub servlet.
+ * 
+ * @author steveglover
+ *
+ */
+public abstract class CMISServletDispatcher implements CMISDispatcher
+{
+	private DescriptorService descriptorService;
+    private Descriptor currentDescriptor;
+    protected CmisServiceFactory cmisServiceFactory;
+    protected HttpServlet servlet;
+	protected CMISDispatcherRegistry registry;
+	protected String serviceName;
+	protected BaseUrlGenerator baseUrlGenerator;
+	protected String version;
+	protected CmisVersion cmisVersion;
+	protected TenantAdminService tenantAdminService;
+
+    private Set<String> nonAttachContentTypes = Collections.emptySet(); // pre-configured whitelist, eg. images & pdf
+
+	public void setTenantAdminService(TenantAdminService tenantAdminService)
+	{
+        this.tenantAdminService = tenantAdminService;
+    }
+
+    public void setDescriptorService(DescriptorService descriptorService)
+	{
+		this.descriptorService = descriptorService;
+	}
+
+	public void setVersion(String version)
+	{
+		this.version = version;
+	}
+
+	public void setBaseUrlGenerator(BaseUrlGenerator baseUrlGenerator)
+	{
+		this.baseUrlGenerator = baseUrlGenerator;
+	}
+
+	public void setRegistry(CMISDispatcherRegistry registry)
+	{
+		this.registry = registry;
+	}
+
+	public void setCmisServiceFactory(CmisServiceFactory cmisServiceFactory)
+    {
+        this.cmisServiceFactory = cmisServiceFactory;
+    }
+	
+	public void setServiceName(String serviceName)
+	{
+		this.serviceName = serviceName;
+	}
+
+	public String getServiceName()
+	{
+		return serviceName;
+	}
+	
+	public void setCmisVersion(String cmisVersion)
+    {
+        this.cmisVersion = CmisVersion.fromValue(cmisVersion);
+    }
+
+    public void setNonAttachContentTypes(Set<String> nonAttachWhiteList)
+    {
+        this.nonAttachContentTypes = nonAttachWhiteList;
+    }
+
+    protected synchronized Descriptor getCurrentDescriptor()
+	{
+		if(this.currentDescriptor == null)
+		{
+			this.currentDescriptor = descriptorService.getCurrentRepositoryDescriptor();
+		}
+
+		return this.currentDescriptor;
+	}
+	
+	public void init()
+	{
+		Endpoint endpoint = new Endpoint(getBinding(), version);
+		registry.registerDispatcher(endpoint, this);
+
+		try
+		{
+			// fake the CMIS servlet
+			ServletConfig config = getServletConfig();
+	    	this.servlet = getServlet();
+	    	servlet.init(config);
+		}
+		catch(ServletException e)
+		{
+			throw new AlfrescoRuntimeException("Failed to initialise CMIS servlet dispatcher", e);
+		}
+	}
+
+	/*
+	 *  Implement getBinding to provide the appropriate CMIS binding.
+	 */
+    protected abstract Binding getBinding();
+    
+	/*
+	 *  Implement getServlet to provide the appropriate servlet implementation.
+	 */
+	protected abstract HttpServlet getServlet();
+
+	protected Object getServletAttribute(String attrName)
+	{
+		if(attrName.equals(CmisRepositoryContextListener.SERVICES_FACTORY))
+		{
+			return cmisServiceFactory;
+		}
+
+		return null;
+	}
+	
+    protected ServletConfig getServletConfig()
+    {
+    	ServletConfig config = new CMISServletConfig();
+    	return config;
+    }
+
+    protected CMISHttpServletRequest getHttpRequest(WebScriptRequest req)
+	{
+		String serviceName = getServiceName();
+		CMISHttpServletRequest httpReqWrapper = new CMISHttpServletRequest(req, serviceName, baseUrlGenerator,
+		        getBinding(), currentDescriptor, tenantAdminService);
+    	return httpReqWrapper;
+	}
+
+	protected CMISHttpServletResponse getHttpResponse(WebScriptResponse res)
+	{
+		CMISHttpServletResponse httpResWrapper = new CMISHttpServletResponse(res, nonAttachContentTypes);
+
+		return httpResWrapper;
+	}
+
+	public void execute(WebScriptRequest req, WebScriptResponse res) throws IOException
+	{
+		try
+		{
+			// wrap request & response
+			CMISHttpServletResponse httpResWrapper = getHttpResponse(res);
+	    	CMISHttpServletRequest httpReqWrapper = getHttpRequest(req);
+
+	    	servlet.service(httpReqWrapper, httpResWrapper);
+		}
+		catch(ServletException e)
+		{
+			throw new AlfrescoRuntimeException("", e);
+		}
+	}
+
+    /**
+     * Fake a CMIS servlet config.
+     * 
+     * @author steveglover
+     *
+     */
+	@SuppressWarnings("rawtypes")
+    private class CMISServletConfig implements ServletConfig
+    {
+		private List parameterNames = new ArrayList();
+
+    	@SuppressWarnings("unchecked")
+		CMISServletConfig()
+    	{
+    		parameterNames.add(CmisAtomPubServlet.PARAM_CALL_CONTEXT_HANDLER);
+            parameterNames.add(CmisAtomPubServlet.PARAM_CMIS_VERSION);
+		}
+
+		@Override
+		public String getInitParameter(String arg0)
+		{
+			if(arg0.equals(CmisAtomPubServlet.PARAM_CALL_CONTEXT_HANDLER))
+			{
+				return PublicApiCallContextHandler.class.getName();
+			}
+			else if(arg0.equals(CmisAtomPubServlet.PARAM_CMIS_VERSION))
+			{
+				return (cmisVersion != null ? cmisVersion.value() : CmisVersion.CMIS_1_0.value());
+			}
+			return null;
+		}
+
+		@Override
+		public Enumeration getInitParameterNames()
+		{
+			final Iterator it = parameterNames.iterator();
+
+			Enumeration e = new Enumeration()
+			{
+				@Override
+				public boolean hasMoreElements()
+				{
+					return it.hasNext();
+				}
+
+				@Override
+				public Object nextElement()
+				{
+					return it.next();
+				}
+			};
+			return e;
+		}
+
+		// fake a servlet context. Note that getAttribute is the only method that the servlet uses,
+		// hence the other methods are not implemented.
+		@Override
+		public ServletContext getServletContext()
+		{
+			return new ServletContext()
+			{
+
+				@Override
+				public Object getAttribute(String arg0)
+				{
+					return getServletAttribute(arg0);
+				}
+
+				@Override
+				public Enumeration getAttributeNames()
+				{
+					return null;
+				}
+
+				@Override
+				public String getContextPath()
+				{
+					return null;
+				}
+
+				@Override
+				public ServletContext getContext(String arg0)
+				{
+					return null;
+				}
+
+				@Override
+				public String getInitParameter(String arg0)
+				{
+					return null;
+				}
+
+				@Override
+				public Enumeration getInitParameterNames()
+				{
+					return null;
+				}
+
+				@Override
+				public boolean setInitParameter(String name, String value)
+				{
+					return false;
+				}
+
+				@Override
+				public int getMajorVersion()
+				{
+					return 0;
+				}
+
+				@Override
+				public String getMimeType(String arg0)
+				{
+					return null;
+				}
+
+				@Override
+				public int getMinorVersion()
+				{
+					return 0;
+				}
+
+				@Override
+				public int getEffectiveMajorVersion()
+				{
+					return 0;
+				}
+
+				@Override
+				public int getEffectiveMinorVersion()
+				{
+					return 0;
+				}
+
+				@Override
+				public RequestDispatcher getNamedDispatcher(String arg0)
+				{
+					return null;
+				}
+
+				@Override
+				public String getRealPath(String arg0)
+				{
+					return null;
+				}
+
+				@Override
+				public RequestDispatcher getRequestDispatcher(String arg0)
+				{
+					return null;
+				}
+
+				@Override
+				public URL getResource(String arg0) throws MalformedURLException
+				{
+					return null;
+				}
+
+				@Override
+				public InputStream getResourceAsStream(String arg0)
+				{
+					return null;
+				}
+
+				@Override
+				public Set getResourcePaths(String arg0)
+				{
+					return null;
+				}
+
+				@Override
+				public String getServerInfo()
+				{
+					return null;
+				}
+
+				@Override
+				public Servlet getServlet(String arg0) throws ServletException
+				{
+					return null;
+				}
+
+				@Override
+				public String getServletContextName()
+				{
+					return null;
+				}
+
+				@Override
+				public ServletRegistration.Dynamic addServlet(String servletName, String className)
+				{
+					return null;
+				}
+
+				@Override
+				public ServletRegistration.Dynamic addServlet(String servletName, Servlet servlet)
+				{
+					return null;
+				}
+
+				@Override
+				public ServletRegistration.Dynamic addServlet(String servletName, Class<? extends Servlet> servletClass)
+				{
+					return null;
+				}
+
+				@Override
+				public <T extends Servlet> T createServlet(Class<T> clazz) throws ServletException
+				{
+					return null;
+				}
+
+				@Override
+				public ServletRegistration getServletRegistration(String servletName)
+				{
+					return null;
+				}
+
+				@Override
+				public Map<String, ? extends ServletRegistration> getServletRegistrations()
+				{
+					return null;
+				}
+
+				@Override
+				public FilterRegistration.Dynamic addFilter(String filterName, String className)
+				{
+					return null;
+				}
+
+				@Override
+				public FilterRegistration.Dynamic addFilter(String filterName, Filter filter)
+				{
+					return null;
+				}
+
+				@Override
+				public FilterRegistration.Dynamic addFilter(String filterName, Class<? extends Filter> filterClass)
+				{
+					return null;
+				}
+
+				@Override
+				public <T extends Filter> T createFilter(Class<T> clazz) throws ServletException
+				{
+					return null;
+				}
+
+				@Override
+				public FilterRegistration getFilterRegistration(String filterName)
+				{
+					return null;
+				}
+
+				@Override
+				public Map<String, ? extends FilterRegistration> getFilterRegistrations()
+				{
+					return null;
+				}
+
+				@Override
+				public SessionCookieConfig getSessionCookieConfig()
+				{
+					return null;
+				}
+
+				@Override
+				public void setSessionTrackingModes(Set<SessionTrackingMode> sessionTrackingModes)
+				{
+
+				}
+
+				@Override
+				public Set<SessionTrackingMode> getDefaultSessionTrackingModes()
+				{
+					return null;
+				}
+
+				@Override
+				public Set<SessionTrackingMode> getEffectiveSessionTrackingModes()
+				{
+					return null;
+				}
+
+				@Override
+				public void addListener(String className)
+				{
+
+				}
+
+				@Override
+				public <T extends EventListener> void addListener(T t)
+				{
+
+				}
+
+				@Override
+				public void addListener(Class<? extends EventListener> listenerClass)
+				{
+
+				}
+
+				@Override
+				public <T extends EventListener> T createListener(Class<T> clazz) throws ServletException
+				{
+					return null;
+				}
+
+				@Override
+				public JspConfigDescriptor getJspConfigDescriptor()
+				{
+					return null;
+				}
+
+				@Override
+				public ClassLoader getClassLoader()
+				{
+					return null;
+				}
+
+				@Override
+				public void declareRoles(String... roleNames)
+				{
+
+				}
+
+				@Override
+				public Enumeration getServletNames()
+				{
+					return null;
+				}
+
+				@Override
+				public Enumeration getServlets()
+				{
+					return null;
+				}
+
+				@Override
+				public void log(String arg0)
+				{
+				}
+
+				@Override
+				public void log(Exception arg0, String arg1)
+				{
+				}
+
+				@Override
+				public void log(String arg0, Throwable arg1)
+				{
+				}
+
+				@Override
+				public void removeAttribute(String arg0)
+				{
+				}
+
+				@Override
+				public void setAttribute(String arg0, Object arg1)
+				{
+				}
+			};
+		}
+
+		@Override
+		public String getServletName()
+		{
+			return "OpenCMIS";
+		}
+    }
+}