Open Search Servlet – build open search configuration on the fly

Here is open search specification – http://www.opensearch.org/Specifications/OpenSearch/1.1

Let’s enable your browser to detect your search engine automatically; using open search servlet you can generate open search configuration file on the fly.

Download information is here –

Binary library

Source maven project

Binary war file (includes example usages)

Usages:

1. Copy “open-search-x.jar” file on your WEB-INF/lib/ directory
2. Edit web.xml file.
3. add these entries -

< servlet >
    < servlet-name >openSearch< /servlet-name >
    < servlet-class >com.we4tech.openSearch.servlet.OpenSearchServlet< /servlet-class >
    < !-- URL matching pattern -- >
    < init-param >
      < param-name >url-match< /param-name >
      < param-value >.*/(.+).osd< /param-value >
      < !--< param-value >.*/search/(.+)< /param-value >-- >
    < /init-param >
    < !-- map open search configuration with url -- >
    < init-param >
      < param-name >open-search< /param-name >
      < param-value >open-search.properties< /param-value >
    < /init-param >
    < init-param >
      < param-name >somewherein-blog< /param-name >
      < param-value >somewherein-blog.properties< /param-value >
    < /init-param >
  < /servlet >

  < servlet-mapping >
    < servlet-name >openSearch< /servlet-name >
    < !--< url-pattern >/search/*< /url-pattern >-- >
    < url-pattern >*.osd< /url-pattern >
  < /servlet-mapping >

4. Now place configuration properties file with in your WEB-INF/classes/
5. for example: “open-search.properties”

# Default open-search. properties
shortName=colorful moment.
description=somewhere in blog
contact=hasan@somewherein.net

url.1=text/html,get,http://www.somewherein.net/blog/index.php?s={searchTerms}&submit=
image.1=16,16,image/x-icon,http://www.searchmash.com/favicon.ico

6. Congratulations you have completed all steps

Sample usages on your web site can be found here –

http://www.opensearch.org/Specifications/OpenSearch/1.1#Autodiscovery_in_HTML.2FXHTML

Best wishes,

Advertisement