#summary Steps to get started using Adaptors.

<wiki:toc max_depth="2" />

= Introduction =

The Plexi Project is a library used to develop custom adaptors for both public and secure repositories.  A Plexi adaptor provides documents to the Google Search Appliance (GSA). This document helps you setup a development environment with the source code of this library.


= Setup Command Line Development Environment =

You will need a JDK 1.6u27 or higher, Ant, and Git to begin making use of the code.  You can get a copy of this library by using this command:
{{{
git clone https://code.google.com/p/plexi/
}}}

The !JavaDoc-based documentation has additional steps to get running: http://wiki.plexi.googlecode.com/git/plexi-javadoc/index.html .  You can generate your own local copy of this documentation by running "ant javadoc" in the plexi directory and then opening "build/javadoc/index.html" in your browser.

Using JRE or JDK 1.6u27 or higher is very important, because there is a [http://bugs.sun.com/view_bug.do?bug_id=6946825 bad memory leak] in 1.6u16 and prior. When only using HTTP the leak isn't severe, but when using HTTPS the leak becomes very apparent.


= Setup !NetBeans Development Environment =

To setup using !NetBeans IDE please follow this visually annotated guide: http://wiki.plexi.googlecode.com/git/plexi-netbeans/nb.html


= Source Files of Example Adaptors =

To help get started understanding Plexi view our example adaptor sources: http://code.google.com/p/plexi/source/browse/#git%2Fsrc%2Fadaptorlib%2Fexamples