IBM OmniFind Yahoo! Edition REST API を使う

                                
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.HttpException;
import org.apache.commons.httpclient.HttpMethod;
import org.apache.commons.httpclient.HttpStatus;
import org.apache.commons.httpclient.methods.GetMethod;

/**
 * This is a simple search example against the OmniFind default index.
 * 
 * Steps as following; (1)construct HttpClient so that we can issue HTTP GET
 * request later (2) construct search URL with the OmniFind search REST endpoint
 * and any necessary parameters such as index and query parameters (3) construct
 * GetMethod with the search URL (4) execute the GetMethod and check HTTP status
 * (5) retrieve the search result
 */
public class SimpleSearch {
  
  // omnifind the REST end point URL for OmniFind search
  final static String targetSearchAPIEndpointURL = "http://localhost/api/search";
  
  public static void main(String[] args) throws UnsupportedEncodingException {
    // query string command line parameter
    String queryString = args[0];
    
    // construct HttpClient so that we issue HTTP GET request
    HttpClient client = new HttpClient();
    
    // construct search URL with the OmniFind search REST endpoint
    // and any necessary parameters such as index and query
    StringBuffer url = new StringBuffer();
    url.append(targetSearchAPIEndpointURL);
    url.append("?index=Default&");
    url.append("query=" + java.net.URLEncoder.encode(queryString, "UTF-8"));
    
    // construct GetMethod with the search URL
    HttpMethod method = new GetMethod(url.toString());
    try {
      // execute the GetMethod and check http response
      String responseBody = null;
      int status = client.executeMethod(method);
      if (status != HttpStatus.SC_OK) {
        System.err.println("SimpleSearch failed: " + method.getStatusLine());
        System.exit(status);
      }
      // retrieve the search result. By default it is in Atom 1.0 format
      responseBody = method.getResponseBodyAsString();
      // write out the response body
      System.out.println(responseBody);
    } catch (HttpException e) {
      e.printStackTrace();
    } catch (IOException e) {
      e.printStackTrace();
    } finally {
      // clean up the connection resources
      method.releaseConnection();
    }
  }
}

                                <?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
        xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
        <title>Search results for query 'Axis' on index Default</title>
        <link
                href="http://localhost:8800/api/search?
                index=Default&amp;results=1&amp;query=Axis"
                rel="self" type="application/atom+xml" />
        <author>
                <name>IBM OmniFind Yahoo! Edition API Web Service</name>
        </author>
        <id>
                http://localhost:8800/api/search?index=Default&amp;
                results=1&amp;query=Axis
        </id>
        <category term="Default" label="Default" />
        <updated>2007-01-07T03:09:48Z</updated>
        <opensearch:totalResults>94</opensearch:totalResults>
        <opensearch:Query role="request" searchTerms="Axis" />
        <opensearch:startIndex>1</opensearch:startIndex>
        <opensearch:itemsPerPage>1</opensearch:itemsPerPage>
        <entry>
             <link
                href="http://www.javaworld.com/askTheExpert.jsp?
                pagename=http:%2F%2Fwww.javaworld.com%2Fjavaworld%2Fjw-02-2006%2F
                jw-0220-axis.html&amp;pagename=%2Fjavaworld%2Fjw-02-2006%2F
                jw-0220-axis.html&amp;pageurl=%2Fjavaworld%2Fjw-02-2006%2F
                jw-0220-axis.html&amp;pubsite=j"
                rel="alternate" type="text/html" 
                hreflang="en" />
             <link
                href="http://192.168.0.100:8800/search/?query=cache::http%3A%2F%2F
                www.javaworld.com%2FaskTheExpert.jsp%3Fpagename%3Dhttp%3A%252F%252F
                www.javaworld.com%252Fjavaworld%252Fjw-02-2006%252Fjw-0220-axis.html%26
                pagename%3D%252Fjavaworld%252Fjw-02-2006%252Fjw-0220-axis.html%26
                pageurl%3D%252Fjavaworld%252Fjw-02-2006%252F
                jw-0220-axis.html%26pubsite%3Dj&amp;output=binary"
                rel="via" type="text/html" 
                hreflang="en" />
             <opensearch:relevance>1.55</opensearch:relevance>
             <title type="html">Feedback Form</title>
             <updated>2007-01-06T14:56:04Z</updated>
             <id>
                http://www.javaworld.com/askTheExpert.jsp?pagename=http:%2F%2F
                www.javaworld.com%2Fjavaworld%2Fjw-02-2006%2F
                jw-0220-axis.html&amp;pagename=%2Fjavaworld%2Fjw-02-2006%2F
                jw-0220-axis.html&amp;pageurl=%2Fjavaworld%2Fjw-02-2006%2F
                jw-0220-axis.html&amp;pubsite=j
             </id>
             <summary type="html">
                &lt;SPAN class=&quot;ellipsis&quot;&gt;...
                &lt;/SPAN&gt;Feedback. Tell us your thoughts on this article
                or the issues raised in it. We&apos;ll cc: the author
                &lt;SPAN class=&quot;ellipsis&quot;&gt;
                ... &lt;/SPAN&gt;
             </summary>
       </entry>
