Initial checkpoint of OpenSearch support

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

source/java/org/alfresco/web/api/APIException.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * 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 org.alfresco.web.api;
+
+import org.alfresco.error.AlfrescoRuntimeException;
+
+/**
+ * API Service Exceptions.
+ * 
+ * @author David Caruana
+ */
+public class APIException extends AlfrescoRuntimeException
+{
+    private static final long serialVersionUID = -7338963365877285084L;
+
+    public APIException(String msgId)
+    {
+       super(msgId);
+    }
+    
+    public APIException(String msgId, Throwable cause)
+    {
+       super(msgId, cause);
+    }
+
+    public APIException(String msgId, Object ... args)
+    {
+        super(msgId, args);
+    }
+
+    public APIException(String msgId, Throwable cause, Object ... args)
+    {
+        super(msgId, args, cause);
+    }
+}

source/java/org/alfresco/web/api/APIRequest.java

@@ -0,0 +1,82 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * 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 org.alfresco.web.api;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletRequestWrapper;
+
+
+/**
+ * API Service Request
+ * 
+ * @author davidc
+ */
+public class APIRequest extends HttpServletRequestWrapper
+{
+
+    /**
+     * Enumerartion of HTTP Methods 
+     */
+    public enum HttpMethod
+    {
+        GET;
+        // TODO: Complete list...
+    }
+
+    
+    /**
+     * Construct
+     * 
+     * @param req
+     */
+    public APIRequest(HttpServletRequest req)
+    {
+        super(req);
+    }
+
+    /**
+     * Gets the HTTP Method
+     * 
+     * @return  Http Method
+     */
+    public HttpMethod getHttpMethod()
+    {
+        String method = getMethod().trim().toUpperCase();
+        return HttpMethod.valueOf(method);
+    }
+
+    /**
+     * Gets the Alfresco Context URL
+     *  
+     * @return  context url  e.g. http://localhost:port/alfresco
+     */
+    public String getPath()
+    {
+        return getScheme() + "://" + getServerName() + ":" + getServerPort() + getContextPath();
+    }
+
+    /**
+     * Gets the Alfresco Service URL
+     * 
+     * @return  service url  e.g. http://localhost:port/alfresco/service
+     */
+    public String getServicePath()
+    {
+        return getPath() + getServletPath();
+    }
+    
+}

source/java/org/alfresco/web/api/APIResponse.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * 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 org.alfresco.web.api;
+
+import javax.servlet.http.HttpServletResponse;
+import javax.servlet.http.HttpServletResponseWrapper;
+
+/**
+ * API Service Response
+ * 
+ * @author davidc
+ */
+public class APIResponse extends HttpServletResponseWrapper
+{
+
+    // Content Types
+    
+    public static final String HTML_TYPE = "text/html";    
+    public static final String OPEN_SEARCH_DESCRIPTION_TYPE = "application/opensearchdescription+xml";    
+    public static final String ATOM_TYPE = "application/atom+xml";    
+    
+    /**
+     * Construct
+     * 
+     * @param res
+     */
+    public APIResponse(HttpServletResponse res)
+    {
+        super(res);
+    }
+
+}

source/java/org/alfresco/web/api/APIService.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * 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 org.alfresco.web.api;
+
+import java.io.IOException;
+
+import javax.servlet.ServletContext;
+
+/**
+ * API Service
+ * 
+ * @author davidc
+ */
+public interface APIService
+{
+
+    /**
+     * Initialise service
+     * 
+     * @param context
+     */
+    public void init(ServletContext context);
+    
+
+    /**
+     * Execute service
+     * 
+     * @param req
+     * @param res
+     * @throws IOException
+     */
+    public void execute(APIRequest req, APIResponse res)
+        throws IOException;
+    
+}

source/java/org/alfresco/web/api/APIServlet.java

