| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_20) on Fri Mar 16 16:00:29 PDT 2012 --> |
| <TITLE> |
| adaptorlib |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2012-03-16"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="adaptorlib"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| PREV PACKAGE |
| <A HREF="../adaptorlib/examples/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../index.html?adaptorlib/package-summary.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <H2> |
| Package adaptorlib |
| </H2> |
| Adaptor interfaces and implementation. |
| <P> |
| <B>See:</B> |
| <BR> |
| <A HREF="#package_description"><B>Description</B></A> |
| <P> |
| |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Interface Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/Acl.BatchRetriever.html" title="interface in adaptorlib">Acl.BatchRetriever</A></B></TD> |
| <TD>Batch retrieval of ACLs for efficent processing of many authz checks at |
| once.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/Adaptor.html" title="interface in adaptorlib">Adaptor</A></B></TD> |
| <TD>Interface for user-specific implementation details of an Adaptor.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/AdaptorContext.html" title="interface in adaptorlib">AdaptorContext</A></B></TD> |
| <TD>Methods for an Adaptor to communicate with the adaptor library.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/AuthnIdentity.html" title="interface in adaptorlib">AuthnIdentity</A></B></TD> |
| <TD>User identification information for understanding who a user is or if they |
| are allowed to access a resource.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/ConfigModificationListener.html" title="interface in adaptorlib">ConfigModificationListener</A></B></TD> |
| <TD>Listener for configuration modification events.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/DocIdEncoder.html" title="interface in adaptorlib">DocIdEncoder</A></B></TD> |
| <TD>Allows generating a URI for a particular DocId.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/DocIdPusher.html" title="interface in adaptorlib">DocIdPusher</A></B></TD> |
| <TD>Interface that allows at-will pushing of <code>DocId</code>s to the GSA.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/DocumentTransform.html" title="interface in adaptorlib">DocumentTransform</A></B></TD> |
| <TD>Represents an individual transform in the transform pipeline.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/GetDocIdsErrorHandler.html" title="interface in adaptorlib">GetDocIdsErrorHandler</A></B></TD> |
| <TD>Interface for handling error encountered during scheduled pushing of <code>DocId</code>s.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/PollingIncrementalAdaptor.html" title="interface in adaptorlib">PollingIncrementalAdaptor</A></B></TD> |
| <TD>Interface for library-assisted polling incremental adaptors.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/PushErrorHandler.html" title="interface in adaptorlib">PushErrorHandler</A></B></TD> |
| <TD>Interface for handling errors encountered during pushing of <code>DocId</code>s |
| via <A HREF="../adaptorlib/DocIdPusher.html" title="interface in adaptorlib"><CODE>DocIdPusher</CODE></A>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/Request.html" title="interface in adaptorlib">Request</A></B></TD> |
| <TD>Interface provided to <A HREF="../adaptorlib/Adaptor.html#getDocContent(adaptorlib.Request, adaptorlib.Response)"><CODE>Adaptor.getDocContent(adaptorlib.Request, adaptorlib.Response)</CODE></A> for describing the action |
| that should be taken.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/Response.html" title="interface in adaptorlib">Response</A></B></TD> |
| <TD>Interface provided to <A HREF="../adaptorlib/Adaptor.html#getDocContent(adaptorlib.Request, adaptorlib.Response)"><CODE>Adaptor.getDocContent(adaptorlib.Request, adaptorlib.Response)</CODE></A> for performing the |
| actions needed to satisfy a request.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/Status.html" title="interface in adaptorlib">Status</A></B></TD> |
| <TD>Multi-state indicator providing the user with a notification of broken parts |
| of the system.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/StatusSource.html" title="interface in adaptorlib">StatusSource</A></B></TD> |
| <TD>A source of <A HREF="../adaptorlib/Status.html" title="interface in adaptorlib"><CODE>Status</CODE></A> messages.</TD> |
| </TR> |
| </TABLE> |
| |
| |
| <P> |
| |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Class Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/AbstractAdaptor.html" title="class in adaptorlib">AbstractAdaptor</A></B></TD> |
| <TD>Provides a reasonable default implementation for most <A HREF="../adaptorlib/Adaptor.html" title="interface in adaptorlib"><CODE>Adaptor</CODE></A> |
| methods.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/AbstractDocumentTransform.html" title="class in adaptorlib">AbstractDocumentTransform</A></B></TD> |
| <TD>Convenience class for implementing <code>DocumentTransform</code>s.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/Acl.html" title="class in adaptorlib">Acl</A></B></TD> |
| <TD>Immutable access control list.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/Acl.Builder.html" title="class in adaptorlib">Acl.Builder</A></B></TD> |
| <TD>Mutable ACL for creating instances of <A HREF="../adaptorlib/Acl.html" title="class in adaptorlib"><CODE>Acl</CODE></A>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/CommandStreamParser.html" title="class in adaptorlib">CommandStreamParser</A></B></TD> |
| <TD>Parses the adaptor data format into individual commands with associated data.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/CommandStreamParser.RetrieverInfo.html" title="class in adaptorlib">CommandStreamParser.RetrieverInfo</A></B></TD> |
| <TD> </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/Config.html" title="class in adaptorlib">Config</A></B></TD> |
| <TD>Configuration values for this program like the GSA's hostname.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/ConfigModificationEvent.html" title="class in adaptorlib">ConfigModificationEvent</A></B></TD> |
| <TD>Represents configuration modification event information.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/CustomFormatter.html" title="class in adaptorlib">CustomFormatter</A></B></TD> |
| <TD>Custom log formatter for ease of development.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/DefaultGetDocIdsErrorHandler.html" title="class in adaptorlib">DefaultGetDocIdsErrorHandler</A></B></TD> |
| <TD>Default handler of errors during <A HREF="../adaptorlib/Adaptor.html#getDocIds(adaptorlib.DocIdPusher)"><CODE>Adaptor.getDocIds(adaptorlib.DocIdPusher)</CODE></A>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/DefaultPushErrorHandler.html" title="class in adaptorlib">DefaultPushErrorHandler</A></B></TD> |
| <TD>Default handler of errors during a push of <code>DocId</code>s to the GSA.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/DocId.html" title="class in adaptorlib">DocId</A></B></TD> |
| <TD>DocId refers to a unique document in repository.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/DocIdPusher.Record.html" title="class in adaptorlib">DocIdPusher.Record</A></B></TD> |
| <TD>Contains DocId and other feed file record attributes.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/DocIdPusher.Record.Builder.html" title="class in adaptorlib">DocIdPusher.Record.Builder</A></B></TD> |
| <TD>Used to create instances of Record, which are immutable.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/GsaCommunicationHandler.html" title="class in adaptorlib">GsaCommunicationHandler</A></B></TD> |
| <TD>This class handles the communications with GSA.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/IOHelper.html" title="class in adaptorlib">IOHelper</A></B></TD> |
| <TD>Utility class for providing useful methods when handling streams or other |
| forms of I/O.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/TransformPipeline.html" title="class in adaptorlib">TransformPipeline</A></B></TD> |
| <TD>Modify content and metadata using multiple serial transforms.</TD> |
| </TR> |
| </TABLE> |
| |
| |
| <P> |
| |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Enum Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/Acl.InheritanceType.html" title="enum in adaptorlib">Acl.InheritanceType</A></B></TD> |
| <TD>The rule for combining a parent's authz response with its child's.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/AuthzStatus.html" title="enum in adaptorlib">AuthzStatus</A></B></TD> |
| <TD>Authorization Status codes.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/Status.Code.html" title="enum in adaptorlib">Status.Code</A></B></TD> |
| <TD>Available statuses for displaying state indicators on the dashboard.</TD> |
| </TR> |
| </TABLE> |
| |
| |
| <P> |
| |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Exception Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../adaptorlib/TransformException.html" title="class in adaptorlib">TransformException</A></B></TD> |
| <TD> </TD> |
| </TR> |
| </TABLE> |
| |
| |
| <P> |
| <A NAME="package_description"><!-- --></A><H2> |
| Package adaptorlib Description |
| </H2> |
| |
| <P> |
| Adaptor interfaces and implementation. Uses combination of a |
| document feed and an accompanying HTTP server. |
| <p> |
| Feed files, with lists of ids encoded as URLs, are pushed to GSA. |
| <p> |
| GSA crawls by making requests for file contents. |
| <P> |
| |
| <P> |
| <DL> |
| </DL> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| PREV PACKAGE |
| <A HREF="../adaptorlib/examples/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../index.html?adaptorlib/package-summary.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