</feed>

                                
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.util.Iterator;
import java.util.List;
import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.HttpException;
import org.apache.commons.httpclient.HttpMethod;
import org.apache.commons.httpclient.HttpStatus;
import org.apache.commons.httpclient.methods.GetMethod;
import com.sun.syndication.feed.synd.SyndEntry;
import com.sun.syndication.feed.synd.SyndFeed;
import com.sun.syndication.io.FeedException;
import com.sun.syndication.io.SyndFeedInput;
import com.sun.syndication.io.XmlReader;

/**
 * This is a simple search example against an OmniFind default index. For this
 * program, we are parsing the search results with ROME library to extract feed
 * entries.
 * 
 * Steps as following; (1)construct HttpClient so that we can issue HTTP GET
 * request later (2) construct search URL with the OmniFind search REST endpoint
 * and any necessary parameters such as index and query parameters (3) construct
 * GetMethod with the search URL (4) execute the GetMethod and check HTTP status
 * (5) retrieve the search result (6) convert the search result in ATOM to a
 * SyndFeed using ROME library (7) extract feed entries
 */
public class SimpleSearchWithParsing {
  
  // omnifind the REST end point URL for OmniFind search
  final static String targetSearchAPIEndpointURL = "http://localhost/api/search";
  
  public static void main(String[] args) throws UnsupportedEncodingException {
    // query string command line parameter
    String queryString = args[0];
    
    // construct HttpClient so that we issue HTTP GET request
    HttpClient client = new HttpClient();
    
    // construct search URL with the OmniFind search REST endpoint and any
    // necessary parameters such as index and query parameters
    StringBuffer url = new StringBuffer();
    url.append(targetSearchAPIEndpointURL);
    url.append("?index=Default&");
    url.append("results=1&");
    url.append("query=" + java.net.URLEncoder.encode(queryString, "UTF-8"));
    
    // construct GetMethod with the search REST end point URL
    HttpMethod method = new GetMethod(url.toString());
    try {
      // execute the GetMethod and check http status
      int status = client.executeMethod(method);
      if (status != HttpStatus.SC_OK) {
        System.err.println("SimpleSearchWithParsing failed: "
            + method.getStatusLine());
        System.exit(status);
      }
      
      // retrieve the search result
      // convert the search result in ATOM to a SyndFeed using ROME
      // library
      SyndFeedInput input = new SyndFeedInput();
      SyndFeed feed = input.build(new XmlReader(method
          .getResponseBodyAsStream()));
      
      // extract feed entries
      List list = feed.getEntries();
      for (Iterator iter = list.iterator(); iter.hasNext();) {
        SyndEntry entry = (SyndEntry) iter.next();
        System.out.println(entry.getLink());
      }
    } catch (HttpException e) {
      e.printStackTrace();
    } catch (IOException e) {
      e.printStackTrace();
    } catch (FeedException e) {
      e.printStackTrace();
    } finally {
      // clean up the connection resources
      method.releaseConnection();
    }
  }
}

                                <link rel="stylesheet" type="text/css" href="styles/nuvo.css">
   <style>
   body { 
  font-family: Verdana; 
  font-size: 12px; 
  background-repeat: no-repeat; 
  background-color: white; 
} 
.background { 
  background-repeat: no-repeat; 
} 
…
.resultFooterHtmlCachedLink { 
  font-family: Arial; 
  color: #8284cc; 
} 
.resultFooterOriginalCachedLink { 
  font-family: Arial; 
  color: #8284cc; 
} 
 