@@ -0,0 +1,109 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * 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 org.alfresco.web.api;
+
+import java.io.IOException;
+import java.util.regex.Pattern;
+
+import javax.servlet.ServletException;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import org.alfresco.web.app.servlet.BaseServlet;
+
+
+/**
+ * Entry point for web based services (REST style)
+ * 
+ * @author davidc
+ */
+public class APIServlet extends BaseServlet
+{
+    private static final long serialVersionUID = 4209892938069597860L;
+    
+    
+    // API Services
+    // TODO: Define via configuration
+    // TODO: Provide mechanism to construct service specific urls (ideally from template)
+    private static Pattern TEXT_SEARCH_DESCRIPTION_URI = Pattern.compile("/search/textsearchdescription.xml");
+    private static Pattern SEARCH_URI = Pattern.compile("/search/text");
+    private static APIService TEXT_SEARCH_DESCRIPTION_SERVICE;
+    private static APIService TEXT_SEARCH_SERVICE;
+    
+    
+    @Override
+    public void init() throws ServletException
+    {
+        super.init();
+        
+        // TODO: Replace with dispatch mechanism (maybe lazy construct)
+        TEXT_SEARCH_DESCRIPTION_SERVICE = new TextSearchDescriptionService();
+        TEXT_SEARCH_DESCRIPTION_SERVICE.init(getServletContext());
+        TEXT_SEARCH_SERVICE = new TextSearchService();
+        TEXT_SEARCH_SERVICE.init(getServletContext());
+    }
+
+
+// TODO:
+// - authentication
+// - atom
+//   - generator
+//   - author (authenticated)
+//   - icon
+// - html
+//   - icon
+              
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see javax.servlet.http.HttpServlet#service(javax.servlet.http.HttpServletRequest,
+     *      javax.servlet.http.HttpServletResponse)
+     */
+    protected void service(HttpServletRequest req, HttpServletResponse res) throws ServletException, IOException
+    {
+        APIRequest request = new APIRequest(req);
+        APIResponse response = new APIResponse(res);
+        
+        // TODO: Handle authentication - HTTP Auth?
+        
+
+        //
+        // Execute appropriate service
+        //
+        // TODO: Replace with configurable dispatch mechanism based on HTTP method & uri.
+        // TODO: Handle errors (with appropriate HTTP error responses) 
+
+        APIRequest.HttpMethod method = request.getHttpMethod();
+        String uri = request.getPathInfo();
+
+        if (method == APIRequest.HttpMethod.GET && TEXT_SEARCH_DESCRIPTION_URI.matcher(uri).matches())
+        {
+            TEXT_SEARCH_DESCRIPTION_SERVICE.execute(request, response);
+        }
+        else if (method == APIRequest.HttpMethod.GET && SEARCH_URI.matcher(uri).matches())
+        {
+            TEXT_SEARCH_SERVICE.execute(request, response);
+        }
+        else
+        {
+            response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
+        }
+        
+    }
+
+}

source/java/org/alfresco/web/api/TextSearchDescriptionService.java

