Web Scripts:

- support url extension for specifying required response format - update scriptUrl method to handle various forms of specifying format on url - refactor web script request hierarchy; remove copy & paste - add reset web script registry to web script "Test Server" git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5803 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2025-08-07 17:49:17 +00:00 · 2007-05-29 17:34:36 +00:00
parent a484e6737f
commit b2a11b9832
16 changed files with 497 additions and 432 deletions
--- a/source/java/org/alfresco/web/scripts/WebScriptRequestImpl.java
+++ b/source/java/org/alfresco/web/scripts/WebScriptRequestImpl.java
@@ -0,0 +1,122 @@
+/*
+ * Copyright (C) 2005-2007 Alfresco Software Limited.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program 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 General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+ * As a special exception to the terms and conditions of version 2.0 of 
+ * the GPL, you may redistribute this Program in connection with Free/Libre 
+ * and Open Source Software ("FLOSS") applications as described in Alfresco's 
+ * FLOSS exception.  You should have recieved a copy of the text describing 
+ * the FLOSS exception, and it is also available here: 
+ * http://www.alfresco.com/legal/licensing"
+ */
+package org.alfresco.web.scripts;
+
+import org.alfresco.web.scripts.WebScriptDescription.FormatStyle;
+
+
+/**
+ * Basic Implementation of a Web Script Request
+ * 
+ * @author davidc
+ */
+public abstract class WebScriptRequestImpl implements WebScriptRequest
+{
+    
+    /* (non-Javadoc)
+     * @see org.alfresco.web.scripts.WebScriptRequest#getExtensionPath()
+     */
+    public String getExtensionPath()
+    {
+        String servicePath = getServiceMatch().getPath();
+        String extensionPath = getPathInfo();
+        int extIdx = extensionPath.indexOf(servicePath);
+        if (extIdx != -1)
+        {
+            int extLength = (servicePath.endsWith("/") ? servicePath.length() : servicePath.length() + 1);
+            extensionPath = extensionPath.substring(extIdx + extLength);
+        }
+        return extensionPath;
+    }
+
+    /* (non-Javadoc)
+     * @see org.alfresco.web.scripts.WebScriptRequest#isGuest()
+     */
+    public boolean isGuest()
+    {
+        return Boolean.valueOf(getParameter("guest"));
+    }
+
+    /* (non-Javadoc)
+     * @see org.alfresco.web.scripts.WebScriptRequest#getFormat()
+     */
+    public String getFormat()
+    {
+        String format = null;
+        FormatStyle style = getServiceMatch().getWebScript().getDescription().getFormatStyle();
+        
+        // extract format from extension
+        if (style == FormatStyle.extension || style == FormatStyle.any)
+        {
+            String pathInfo = getPathInfo();
+            int extIdx = pathInfo.lastIndexOf('.');
+            if (extIdx != -1)
+            {
+                format = pathInfo.substring(extIdx +1);
+            }
+        }
+        
+        // extract format from argument
+        if (style == FormatStyle.argument || style == FormatStyle.any)
+        {
+            String argFormat = getParameter("format");
+            if (argFormat != null)
+            {
+                if (format != null && format.length() > 0)
+                {
+                    throw new WebScriptException("Format specified both in extension and format argument");
+                }
+                format = argFormat;
+            }
+        }
+        
+        return (format == null || format.length() == 0) ? "" : format;
+    }
+
+    /* (non-Javadoc)
+     * @see org.alfresco.web.scripts.WebScriptRequest#getFormatStyle()
+     */
+    public FormatStyle getFormatStyle()
+    {
+        FormatStyle style = getServiceMatch().getWebScript().getDescription().getFormatStyle();
+        if (style != FormatStyle.any)
+        {
+            return style;
+        }
+        else
+        {
+            String argFormat = getParameter("format");
+            if (argFormat != null && argFormat.length() > 0)
+            {
+                return FormatStyle.argument;
+            }
+            else
+            {
+                return FormatStyle.extension;
+            }
+        }
+    }
+    
+}