</style>
<div id=yschres>
    <div id=yschcont style="margin-left:0px;">
         <div id=yschpri style="margin-left:5px;">
            <div id=yschrel>
            </div>
            <div id=yschweb>
               <ol start=1>    
                     <li>            
                       <div>
                             <a class="yschttl" style="
                             font-family: Arial; color: #0000de; " 
                             href="http://www.javaworld.com/
                             askTheExpert.jsp?pagename=http:%2F%2F
                             www.javaworld.com%2F
                             javaworld%2Fjw-02-2006%2F
                             jw-0220-axis.html&amp;pagename=%2F
                             javaworld%2Fjw-02-2006%2F
                             jw-0220-axis.html&amp;pageurl=%2F
                             javaworld%2F
                             jw-02-2006%2Fjw-0220-axis.html&amp;pubsite=j">
                             Feedback Form</a>
                             </div>
                       <div class=yschabstr style="font-family: Arial; 
                            color: black; ">               
                             <SPAN class="ellipsis">... </SPAN>
                             Feedback.  Tell us your thoughts on this article or 
                             the issues raised in it. We'll cc: the 
                             author <SPAN class="
                             ellipsis">... </SPAN></div>
                       <em class=yschurl  style="font-family: 
                       Arial; color: #088000; " >
                          http://www.javaworld.com/askTheExpert.jsp?pagename=http:%2F%2F
                          www.javaworld.com%2Fjavaworld%2Fjw-02-2006%2F
                          jw-0220-<SPAN class="
                          highlight"><SPAN class="
                          hlTerm0">axis</SPAN></SPAN>.html&amp;
                          pagename=%2Fjavaworld%2Fjw-02-2006%2Fjw-0220-<SPAN class="
                          highlight"><SPAN class="
                          hlTerm0">axis</SPAN></SPAN>.html&amp;
                          pageurl=%2Fjavaworld%2Fjw-02-2006%2Fjw-0220-<SPAN 
                          class="highlight"><SPAN class="
                          hlTerm0">axis</SPAN></SPAN>.html&amp;
                          pubsite=j </em> 
                              - 
                 </ol>   
             </div>   
         </div>
      </div>
   </div>

                                
import java.io.File;
import java.io.IOException;
import org.apache.commons.httpclient.Header;
import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.HttpException;
import org.apache.commons.httpclient.HttpStatus;
import org.apache.commons.httpclient.UsernamePasswordCredentials;
import org.apache.commons.httpclient.auth.AuthScope;
import org.apache.commons.httpclient.methods.FileRequestEntity;
import org.apache.commons.httpclient.methods.PostMethod;
import org.apache.commons.httpclient.methods.RequestEntity;

/**
 * This is a document push example.
 * 
 * Steps as following; (1)construct HttpClient so that we can issue HTTP POST
 * request later (2) set the credential using OmniFind API password (2)
 * construct a PostMethod and set necessary request headers (4) set the request
 * entity with the file content to be indexed (5) execute the PostMethod and
 * check HTTP status (6) check an error
 */
public class PushPDFDocument {
  
  // omnifind the REST end point URL for document push
  final static String targetDocumentAPIEndpointURL = "http://localhost/api/document";
  