@@ -0,0 +1,75 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * 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 org.alfresco.web.api;
+
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
+
+import javax.servlet.ServletContext;
+
+import org.alfresco.service.ServiceRegistry;
+import org.alfresco.service.cmr.repository.TemplateService;
+import org.springframework.context.ApplicationContext;
+import org.springframework.web.context.support.WebApplicationContextUtils;
+
+
+/**
+ * Provide OpenSearch Description for an Alfresco Text (simple) Search
+ *
+ * @author davidc
+ */
+public class TextSearchDescriptionService implements APIService
+{
+    // dependencies
+    private TemplateService templateService;
+    
+    /* (non-Javadoc)
+     * @see org.alfresco.web.api.APIService#init(javax.servlet.ServletContext)
+     */
+    public void init(ServletContext context)
+    {
+        ApplicationContext appContext = WebApplicationContextUtils.getWebApplicationContext(context);
+        templateService = (TemplateService)appContext.getBean(ServiceRegistry.TEMPLATE_SERVICE.getLocalName());
+    }
+
+    /* (non-Javadoc)
+     * @see org.alfresco.web.api.APIService#execute(org.alfresco.web.api.APIRequest, org.alfresco.web.api.APIResponse)
+     */
+    public void execute(APIRequest req, APIResponse res)
+        throws IOException
+    {
+        // create model for open search template
+        Map<String, Object> model = new HashMap<String, Object>(7, 1.0f);
+        model.put("request", req);
+
+        // execute template
+        res.setContentType(APIResponse.OPEN_SEARCH_DESCRIPTION_TYPE + ";charset=UTF-8");
+        templateService.processTemplateString(null, OPEN_SEARCH_DESCRIPTION, model, res.getWriter());
+    }
+
+    // TODO: place into accessible file
+    private final static String OPEN_SEARCH_DESCRIPTION = 
+        "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" +
+        "<OpenSearchDescription xmlns=\"http://a9.com/-/spec/opensearch/1.1/\">\n" +
+        "  <ShortName>Alfresco Text Search</ShortName>\n" +
+        "  <Description>Search all of Alfresco Company Home via text keywords</Description>\n" +
+        "  <Url type=\"application/atom+xml\" template=\"${request.servicePath}/search/text?q={searchTerms}&amp;p={startPage?}&amp;format=atom\"/>\n" +
+        "  <Url type=\"text/html\" template=\"${request.servicePath}/search/text?q={searchTerms}&amp;p={startPage?}\"/>\n" +
+        "</OpenSearchDescription>";
+        
+}

source/java/org/alfresco/web/api/TextSearchService.java

