Srikanth Technologies

Using Yahoo! Search Service

Yahoo!, just like many other websites, is allowing developers to access its content through Web Services. In this blog, I show you how to create a simple JSP page to access Yahoo's Search service.

Web services are broadly of two types - SOAP based and RESTful. Yahoo provides RESTful service for its search. Accessing any REST (Representational State Transfer) web service is as simple as constructing a URL and invoking it. I am using URL class of package to make a request to Yahoo's RESTful web service.

Search service returns an XML document (XML Schema) that contains Result elements. So, my program reads all Result elements and displays value of Title element using value of URL element as hyperlink.

To know more about how Yahoo Search service works, see Yahoo Web Search.

Steps to use Yahoo! Search Service

Take the following steps to use Yahoo's search service using Yahoo's demo application id - YahooDemo. You can as well obtain a unique application id for yourself. Obtain Application ID.
  1. Create a new web application using any IDE of your choice (I use NetBeans 6.0).
  2. Web container could be anything of your choice. I am using Tomcat.
  3. Create a .jsp file to take input from user using HTML form and search Yahoo's service for results.

    <%@page contentType="text/html"%>
    <%@page pageEncoding="UTF-8"%>
    <%@page import="*,,javax.xml.xpath.*,org.w3c.dom.*,org.xml.sax.InputSource,"%>
    <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
            <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
            <title>Yahoo Search</title>
        <h1>Yahoo Search</h1>
        <form action="index.jsp">
            Enter search string : <input type=text name=pattern value="${param.pattern}">
            <input type=submit value="Search"/>
         String pattern = request.getParameter("pattern");
         if ( pattern == null) return;
         String appid = "";
         // use URLEncoder to encode search pattern - it is required.
         String yrequest = "" +  URLEncoder.encode(pattern,"UTF-8") + "&results=5";
         try {
              URL url = new URL(yrequest);
              InputStream in = url.openStream();
              XPathFactory x = XPathFactory.newInstance();
              XPath path = x.newXPath();
              // take data that comes from service invocation
              InputSource source = new InputSource(in);
              NodeList nl = (NodeList) path.evaluate("//urn:yahoo:srch:Result", source, XPathConstants.NODESET);
              if ( nl.getLength() == 0 )
                     out.println("<h3>Sorry! No Match Found!</h3>");
                 for ( int i = 0 ; i < nl.getLength(); i ++) {	
                    Element e = (Element) nl.item(i);
                    out.println("<a href="  + e.getChildNodes().item(2).getTextContent() + ">" +
                                  e.getChildNodes().item(0).getTextContent() + "</a><p/>");
                 } // end of for
         catch (Exception e) {
             out.println("<h3>" + e.getMessage() + "</h3>");

Important Points About .JSP

So, that's all you have to do to access Yahoo's Search Service. I have used URL class to call the service and XPATH to process the XML document returned by service.