  public static void main(String[] args) {
    
    // construct HttpClient so that we issue HTTP POST request
    HttpClient client = new HttpClient();
    
    // set the credential using OmniFind API password
    client.getState().setCredentials(new AuthScope("localhost", 80),
        new UsernamePasswordCredentials("notused", "+UrSlFg="));
    
    // construct a PostMethod and set necessary request headers
    PostMethod method = new PostMethod(targetDocumentAPIEndpointURL);
    method.setDoAuthentication(true);
    method.setRequestHeader("action", "addDocument");
    method.setRequestHeader("index", "Default");
    method.setRequestHeader("docId", "pdfrepository://oye_api_guide_v84.pdf");
    method.setRequestHeader("docType", "application/pdf");
    
    try {
      // set the request entity with the file content to be indexed
      File input = new File("oye_api_guide_v84.pdf");
      RequestEntity entity = new FileRequestEntity(input, "application/pdf");
      method.setRequestEntity(entity);
      
      // execute the post method and check HTTP status
      int status = client.executeMethod(method);
      if (status != HttpStatus.SC_OK) {
        System.err.println("PushPDFDocument failed: " + method.getStatusLine());
        System.exit(status);
      }
      
      // Note on the response from a document API call. The HTTP response
      // code is always 200, with the exception of 401 for failed
      // authentication. If an error occurs during the document insert
      // process, the HTTP response code is still 200 and the HTTP
      // response header contains a parameter of "hasError". 
      // Therefore, to do the proper handling of the document push result,
      // you must check for the existence of the "hasError" response
      // header or the HTTP 401 response code.
      Header hasErrorHeader = method.getResponseHeader("hasError");
      if (hasErrorHeader == null) {
        System.out.println("document pushed fine.");
      } else {
        String errorResponse = method.getResponseBodyAsString();
        System.out.println("error response: " + errorResponse);
      }
    } catch (HttpException e) {
      e.printStackTrace();
    } catch (IOException e) {
      e.printStackTrace();
    } finally {
      // clean up the connection resources
      method.releaseConnection();
    }
  }
}

                                
import java.io.IOException;
import org.apache.commons.httpclient.Header;
import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.HttpException;
import org.apache.commons.httpclient.HttpStatus;
import org.apache.commons.httpclient.UsernamePasswordCredentials;
import org.apache.commons.httpclient.auth.AuthScope;
import org.apache.commons.httpclient.methods.DeleteMethod;

/**
 * This is a document delete example.
 * 
 * Steps as following; (1)construct HttpClient so that we can issue HTTP DELETE
 * request later (2) set the credential using OmniFind API password (2)
 * construct a DeleteMethod and set necessary request headers (4) execute the
 * DeleteMethod and check HTTP status (5) check an error
 */

public class DeletePDFDocument {
  
  // omnifind the REST end point URL for document push
  final static String targetDocumentAPIEndpointURL = "http://localhost/api/document";
  
  public static void main(String[] args) throws HttpException, IOException {
    
    // construct HttpClient so that we issue HTTP POST request
    HttpClient client = new HttpClient();
    
    // set the credential using OmniFind API password
    client.getState().setCredentials(new AuthScope("localhost", 80),
        new UsernamePasswordCredentials("notused", "+UrSlFg="));
    
    // construct a DeleteMethod and set necessary request headers
    DeleteMethod method = new DeleteMethod(targetDocumentAPIEndpointURL);
    method.setDoAuthentication(true);
    method.setRequestHeader("action", "deleteDocument");
    method.setRequestHeader("index", "Default");
    // the docId of the document to be deleted
    method.setRequestHeader("docId", "pdfrepository://oye_api_guide_v84.pdf");
    
    try {
      // execute the delete method
      int status = client.executeMethod(method);
      if (status != HttpStatus.SC_OK) {
        System.err.println("DeletePDFDocument failed: "
            + method.getStatusLine());
        System.exit(status);
      }
      
      // Note on the response from a document API call. The HTTP response
      // code is always 200, with the exception of 401 for failed
      // authentication. If an error occurs during the document insert
      // process, the HTTP response code is still 200 and the HTTP
      // response header contains a parameter of "hasError". 
      // Therefore, to do the proper handling of the document push result, 
      // you must check for the existence of the "hasError" response 
      // header or the HTTP 401 response code.
      Header hasErrorHeader = method.getResponseHeader("hasError");
      if (hasErrorHeader == null) {
        System.out.println("document deleted.");
      } else {
        String errorResponse = method.getResponseBodyAsString();
        System.out.println("error response: " + errorResponse);
      }
    } finally {
      // clean up the connection resources
      method.releaseConnection();
    }
  }
}