@@ -0,0 +1,439 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * 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 org.alfresco.web.api;
+
+import java.io.IOException;
+import java.io.PrintWriter;
+import java.io.StringWriter;
+import java.util.HashMap;
+import java.util.Map;
+
+import javax.servlet.ServletContext;
+
+import org.alfresco.service.ServiceRegistry;
+import org.alfresco.service.cmr.repository.StoreRef;
+import org.alfresco.service.cmr.repository.TemplateNode;
+import org.alfresco.service.cmr.repository.TemplateService;
+import org.alfresco.service.cmr.search.ResultSet;
+import org.alfresco.service.cmr.search.SearchService;
+import org.alfresco.util.ApplicationContextHelper;
+import org.alfresco.util.GUID;
+import org.springframework.context.ApplicationContext;
+import org.springframework.web.context.support.WebApplicationContextUtils;
+
+
+/**
+ * Alfresco Text (simple) Search Service
+ * 
+ * @author davidc
+ */
+public class TextSearchService implements APIService
+{
+    // NOTE: startPage and startIndex are 1 offset.
+
+    // search parameters 
+    // TODO: allow configuration of these
+    private static final StoreRef searchStore = new StoreRef(StoreRef.PROTOCOL_WORKSPACE, "SpacesStore");
+    private static final int itemsPerPage = 10;
+
+    // dependencies
+    private ServiceRegistry serviceRegistry;
+    private SearchService searchService;
+    private TemplateService templateService;
+
+    
+    
+    /* (non-Javadoc)
+     * @see org.alfresco.web.api.APIService#init(javax.servlet.ServletContext)
+     */
+    public void init(ServletContext context)
+    {
+        ApplicationContext appContext = WebApplicationContextUtils.getWebApplicationContext(context);
+        init(appContext);
+    }
+
+    /**
+     * Internal initialisation
+     * 
+     * @param context
+     */
+    private void init(ApplicationContext context)
+    {
+        serviceRegistry = (ServiceRegistry)context.getBean(ServiceRegistry.SERVICE_REGISTRY);
+        searchService = (SearchService)context.getBean(ServiceRegistry.SEARCH_SERVICE.getLocalName());
+        templateService = (TemplateService)context.getBean(ServiceRegistry.TEMPLATE_SERVICE.getLocalName());
+    }
+    
+    /* (non-Javadoc)
+     * @see org.alfresco.web.api.APIService#execute(org.alfresco.web.api.APIRequest, org.alfresco.web.api.APIResponse)
+     */
+    public void execute(APIRequest req, APIResponse res)
+        throws IOException
+    {
+        //
+        // execute the search
+        //
+        
+        String searchTerms = req.getParameter("q");
+        String startPageArg = req.getParameter("p");
+        int startPage = 1;
+        try
+        {
+            startPage = new Integer(startPageArg);
+        }
+        catch(NumberFormatException e)
+        {
+            // NOTE: use default startPage
+        }
+        
+        SearchResult results = search(searchTerms, startPage);
+        
+        //
+        // render the results
+        //
+        
+        String contentType = APIResponse.HTML_TYPE;
+        String template = HTML_TEMPLATE;
+
+        // TODO: data-drive this
+        String format = req.getParameter("format");
+        if (format != null)
+        {
+            if (format.equals("atom"))
+            {
+                contentType = APIResponse.ATOM_TYPE;
+                template = ATOM_TEMPLATE;
+            }
+        }
+        
+        // execute template
+        Map<String, Object> searchModel = new HashMap<String, Object>(7, 1.0f);
+        searchModel.put("request", req);
+        searchModel.put("search", results);
+        res.setContentType(contentType + ";charset=UTF-8");
+        templateService.processTemplateString(null, template, searchModel, res.getWriter());
+    }
+
+    /**
+     * Execute the search
+     * 
+     * @param searchTerms
+     * @param startPage
+     * @return
+     */
+    private SearchResult search(String searchTerms, int startPage)
+    {
+        SearchResult searchResult = null;
+        ResultSet results = null;
+        
+        try
+        {
+            // Construct search statement
+            String[] terms = searchTerms.split(" "); 
+            Map<String, Object> statementModel = new HashMap<String, Object>(7, 1.0f);
+            statementModel.put("terms", terms);
+            String query = templateService.processTemplateString(null, QUERY_STATEMENT, statementModel);
+            results = searchService.query(searchStore, SearchService.LANGUAGE_LUCENE, query);
+
+            int totalResults = results.length();
+            int totalPages = (totalResults / itemsPerPage);
+            totalPages += (totalResults % itemsPerPage != 0) ? 1 : 0;
+            
+            // are we out-of-range
+            if (totalPages != 0 && (startPage < 1 || startPage > totalPages))
+            {
+                throw new APIException("Start page " + startPage + " is outside boundary of " + totalPages + " pages");
+            }
+
+            searchResult = new SearchResult();
+            searchResult.setSearchTerms(searchTerms);
+            searchResult.setItemsPerPage(itemsPerPage);
+            searchResult.setStartPage(startPage);
+            searchResult.setTotalPages(totalPages);
+            searchResult.setTotalResults(totalResults);
+            searchResult.setStartIndex(((startPage -1) * itemsPerPage) + 1);
+            searchResult.setTotalPageItems(Math.min(itemsPerPage, totalResults - searchResult.getStartIndex() + 1));
+            TemplateNode[] nodes = new TemplateNode[searchResult.getTotalPageItems()];
+            for (int i = 0; i < searchResult.getTotalPageItems(); i++)
+            {
+                nodes[i] = new TemplateNode(results.getNodeRef(i + searchResult.getStartIndex() - 1), serviceRegistry, null);
+            }
+            searchResult.setResults(nodes);
+
+            return searchResult;
+        }
+        finally
+        {
+            if (results != null)
+            {
+                results.close();
+            }
+        }        
+    }
+
+    /**
+     * Search Result
+     *  
+     * @author davidc
+     */
+    public static class SearchResult
+    {
+        private String id;
+        private String searchTerms;
+        private int itemsPerPage;
+        private int totalPages;
+        private int totalResults;
+        private int totalPageItems;
+        private int startPage;
+        private int startIndex;
+        private TemplateNode[] results;
+        
+        
+        public int getItemsPerPage()
+        {
+            return itemsPerPage;
+        }
+        
+        /*package*/ void setItemsPerPage(int itemsPerPage)
+        {
+            this.itemsPerPage = itemsPerPage;
+        }
+
+        public TemplateNode[] getResults()
+        {
+            return results;
+        }
+
+        /*package*/ void setResults(TemplateNode[] results)
+        {
+            this.results = results;
+        }
+
+        public int getStartIndex()
+        {
+            return startIndex;
+        }
+
+        /*package*/ void setStartIndex(int startIndex)
+        {
+            this.startIndex = startIndex;
+        }
+
+        public int getStartPage()
+        {
+            return startPage;
+        }
+
+        /*package*/ void setStartPage(int startPage)
+        {
+            this.startPage = startPage;
+        }
+
+        public int getTotalPageItems()
+        {
+            return totalPageItems;
+        }
+
+        /*package*/ void setTotalPageItems(int totalPageItems)
+        {
+            this.totalPageItems = totalPageItems;
+        }
+
+        public int getTotalPages()
+        {
+            return totalPages;
+        }
+
+        /*package*/ void setTotalPages(int totalPages)
+        {
+            this.totalPages = totalPages;
+        }
+
+        public int getTotalResults()
+        {
+            return totalResults;
+        }
+
+        /*package*/ void setTotalResults(int totalResults)
+        {
+            this.totalResults = totalResults;
+        }
+
+        public String getSearchTerms()
+        {
+            return searchTerms;
+        }
+
+        /*package*/ void setSearchTerms(String searchTerms)
+        {
+            this.searchTerms = searchTerms;
+        }
+
+        public String getId()
+        {
+            if (id == null)
+            {
+                id = GUID.generate();
+            }
+            return id;
+        }
+    }
+    
+    
+    // TODO: place into accessible file
+    private final static String ATOM_TEMPLATE = 
+        "<#assign dateformat=\"yyyy-MM-dd\">" +
+        "<#assign timeformat=\"HH:mm:sszzz\">" +
+        "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" +
+        "<feed xmlns=\"http://www.w3.org/2005/Atom\" xmlns:opensearch=\"http://a9.com/-/spec/opensearch/1.1/\">\n" +
+        "  <title>Alfresco Search: ${search.searchTerms}</title>\n" + 
+        "  <updated>2003-12-13T18:30:02Z</updated>\n" +   // TODO:
+        "  <author>\n" + 
+        "    <name>Alfresco</name>\n" +   // TODO: Issuer of search?
+        "  </author>\n" + 
+        "  <id>urn:uuid:${search.id}</id>\n" +
+        "  <opensearch:totalResults>${search.totalResults}</opensearch:totalResults>\n" +
+        "  <opensearch:startIndex>${search.startIndex}</opensearch:startIndex>\n" +
+        "  <opensearch:itemsPerPage>${search.itemsPerPage}</opensearch:itemsPerPage>\n" +
+        "  <opensearch:Query role=\"request\" searchTerms=\"${search.searchTerms}\" startPage=\"${search.startPage}\"/>\n" +
+        "  <link rel=\"alternate\" href=\"${request.apiPath}/search/text?q=${search.searchTerms}&amp;p=${search.startPage}&amp;format=html\" type=\"text/html\"/>\n" +
+        "  <link rel=\"self\" href=\"${request.apiPath}/search/text?q=${search.searchTerms}&amp;p=${search.startPage}&amp;format=atom\" type=\"application/atom+xml\"/>\n" +
+        "  <link rel=\"first\" href=\"${request.apiPath}/search/text?q=${search.searchTerms}&amp;p=1&amp;format=atom\" type=\"application/atom+xml\"/>\n" +
+        "<#if search.startPage &gt; 1>" +
+        "  <link rel=\"previous\" href=\"${request.apiPath}/search/text?q=${search.searchTerms}&amp;p=${search.startPage - 1}&amp;format=atom\" type=\"application/atom+xml\"/>\n" +
+        "</#if>" +
+        "<#if search.startPage &lt; search.totalPages>" +
+        "  <link rel=\"next\" href=\"${request.apiPath}/search/text?q=${search.searchTerms}&amp;p=${search.startPage + 1}&amp;format=atom\" type=\"application/atom+xml\"/>\n" + 
+        "</#if>" +
+        "  <link rel=\"last\" href=\"${request.apiPath}/search/text?q=${search.searchTerms}&amp;p=${search.totalPages}&amp;format=atom\" type=\"application/atom+xml\"/>\n" +
+        "  <link rel=\"search\" type=\"application/opensearchdescription+xml\" href=\"${request.apiPath}/search/text/textsearchdescription.xml\"/>\n" +
+        "<#list search.results as row>" +            
+        "  <entry>\n" +
+        "    <title>${row.name}</title>\n" +
+        "    <link href=\"${request.path}/${row.url}\"/>\n" +
+        "    <id>urn:uuid:${row.id}</id>\n" +
+        "    <updated>${row.properties.modified?string(dateformat)}T${row.properties.modified?string(timeformat)}</updated>\n" +
+        "    <summary>${row.properties.description}</summary>\n" +
+        "  </entry>\n" +
+        "</#list>" +
+        "</feed>";        
+        
+    // TODO: place into accessible file
+    private final static String HTML_TEMPLATE =
+        "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" +
+        "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n" +
+        "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n" +
+        "  <head profile=\"http://a9.com/-/spec/opensearch/1.1/\">\n" + 
+        "    <title>Alfresco Text Search: ${search.searchTerms}</title>\n" + 
+        "    <link rel=\"search\" type=\"application/opensearchdescription+xml\" href=\"${request.apiPath}/search/text/textsearchdescription.xml\" title=\"Alfresco Text Search\"/>\n" +
+        "    <meta name=\"totalResults\" content=\"${search.totalResults}\"/>\n" +
+        "    <meta name=\"startIndex\" content=\"${search.startIndex}\"/>\n" +
+        "    <meta name=\"itemsPerPage\" content=\"${search.itemsPerPage}\"/>\n" +
+        "  </head>\n" +
+        "  <body>\n" +
+        "    <h2>Alfresco Text Search</h2>\n" +
+        "    Results <b>${search.startIndex}</b> - <b>${search.startIndex + search.totalPageItems - 1}</b> of <b>${search.totalResults}</b> for <b>${search.searchTerms}.</b>\n" +
+        "    <ul>\n" +
+        "<#list search.results as row>" +            
+        "      <li>\n" +
+        "        <a href=\"${request.path}/${row.url}\">\n" +
+        "           ${row.name}\n" +
+        "        </a>\n" +
+        "        <div>\n" +
+        "          ${row.properties.description}\n" +
+        "        </div>\n" +
+        "      </li>\n" +
+        "</#list>" +
+        "    </ul>\n" +
+        "    <a href=\"${request.apiPath}/search/text?q=${search.searchTerms}&p=1\">first</a>" +
+        "<#if search.startPage &gt; 1>" +
+        "    <a href=\"${request.apiPath}/search/text?q=${search.searchTerms}&p=${search.startPage - 1}\">previous</a>" +
+        "</#if>" +
+        "    <a href=\"${request.apiPath}/search/text?q=${search.searchTerms}&p=${search.startPage}\">${search.startPage}</a>" +
+        "<#if search.startPage &lt; search.totalPages>" +
+        "    <a href=\"${request.apiPath}/search/text?q=${search.searchTerms}&p=${search.startPage + 1}\">next</a>" +
+        "</#if>" +
+        "    <a href=\"${request.apiPath}/search/text?q=${search.searchTerms}&p=${search.totalPages}\">last</a>" +
+        "  </body>\n" +
+        "</html>\n";
+
+    // TODO: place into accessible file
+    private final static String QUERY_STATEMENT =  
+        "( " +
+        "  TYPE:\"{http://www.alfresco.org/model/content/1.0}content\" AND " +
+        "  (" +
+        "    (" +
+        "<#list 1..terms?size as i>" +
+        "      @\\{http\\://www.alfresco.org/model/content/1.0\\}name:${terms[i - 1]}" +
+        "<#if (i < terms?size)>" +
+        "      OR " +
+        "</#if>" +
+        "</#list>" +
+        "    ) " +
+        "    ( " +
+        "<#list 1..terms?size as i>" +
+        "      TEXT:${terms[i - 1]}" +
+        "<#if (i < terms?size)>" +
+        "      OR " +
+        "</#if>" +
+        "</#list>" +
+        "    )" +
+        "  )" +
+        ")";
+
+    
+    
+    /**
+     * Simple test that can be executed outside of web context
+     *  
+     * TODO: Move to test harness
+     *
+     * @param args
+     * @throws Exception
+     */
+    public static void main(String[] args)
+        throws Exception
+    {
+        ApplicationContext context = ApplicationContextHelper.getApplicationContext();
+        TextSearchService method = new TextSearchService();
+        method.init(context);
+        method.test();
+    }
+
+    /**
+     * Simple test that can be executed outside of web context
+     * 
+     * TODO: Move to test harness
+     */
+    private void test()
+    {
+        SearchResult result = search("alfresco tutorial", 1);
+
+        Map<String, Object> searchModel = new HashMap<String, Object>(7, 1.0f);
+        Map<String, Object> request = new HashMap<String, Object>();
+        request.put("apiPath", "http://localhost:8080/alfresco/service");
+        request.put("path", "http://localhost:8080/alfresco");
+        searchModel.put("request", request);
+        searchModel.put("search", result);
+        
+        StringWriter rendition = new StringWriter();
+        PrintWriter writer = new PrintWriter(rendition);
+        templateService.processTemplateString(null, HTML_TEMPLATE, searchModel, writer);
+        System.out.println(rendition.toString());
+    }
+
+}

