| <!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 Wed Mar 14 23:31:23 PDT 2012 --> | |
| <TITLE> | |
| AdaptorContext | |
| </TITLE> | |
| <META NAME="date" CONTENT="2012-03-14"> | |
| <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="AdaptorContext"; | |
| } | |
| } | |
| </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="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></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"> | |
| <A HREF="../adaptorlib/Adaptor.html" title="interface in adaptorlib"><B>PREV CLASS</B></A> | |
| <A HREF="../adaptorlib/AuthnIdentity.html" title="interface in adaptorlib"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../index.html?adaptorlib/AdaptorContext.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="AdaptorContext.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> | |
| <TR> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="skip-navbar_top"></A> | |
| <!-- ========= END OF TOP NAVBAR ========= --> | |
| <HR> | |
| <!-- ======== START OF CLASS DATA ======== --> | |
| <H2> | |
| <FONT SIZE="-1"> | |
| adaptorlib</FONT> | |
| <BR> | |
| Interface AdaptorContext</H2> | |
| <HR> | |
| <DL> | |
| <DT><PRE>public interface <B>AdaptorContext</B></DL> | |
| </PRE> | |
| <P> | |
| Methods for an Adaptor to communicate with the adaptor library. | |
| Implementations of this class must be thread-safe. | |
| <P> | |
| <P> | |
| <HR> | |
| <P> | |
| <!-- ========== METHOD SUMMARY =========== --> | |
| <A NAME="method_summary"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
| <B>Method Summary</B></FONT></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../adaptorlib/AdaptorContext.html#addStatusSource(adaptorlib.StatusSource)">addStatusSource</A></B>(<A HREF="../adaptorlib/StatusSource.html" title="interface in adaptorlib">StatusSource</A> source)</CODE> | |
| <BR> | |
| Add a status source to the dashboard.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../adaptorlib/Config.html" title="class in adaptorlib">Config</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../adaptorlib/AdaptorContext.html#getConfig()">getConfig</A></B>()</CODE> | |
| <BR> | |
| Configuration instance for the adaptor and all things within the adaptor | |
| library.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../adaptorlib/DocIdEncoder.html" title="interface in adaptorlib">DocIdEncoder</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../adaptorlib/AdaptorContext.html#getDocIdEncoder()">getDocIdEncoder</A></B>()</CODE> | |
| <BR> | |
| A way to construct URIs from DocIds.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../adaptorlib/DocIdPusher.html" title="interface in adaptorlib">DocIdPusher</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../adaptorlib/AdaptorContext.html#getDocIdPusher()">getDocIdPusher</A></B>()</CODE> | |
| <BR> | |
| Callback object for pushing <code>DocId</code>s to the GSA at any time.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../adaptorlib/GetDocIdsErrorHandler.html" title="interface in adaptorlib">GetDocIdsErrorHandler</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../adaptorlib/AdaptorContext.html#getGetDocIdsErrorHandler()">getGetDocIdsErrorHandler</A></B>()</CODE> | |
| <BR> | |
| Retrieve the current <A HREF="../adaptorlib/GetDocIdsErrorHandler.html" title="interface in adaptorlib"><CODE>GetDocIdsErrorHandler</CODE></A>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../adaptorlib/AdaptorContext.html#removeStatusSource(adaptorlib.StatusSource)">removeStatusSource</A></B>(<A HREF="../adaptorlib/StatusSource.html" title="interface in adaptorlib">StatusSource</A> source)</CODE> | |
| <BR> | |
| Remove a previously added status source to the dashboard.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../adaptorlib/AdaptorContext.html#setGetDocIdsErrorHandler(adaptorlib.GetDocIdsErrorHandler)">setGetDocIdsErrorHandler</A></B>(<A HREF="../adaptorlib/GetDocIdsErrorHandler.html" title="interface in adaptorlib">GetDocIdsErrorHandler</A> handler)</CODE> | |
| <BR> | |
| Override the default <A HREF="../adaptorlib/GetDocIdsErrorHandler.html" title="interface in adaptorlib"><CODE>GetDocIdsErrorHandler</CODE></A>.</TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <P> | |
| <!-- ============ METHOD DETAIL ========== --> | |
| <A NAME="method_detail"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
| <B>Method Detail</B></FONT></TH> | |
| </TR> | |
| </TABLE> | |
| <A NAME="getConfig()"><!-- --></A><H3> | |
| getConfig</H3> | |
| <PRE> | |
| <A HREF="../adaptorlib/Config.html" title="class in adaptorlib">Config</A> <B>getConfig</B>()</PRE> | |
| <DL> | |
| <DD>Configuration instance for the adaptor and all things within the adaptor | |
| library. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getDocIdPusher()"><!-- --></A><H3> | |
| getDocIdPusher</H3> | |
| <PRE> | |
| <A HREF="../adaptorlib/DocIdPusher.html" title="interface in adaptorlib">DocIdPusher</A> <B>getDocIdPusher</B>()</PRE> | |
| <DL> | |
| <DD>Callback object for pushing <code>DocId</code>s to the GSA at any time. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getDocIdEncoder()"><!-- --></A><H3> | |
| getDocIdEncoder</H3> | |
| <PRE> | |
| <A HREF="../adaptorlib/DocIdEncoder.html" title="interface in adaptorlib">DocIdEncoder</A> <B>getDocIdEncoder</B>()</PRE> | |
| <DL> | |
| <DD>A way to construct URIs from DocIds. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="addStatusSource(adaptorlib.StatusSource)"><!-- --></A><H3> | |
| addStatusSource</H3> | |
| <PRE> | |
| void <B>addStatusSource</B>(<A HREF="../adaptorlib/StatusSource.html" title="interface in adaptorlib">StatusSource</A> source)</PRE> | |
| <DL> | |
| <DD>Add a status source to the dashboard. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="removeStatusSource(adaptorlib.StatusSource)"><!-- --></A><H3> | |
| removeStatusSource</H3> | |
| <PRE> | |
| void <B>removeStatusSource</B>(<A HREF="../adaptorlib/StatusSource.html" title="interface in adaptorlib">StatusSource</A> source)</PRE> | |
| <DL> | |
| <DD>Remove a previously added status source to the dashboard. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setGetDocIdsErrorHandler(adaptorlib.GetDocIdsErrorHandler)"><!-- --></A><H3> | |
| setGetDocIdsErrorHandler</H3> | |
| <PRE> | |
| void <B>setGetDocIdsErrorHandler</B>(<A HREF="../adaptorlib/GetDocIdsErrorHandler.html" title="interface in adaptorlib">GetDocIdsErrorHandler</A> handler)</PRE> | |
| <DL> | |
| <DD>Override the default <A HREF="../adaptorlib/GetDocIdsErrorHandler.html" title="interface in adaptorlib"><CODE>GetDocIdsErrorHandler</CODE></A>. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getGetDocIdsErrorHandler()"><!-- --></A><H3> | |
| getGetDocIdsErrorHandler</H3> | |
| <PRE> | |
| <A HREF="../adaptorlib/GetDocIdsErrorHandler.html" title="interface in adaptorlib">GetDocIdsErrorHandler</A> <B>getGetDocIdsErrorHandler</B>()</PRE> | |
| <DL> | |
| <DD>Retrieve the current <A HREF="../adaptorlib/GetDocIdsErrorHandler.html" title="interface in adaptorlib"><CODE>GetDocIdsErrorHandler</CODE></A>. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <!-- ========= END OF CLASS DATA ========= --> | |
| <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="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></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"> | |
| <A HREF="../adaptorlib/Adaptor.html" title="interface in adaptorlib"><B>PREV CLASS</B></A> | |
| <A HREF="../adaptorlib/AuthnIdentity.html" title="interface in adaptorlib"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../index.html?adaptorlib/AdaptorContext.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="AdaptorContext.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> | |
| <TR> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="skip-navbar_bottom"></A> | |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> | |
| <HR> | |
| </BODY> | |
| </HTML> |