Web Scripts:

- Addition of reponse status code and template support - Appropriate status codes added to login & ticket web scripts - Web Script Index page also mapped to / url - Various fixes applied to url to web script mapping git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5846 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2025-08-07 17:49:17 +00:00 · 2007-06-05 10:41:51 +00:00
parent 546eccf561
commit ac9960758f
28 changed files with 1081 additions and 218 deletions
--- a/source/java/org/alfresco/web/scripts/bean/Index.java
+++ b/source/java/org/alfresco/web/scripts/bean/Index.java
@@ -29,7 +29,7 @@ import java.util.Map;

 import org.alfresco.web.scripts.DeclarativeWebScript;
 import org.alfresco.web.scripts.WebScriptRequest;
-import org.alfresco.web.scripts.WebScriptResponse;
+import org.alfresco.web.scripts.WebScriptStatus;


 /**
@@ -44,7 +44,7 @@ public class Index extends DeclarativeWebScript
     * @see org.alfresco.web.scripts.DeclarativeWebScript#executeImpl(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.WebScriptResponse)
     */
    @Override
-    protected Map<String, Object> executeImpl(WebScriptRequest req, WebScriptResponse res)
+    protected Map<String, Object> executeImpl(WebScriptRequest req, WebScriptStatus status)
    {
        Map<String, Object> model = new HashMap<String, Object>(7, 1.0f);
        model.put("webscripts",  getWebScriptRegistry().getWebScripts());
--- a/source/java/org/alfresco/web/scripts/bean/IndexPackage.java
+++ b/source/java/org/alfresco/web/scripts/bean/IndexPackage.java
@@ -31,7 +31,7 @@ import org.alfresco.web.scripts.DeclarativeWebScript;
 import org.alfresco.web.scripts.WebScriptException;
 import org.alfresco.web.scripts.WebScriptPath;
 import org.alfresco.web.scripts.WebScriptRequest;
-import org.alfresco.web.scripts.WebScriptResponse;
+import org.alfresco.web.scripts.WebScriptStatus;


 /**
@@ -46,7 +46,7 @@ public class IndexPackage extends DeclarativeWebScript
     * @see org.alfresco.web.scripts.DeclarativeWebScript#executeImpl(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.WebScriptResponse)
     */
    @Override
-    protected Map<String, Object> executeImpl(WebScriptRequest req, WebScriptResponse res)
+    protected Map<String, Object> executeImpl(WebScriptRequest req, WebScriptStatus status)
    {
        // extract web script package
        String packagePath = req.getExtensionPath();
--- a/source/java/org/alfresco/web/scripts/bean/IndexURI.java
+++ b/source/java/org/alfresco/web/scripts/bean/IndexURI.java
@@ -31,7 +31,7 @@ import org.alfresco.web.scripts.DeclarativeWebScript;
 import org.alfresco.web.scripts.WebScriptException;
 import org.alfresco.web.scripts.WebScriptPath;
 import org.alfresco.web.scripts.WebScriptRequest;
-import org.alfresco.web.scripts.WebScriptResponse;
+import org.alfresco.web.scripts.WebScriptStatus;


 /**
@@ -46,7 +46,7 @@ public class IndexURI extends DeclarativeWebScript
     * @see org.alfresco.web.scripts.DeclarativeWebScript#executeImpl(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.WebScriptResponse)
     */
    @Override
-    protected Map<String, Object> executeImpl(WebScriptRequest req, WebScriptResponse res)
+    protected Map<String, Object> executeImpl(WebScriptRequest req, WebScriptStatus status)
    {
        // extract web script package
        String uriPath = req.getExtensionPath();
--- a/source/java/org/alfresco/web/scripts/bean/IndexUpdate.java
+++ b/source/java/org/alfresco/web/scripts/bean/IndexUpdate.java
@@ -31,7 +31,7 @@ import java.util.Map;

 import org.alfresco.web.scripts.DeclarativeWebScript;
 import org.alfresco.web.scripts.WebScriptRequest;
-import org.alfresco.web.scripts.WebScriptResponse;
+import org.alfresco.web.scripts.WebScriptStatus;


 /**
@@ -46,7 +46,7 @@ public class IndexUpdate extends DeclarativeWebScript
     * @see org.alfresco.web.scripts.DeclarativeWebScript#executeImpl(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.WebScriptResponse)
     */
    @Override
-    protected Map<String, Object> executeImpl(WebScriptRequest req, WebScriptResponse res)
+    protected Map<String, Object> executeImpl(WebScriptRequest req, WebScriptStatus status)
    {
        List<String> tasks = new ArrayList<String>();

--- a/source/java/org/alfresco/web/scripts/bean/KeywordSearch.java
+++ b/source/java/org/alfresco/web/scripts/bean/KeywordSearch.java
@@ -42,7 +42,7 @@ import org.alfresco.util.ParameterCheck;
 import org.alfresco.web.scripts.DeclarativeWebScript;
 import org.alfresco.web.scripts.WebScriptException;
 import org.alfresco.web.scripts.WebScriptRequest;
-import org.alfresco.web.scripts.WebScriptResponse;
+import org.alfresco.web.scripts.WebScriptStatus;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;

@@ -78,7 +78,7 @@ public class KeywordSearch extends DeclarativeWebScript
     * @see org.alfresco.web.scripts.DeclarativeWebScript#executeImpl(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.WebScriptResponse)
     */
    @Override
-    protected Map<String, Object> executeImpl(WebScriptRequest req, WebScriptResponse res)
+    protected Map<String, Object> executeImpl(WebScriptRequest req, WebScriptStatus status)
    {
        //
        // process arguments
--- a/source/java/org/alfresco/web/scripts/bean/Login.java
+++ b/source/java/org/alfresco/web/scripts/bean/Login.java
@@ -27,11 +27,14 @@ package org.alfresco.web.scripts.bean;
 import java.util.HashMap;
 import java.util.Map;

+import javax.servlet.http.HttpServletResponse;
+
+import org.alfresco.repo.security.authentication.AuthenticationException;
 import org.alfresco.service.cmr.security.AuthenticationService;
 import org.alfresco.web.scripts.DeclarativeWebScript;
 import org.alfresco.web.scripts.WebScriptException;
 import org.alfresco.web.scripts.WebScriptRequest;
-import org.alfresco.web.scripts.WebScriptResponse;
+import org.alfresco.web.scripts.WebScriptStatus;


 /**
@@ -57,26 +60,34 @@ public class Login extends DeclarativeWebScript
     * @see org.alfresco.web.scripts.DeclarativeWebScript#executeImpl(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.WebScriptResponse)
     */
    @Override
-    protected Map<String, Object> executeImpl(WebScriptRequest req, WebScriptResponse res)
+    protected Map<String, Object> executeImpl(WebScriptRequest req, WebScriptStatus status)
    {
        // extract username and password
        String username = req.getParameter("u");
        if (username == null || username.length() == 0)
        {
-            throw new WebScriptException("Username has not been specified");
+            throw new WebScriptException(HttpServletResponse.SC_BAD_REQUEST, "Username not specified");
        }
        String password = req.getParameter("pw");
-        
-        // get ticket
-        authenticationService.authenticate(username, password == null ? null : password.toCharArray());
-        
-        // add ticket to model for javascript and template access
+        if (password == null)
+        {
+            throw new WebScriptException(HttpServletResponse.SC_BAD_REQUEST, "Password not specified");
+        }
+
        try
        {
+            // get ticket
+            authenticationService.authenticate(username, password.toCharArray());
+
+            // add ticket to model for javascript and template access
            Map<String, Object> model = new HashMap<String, Object>(7, 1.0f);
            model.put("ticket",  authenticationService.getCurrentTicket());
            return model;
        }
+        catch(AuthenticationException e)
+        {
+            throw new WebScriptException(HttpServletResponse.SC_FORBIDDEN, "Login failed");
+        }
        finally
        {
            authenticationService.clearCurrentSecurityContext();
--- a/source/java/org/alfresco/web/scripts/bean/LoginTicket.java
+++ b/source/java/org/alfresco/web/scripts/bean/LoginTicket.java
@@ -27,13 +27,15 @@ package org.alfresco.web.scripts.bean;
 import java.util.HashMap;
 import java.util.Map;

+import javax.servlet.http.HttpServletResponse;
+
 import org.alfresco.repo.security.authentication.AuthenticationException;
 import org.alfresco.repo.security.authentication.AuthenticationUtil;
 import org.alfresco.repo.security.authentication.TicketComponent;
 import org.alfresco.web.scripts.DeclarativeWebScript;
 import org.alfresco.web.scripts.WebScriptException;
 import org.alfresco.web.scripts.WebScriptRequest;
-import org.alfresco.web.scripts.WebScriptResponse;
+import org.alfresco.web.scripts.WebScriptStatus;


 /**
@@ -59,15 +61,19 @@ public class LoginTicket extends DeclarativeWebScript
     * @see org.alfresco.web.scripts.DeclarativeWebScript#executeImpl(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.WebScriptResponse)
     */
    @Override
-    protected Map<String, Object> executeImpl(WebScriptRequest req, WebScriptResponse res)
+    protected Map<String, Object> executeImpl(WebScriptRequest req, WebScriptStatus status)
    {
        // retrieve ticket from request and current ticket
        String ticket = req.getExtensionPath();
        if (ticket == null && ticket.length() == 0)
        {
-            throw new WebScriptException("Ticket not specified");
+            throw new WebScriptException(HttpServletResponse.SC_BAD_REQUEST, "Ticket not specified");
        }
        
+        // construct model for ticket
+        Map<String, Object> model = new HashMap<String, Object>(7, 1.0f);
+        model.put("ticket",  ticket);
+
        try
        {
            String ticketUser = ticketComponent.validateTicket(ticket);
@@ -75,17 +81,18 @@ public class LoginTicket extends DeclarativeWebScript
            // do not go any further if tickets are different
            if (!AuthenticationUtil.getCurrentUserName().equals(ticketUser))
            {
-                // TODO: 404 error
-                throw new WebScriptException("Ticket not found");
+                status.setRedirect(true);
+                status.setCode(HttpServletResponse.SC_NOT_FOUND);
+                status.setMessage("Ticket not found");
            }
        }
        catch(AuthenticationException e)
        {
-            throw new WebScriptException("Ticket not found");
+            status.setRedirect(true);
+            status.setCode(HttpServletResponse.SC_NOT_FOUND);
+            status.setMessage("Ticket not found");
        }
        
-        Map<String, Object> model = new HashMap<String, Object>(7, 1.0f);
-        model.put("ticket",  ticket);
        return model;
    }

--- a/source/java/org/alfresco/web/scripts/bean/LoginTicketDelete.java
+++ b/source/java/org/alfresco/web/scripts/bean/LoginTicketDelete.java
@@ -27,6 +27,8 @@ package org.alfresco.web.scripts.bean;
 import java.util.HashMap;
 import java.util.Map;

+import javax.servlet.http.HttpServletResponse;
+
 import org.alfresco.repo.security.authentication.AuthenticationException;
 import org.alfresco.repo.security.authentication.AuthenticationUtil;
 import org.alfresco.repo.security.authentication.TicketComponent;
@@ -34,7 +36,7 @@ import org.alfresco.service.cmr.security.AuthenticationService;
 import org.alfresco.web.scripts.DeclarativeWebScript;
 import org.alfresco.web.scripts.WebScriptException;
 import org.alfresco.web.scripts.WebScriptRequest;
-import org.alfresco.web.scripts.WebScriptResponse;
+import org.alfresco.web.scripts.WebScriptStatus;


 /**
@@ -69,15 +71,19 @@ public class LoginTicketDelete extends DeclarativeWebScript
     * @see org.alfresco.web.scripts.DeclarativeWebScript#executeImpl(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.WebScriptResponse)
     */
    @Override
-    protected Map<String, Object> executeImpl(WebScriptRequest req, WebScriptResponse res)
+    protected Map<String, Object> executeImpl(WebScriptRequest req, WebScriptStatus status)
    {
        // retrieve ticket from request and current ticket
        String ticket = req.getExtensionPath();
        if (ticket == null && ticket.length() == 0)
        {
-            throw new WebScriptException("Ticket not specified");
+            throw new WebScriptException(HttpServletResponse.SC_BAD_REQUEST, "Ticket not specified");
        }
        
+        // construct model for ticket
+        Map<String, Object> model = new HashMap<String, Object>(7, 1.0f);
+        model.put("ticket",  ticket);
+
        try
        {
            String ticketUser = ticketComponent.validateTicket(ticket);
@@ -85,20 +91,23 @@ public class LoginTicketDelete extends DeclarativeWebScript
            // do not go any further if tickets are different
            if (!AuthenticationUtil.getCurrentUserName().equals(ticketUser))
            {
-                // TODO: 404 error
-                throw new WebScriptException("Ticket not found");
+                status.setRedirect(true);
+                status.setCode(HttpServletResponse.SC_NOT_FOUND);
+                status.setMessage("Ticket not found");
+            }
+            else
+            {
+                // delete the ticket
+                authenticationService.invalidateTicket(ticket);
            }
        }
        catch(AuthenticationException e)
        {
-            throw new WebScriptException("Ticket not found");
+            status.setRedirect(true);
+            status.setCode(HttpServletResponse.SC_NOT_FOUND);
+            status.setMessage("Ticket not found");
        }
        
-        // delete the ticket
-        authenticationService.invalidateTicket(ticket);
-        
-        Map<String, Object> model = new HashMap<String, Object>(7, 1.0f);
-        model.put("ticket",  ticket);
        return model;
    }

--- a/source/java/org/alfresco/web/scripts/bean/SearchEngines.java
+++ b/source/java/org/alfresco/web/scripts/bean/SearchEngines.java
@@ -36,7 +36,7 @@ import org.alfresco.repo.content.MimetypeMap;
 import org.alfresco.web.config.OpenSearchConfigElement;
 import org.alfresco.web.scripts.DeclarativeWebScript;
 import org.alfresco.web.scripts.WebScriptRequest;
-import org.alfresco.web.scripts.WebScriptResponse;
+import org.alfresco.web.scripts.WebScriptStatus;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;

@@ -80,7 +80,7 @@ public class SearchEngines extends DeclarativeWebScript
     * @see org.alfresco.web.scripts.DeclarativeWebScript#executeImpl(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.WebScriptResponse)
     */
    @Override
-    protected Map<String, Object> executeImpl(WebScriptRequest req, WebScriptResponse res)
+    protected Map<String, Object> executeImpl(WebScriptRequest req, WebScriptStatus status)
    {
        String urlType = req.getParameter("type");
        if (urlType == null || urlType.length() == 0)