Web Scripts:

- improved generated documentation (indexed by web script url & package)
- addition of ticket management web scripts
- addition of put, post & delete support to Web Script test server

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5820 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/web/scripts/bean/Index.java

@@ -33,7 +33,7 @@ import org.alfresco.web.scripts.WebScriptResponse;
 
 
 /**
- * Retrieves the list of available Web Scripts
+ * Index of all Web Scripts
  * 
  * @author davidc
  */
@@ -48,6 +48,8 @@ public class Index extends DeclarativeWebScript
     {
         Map<String, Object> model = new HashMap<String, Object>(7, 1.0f);
         model.put("webscripts",  getWebScriptRegistry().getWebScripts());
+        model.put("rooturl", getWebScriptRegistry().getUri("/"));
+        model.put("rootpackage", getWebScriptRegistry().getPackage("/"));
         return model;
     }
 

source/java/org/alfresco/web/scripts/bean/IndexPackage.java

@@ -0,0 +1,74 @@
+/*
+ * 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.bean;
+
+import java.util.HashMap;
+import java.util.Map;
+
+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;
+
+
+/**
+ * Index of a Web Script Package
+ * 
+ * @author davidc
+ */
+public class IndexPackage extends DeclarativeWebScript
+{
+
+    /* (non-Javadoc)
+     * @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)
+    {
+        // extract web script package
+        String packagePath = req.getExtensionPath();
+        if (packagePath == null || packagePath.length() == 0)
+        {
+            packagePath = "/";
+        }
+        if (!packagePath.startsWith("/"))
+        {
+            packagePath = "/" + packagePath;
+        }
+        
+        // locate web script package
+        WebScriptPath path = getWebScriptRegistry().getPackage(packagePath);
+        if (path == null)
+        {
+            throw new WebScriptException("Web Script Package '" + packagePath + "' not found");
+        }
+        
+        Map<String, Object> model = new HashMap<String, Object>(7, 1.0f);
+        model.put("package",  path);
+        return model;
+    }
+
+}

source/java/org/alfresco/web/scripts/bean/IndexURI.java

@@ -0,0 +1,74 @@
+/*
+ * 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.bean;
+
+import java.util.HashMap;
+import java.util.Map;
+
+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;
+
+
+/**
+ * Index of a Web Script URI
+ * 
+ * @author davidc
+ */
+public class IndexURI extends DeclarativeWebScript
+{
+
+    /* (non-Javadoc)
+     * @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)
+    {
+        // extract web script package
+        String uriPath = req.getExtensionPath();
+        if (uriPath == null || uriPath.length() == 0)
+        {
+            uriPath = "/";
+        }
+        if (!uriPath.startsWith("/"))
+        {
+            uriPath = "/" + uriPath;
+        }
+        
+        // locate web script package
+        WebScriptPath path = getWebScriptRegistry().getUri(uriPath);
+        if (path == null)
+        {
+            throw new WebScriptException("Web Script URI '" + uriPath + "' not found");
+        }
+        
+        Map<String, Object> model = new HashMap<String, Object>(7, 1.0f);
+        model.put("uri",  path);
+        return model;
+    }
+
+}

source/java/org/alfresco/web/scripts/bean/Login.java

@@ -0,0 +1,86 @@
+/*
+ * 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.bean;
+
+import java.util.HashMap;
+import java.util.Map;
+
+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;
+
+
+/**
+ * Login and establish a ticket
+ * 
+ * @author davidc
+ */
+public class Login extends DeclarativeWebScript
+{
+    // dependencies
+    private AuthenticationService authenticationService;
+    
+    /**
+     * @param authenticationService
+     */
+    public void setAuthenticationService(AuthenticationService authenticationService)
+    {
+        this.authenticationService = authenticationService;
+    }
+    
+    
+    /* (non-Javadoc)
+     * @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)
+    {
+        // extract username and password
+        String username = req.getParameter("u");
+        if (username == null || username.length() == 0)
+        {
+            throw new WebScriptException("Username has not been 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
+        try
+        {
+            Map<String, Object> model = new HashMap<String, Object>(7, 1.0f);
+            model.put("ticket",  authenticationService.getCurrentTicket());
+            return model;
+        }
+        finally
+        {
+            authenticationService.clearCurrentSecurityContext();
+        }
+    }
+
+}

source/java/org/alfresco/web/scripts/bean/LoginTicket.java

@@ -0,0 +1,92 @@
+/*
+ * 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.bean;
+
+import java.util.HashMap;
+import java.util.Map;
+
+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;
+
+
+/**
+ * Login Ticket
+ * 
+ * @author davidc
+ */
+public class LoginTicket extends DeclarativeWebScript
+{
+    // dependencies
+    private TicketComponent ticketComponent;
+    
+    /**
+     * @param ticketComponent
+     */
+    public void setTicketComponent(TicketComponent ticketComponent)
+    {
+        this.ticketComponent = ticketComponent;
+    }
+    
+    
+    /* (non-Javadoc)
+     * @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)
+    {
+        // retrieve ticket from request and current ticket
+        String ticket = req.getExtensionPath();
+        if (ticket == null && ticket.length() == 0)
+        {
+            throw new WebScriptException("Ticket not specified");
+        }
+        
+        try
+        {
+            String ticketUser = ticketComponent.validateTicket(ticket);
+
+            // do not go any further if tickets are different
+            if (!AuthenticationUtil.getCurrentUserName().equals(ticketUser))
+            {
+                // TODO: 404 error
+                throw new WebScriptException("Ticket not found");
+            }
+        }
+        catch(AuthenticationException e)
+        {
+            throw new WebScriptException("Ticket not found");
+        }
+        
+        Map<String, Object> model = new HashMap<String, Object>(7, 1.0f);
+        model.put("ticket",  ticket);
+        return model;
+    }
+
+}

source/java/org/alfresco/web/scripts/bean/LoginTicketDelete.java

@@ -0,0 +1,105 @@
+/*
+ * 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.bean;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import org.alfresco.repo.security.authentication.AuthenticationException;
+import org.alfresco.repo.security.authentication.AuthenticationUtil;
+import org.alfresco.repo.security.authentication.TicketComponent;
+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;
+
+
+/**
+ * Delete Login Ticket
+ * 
+ * @author davidc
+ */
+public class LoginTicketDelete extends DeclarativeWebScript
+{
+    // dependencies
+    private AuthenticationService authenticationService;
+    private TicketComponent ticketComponent;
+    
+    /**
+     * @param ticketComponent
+     */
+    public void setTicketComponent(TicketComponent ticketComponent)
+    {
+        this.ticketComponent = ticketComponent;
+    }
+
+    /**
+     * @param authenticationService
+     */
+    public void setAuthenticationService(AuthenticationService authenticationService)
+    {
+        this.authenticationService = authenticationService;
+    }
+
+    
+    /* (non-Javadoc)
+     * @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)
+    {
+        // retrieve ticket from request and current ticket
+        String ticket = req.getExtensionPath();
+        if (ticket == null && ticket.length() == 0)
+        {
+            throw new WebScriptException("Ticket not specified");
+        }
+        
+        try
+        {
+            String ticketUser = ticketComponent.validateTicket(ticket);
+
+            // do not go any further if tickets are different
+            if (!AuthenticationUtil.getCurrentUserName().equals(ticketUser))
+            {
+                // TODO: 404 error
+                throw new WebScriptException("Ticket not found");
+            }
+        }
+        catch(AuthenticationException e)
+        {
+            throw new WebScriptException("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;
+    }
+
+}