OpenSearch Impl

- addition of icons (for search engine, feed and feed entries)
- configurable items per page
- addition of feed entry relevance (score) (ATOM only)
- addition for generator & author feed elements (ATOM only)
- guest url argument support
- logging (log4j.logger.org.alfresco.web.api=DEBUG)
- addition of abstract web api plug-in (for building new url web services)

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@4668 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
David Caruana
2006-12-20 00:38:47 +00:00
parent d4df23ea30
commit 257568270d
11 changed files with 457 additions and 175 deletions

View File

@@ -17,13 +17,10 @@
package org.alfresco.web.api.services;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import org.alfresco.service.cmr.repository.TemplateService;
import org.alfresco.web.api.APIRequest;
import org.alfresco.web.api.APIResponse;
import org.alfresco.web.api.APIService;
import org.alfresco.web.api.APIRequest.HttpMethod;
import org.alfresco.web.api.APIRequest.RequiredAuthentication;
@@ -33,30 +30,8 @@ import org.alfresco.web.api.APIRequest.RequiredAuthentication;
*
* @author davidc
*/
public class TextSearchDescription implements APIService
public class TextSearchDescription extends APIServiceImpl
{
// dependencies
private String uri;
private TemplateService templateService;
/**
* Sets the Http URI
*
* @param uri
*/
public void setHttpUri(String uri)
{
this.uri = uri;
}
/**
* @param templateService
*/
public void setTemplateService(TemplateService templateService)
{
this.templateService = templateService;
}
/* (non-Javadoc)
* @see org.alfresco.web.api.APIService#getRequiredAuthentication()
@@ -74,37 +49,27 @@ public class TextSearchDescription implements APIService
return APIRequest.HttpMethod.GET;
}
/* (non-Javadoc)
* @see org.alfresco.web.api.APIService#getHttpUri()
*/
public String getHttpUri()
{
return this.uri;
}
/* (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
Map<String, Object> model = createTemplateModel(req, res);
res.setContentType(APIResponse.OPEN_SEARCH_DESCRIPTION_TYPE + ";charset=UTF-8");
templateService.processTemplateString(null, OPEN_SEARCH_DESCRIPTION, model, res.getWriter());
renderTemplate(OPEN_SEARCH_DESCRIPTION, model, res);
}
// 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" +
"<OpenSearchDescription xmlns=\"http://a9.com/-/spec/opensearch/1.1/\" xmlns:alf=\"http://www.alfresco.org\">\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" +
" <LongName>Alfresco ${agent.edition} Text Search ${agent.version}</LongName>\n" +
" <Description>Search Alfresco \"company home\" using text keywords</Description>\n" +
" <Url type=\"application/atom+xml\" template=\"${request.servicePath}/search/text?q={searchTerms}&amp;p={startPage?}&amp;c={count?}&amp;guest={alf:guest?}&amp;format=atom\"/>\n" +
" <Url type=\"text/html\" template=\"${request.servicePath}/search/text?q={searchTerms}&amp;p={startPage?}&amp;c={count?}&amp;guest={alf:guest?}\"/>\n" +
" <Image height=\"16\" width=\"16\" type=\"image/x-icon\">${request.path}/images/logo/AlfrescoLogo16.ico</Image>\n" +
"</OpenSearchDescription>";
}