source/web/WEB-INF/web.xml

@@ -230,6 +230,11 @@
       <load-on-startup>5</load-on-startup>
    </servlet>
       
+   <servlet>
+      <servlet-name>apiServlet</servlet-name>
+      <servlet-class>org.alfresco.web.api.APIServlet</servlet-class>
+   </servlet>
+            
    <servlet>
       <servlet-name>workflowDefinitionImageServlet</servlet-name>
       <servlet-class>org.alfresco.web.app.servlet.WorkflowDefinitionImageServlet</servlet-class>
@@ -239,7 +244,7 @@
       <servlet-name>JBPMDeployProcessServlet</servlet-name>
       <servlet-class>org.alfresco.web.app.servlet.JBPMDeployProcessServlet</servlet-class>
    </servlet>
-            
+
    <servlet-mapping>
       <servlet-name>Faces Servlet</servlet-name>
       <url-pattern>/faces/*</url-pattern>
@@ -300,6 +305,11 @@
 		<url-pattern>/webdav/*</url-pattern>
    </servlet-mapping>
 
+   <servlet-mapping>
+      <servlet-name>apiServlet</servlet-name>
+      <url-pattern>/service/*</url-pattern>
+   </servlet-mapping>
+
    <servlet-mapping>
       <servlet-name>JBPMDeployProcessServlet</servlet-name>
       <url-pattern>/jbpm/deployprocess</url-pattern>

source/web/services/index.html

@@ -0,0 +1,19 @@
+<html>
+  <head>
+    <title>Alfresco Web Services API (REST style)</title>
+    <link rel="search" type="application/opensearchdescription+xml" title="Alfresco Text Search" href="/alfresco/service/search/textsearchdescription.xml">
+  </head>
+
+  <body>
+    <h1>Alfresco Web Services API (REST style)</h2>
+
+    <a href="/alfresco/service/search/textsearchdescription.xml">Alfresco Text Search (OpenSearch description)</a>
+    <br>
+    <br>
+    <ul>
+      <li><a href="/alfresco/service/search/text?q=alfresco tutorial&format=atom">Search for 'alfresco tutorial' (ATOM response)</a></li>
+      <li><a href="/alfresco/service/search/text?q=alfresco tutorial">Search for 'alfresco tutorial' (HTML response)</a></li>
+    <ul>
+  </body>
+
+</html>