source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/handler/PingRequestHandler.html @ 7588

Revision 7588, 35.6 KB checked in by adir, 11 years ago (diff)

Ticket #000 - Adicionando a integracao de buscas com Solr na base a ser isnerida na comunidade

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0_24) on Mon Jun 25 15:26:24 EDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7<TITLE>
8PingRequestHandler (Solr 4.0.0-ALPHA API)
9</TITLE>
10
11<META NAME="date" CONTENT="2012-06-25">
12
13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
14
15<SCRIPT type="text/javascript">
16function windowTitle()
17{
18    if (location.href.indexOf('is-external=true') == -1) {
19        parent.document.title="PingRequestHandler (Solr 4.0.0-ALPHA API)";
20    }
21}
22</SCRIPT>
23<NOSCRIPT>
24</NOSCRIPT>
25
26</HEAD>
27
28<BODY BGCOLOR="white" onload="windowTitle();">
29<HR>
30
31
32<!-- ========= START OF TOP NAVBAR ======= -->
33<A NAME="navbar_top"><!-- --></A>
34<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
36<TR>
37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
38<A NAME="navbar_top_firstrow"><!-- --></A>
39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
40  <TR ALIGN="center" VALIGN="top">
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
43  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/PingRequestHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
48  </TR>
49</TABLE>
50</TD>
51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
52</EM>
53</TD>
54</TR>
55
56<TR>
57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58&nbsp;<A HREF="../../../../org/apache/solr/handler/MoreLikeThisHandler.MoreLikeThisHelper.html" title="class in org.apache.solr.handler"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/solr/handler/PingRequestHandler.ACTIONS.html" title="enum in org.apache.solr.handler"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../index.html?org/apache/solr/handler/PingRequestHandler.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="PingRequestHandler.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
63&nbsp;<SCRIPT type="text/javascript">
64  <!--
65  if(window==top) {
66    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
67  }
68  //-->
69</SCRIPT>
70<NOSCRIPT>
71  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
72</NOSCRIPT>
73
74
75</FONT></TD>
76</TR>
77<TR>
78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
82</TR>
83</TABLE>
84<A NAME="skip-navbar_top"></A>
85<!-- ========= END OF TOP NAVBAR ========= -->
86
87<HR>
88<!-- ======== START OF CLASS DATA ======== -->
89<H2>
90<FONT SIZE="-1">
91org.apache.solr.handler</FONT>
92<BR>
93Class PingRequestHandler</H2>
94<PRE>
95<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
96  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html" title="class in org.apache.solr.handler">org.apache.solr.handler.RequestHandlerBase</A>
97      <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.handler.PingRequestHandler</B>
98</PRE>
99<DL>
100<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A>, <A HREF="../../../../org/apache/solr/request/SolrRequestHandler.html" title="interface in org.apache.solr.request">SolrRequestHandler</A>, <A HREF="../../../../org/apache/solr/util/plugin/SolrCoreAware.html" title="interface in org.apache.solr.util.plugin">SolrCoreAware</A></DD>
101</DL>
102<HR>
103<DL>
104<DT><PRE>public class <B>PingRequestHandler</B><DT>extends <A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html" title="class in org.apache.solr.handler">RequestHandlerBase</A><DT>implements <A HREF="../../../../org/apache/solr/util/plugin/SolrCoreAware.html" title="interface in org.apache.solr.util.plugin">SolrCoreAware</A></DL>
105</PRE>
106
107<P>
108Ping Request Handler for reporting SolrCore health to a Load Balancer.
109
110 <p>
111 This handler is designed to be used as the endpoint for an HTTP
112 Load-Balancer to use when checking the "health" or "up status" of a
113 Solr server.
114 </p>
115 
116 <p>
117 In it's simplest form, the PingRequestHandler should be
118 configured with some defaults indicating a request that should be
119 executed.  If the request succeeds, then the PingRequestHandler
120 will respond back with a simple "OK" status.  If the request fails,
121 then the PingRequestHandler will respond back with the
122 corrisponding HTTP Error code.  Clients (such as load balancers)
123 can be configured to poll the PingRequestHandler monitoring for
124 these types of responses (or for a simple connection failure) to
125 know if there is a problem with the Solr server.
126 </p>
127
128 <pre class="prettyprint">
129 &lt;requestHandler name="/admin/ping" class="solr.PingRequestHandler"&gt;
130   &lt;lst name="invariants"&gt;
131     &lt;str name="qt"&gt;/search&lt;/str&gt;&lt;!-- handler to delegate to --&gt;
132     &lt;str name="q"&gt;some test query&lt;/str&gt;
133   &lt;/lst&gt;
134 &lt;/requestHandler&gt;
135 </pre>
136
137 <p>
138 A more advanced option available, is to configure the handler with a
139 "healthcheckFile" which can be used to enable/disable the PingRequestHandler.
140 </p>
141
142 <pre class="prettyprint">
143 &lt;requestHandler name="/admin/ping" class="solr.PingRequestHandler"&gt;
144   &lt;!-- relative paths are resolved against the data dir --&gt;
145   &lt;str name="healthcheckFile"&gt;server-enabled.txt&lt;/str&gt;
146   &lt;lst name="invariants"&gt;
147     &lt;str name="qt"&gt;/search&lt;/str&gt;&lt;!-- handler to delegate to --&gt;
148     &lt;str name="q"&gt;some test query&lt;/str&gt;
149   &lt;/lst&gt;
150 &lt;/requestHandler&gt;
151 </pre>
152
153 <ul>
154   <li>If the health check file exists, the handler will execute the
155       delegated query and return status as described above.
156   </li>
157   <li>If the health check file does not exist, the handler will return
158       an HTTP error even if the server is working fine and the delegated
159       query would have succeeded
160   </li>
161 </ul>
162
163 <p>
164 This health check file feature can be used as a way to indicate
165 to some Load Balancers that the server should be "removed from
166 rotation" for maintenance, or upgrades, or whatever reason you may
167 wish. 
168 </p>
169
170 <p>
171 The health check file may be created/deleted by any external
172 system, or the PingRequestHandler itself can be used to
173 create/delete the file by specifying an "action" param in a
174 request:
175 </p>
176
177 <ul>
178   <li><code>http://.../ping?action=enable</code>
179       - creates the health check file if it does not already exist
180   </li>
181   <li><code>http://.../ping?action=disable</code>
182       - deletes the health check file if it exists
183   </li>
184   <li><code>http://.../ping?action=status</code>
185       - returns a status code indicating if the healthcheck file exists
186       ("<code>enabled</code>") or not ("<code>disabled<code>")
187   </li>
188 </ul>
189<P>
190
191<P>
192<DL>
193<DT><B>Since:</B></DT>
194  <DD>solr 1.3</DD>
195</DL>
196<HR>
197
198<P>
199<!-- ======== NESTED CLASS SUMMARY ======== -->
200
201<A NAME="nested_class_summary"><!-- --></A>
202<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
203<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
204<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
205<B>Nested Class Summary</B></FONT></TH>
206</TR>
207<TR BGCOLOR="white" CLASS="TableRowColor">
208<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
209<CODE>protected static&nbsp;class</CODE></FONT></TD>
210<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/PingRequestHandler.ACTIONS.html" title="enum in org.apache.solr.handler">PingRequestHandler.ACTIONS</A></B></CODE>
211
212<BR>
213&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
214</TR>
215</TABLE>
216&nbsp;<A NAME="nested_classes_inherited_from_class_org.apache.solr.core.SolrInfoMBean"><!-- --></A>
217<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
218<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
219<TH ALIGN="left"><B>Nested classes/interfaces inherited from interface org.apache.solr.core.<A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></B></TH>
220</TR>
221<TR BGCOLOR="white" CLASS="TableRowColor">
222<TD><CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.Category.html" title="enum in org.apache.solr.core">SolrInfoMBean.Category</A></CODE></TD>
223</TR>
224</TABLE>
225&nbsp;
226<!-- =========== FIELD SUMMARY =========== -->
227
228<A NAME="field_summary"><!-- --></A>
229<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
230<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
231<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
232<B>Field Summary</B></FONT></TH>
233</TR>
234<TR BGCOLOR="white" CLASS="TableRowColor">
235<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
236<CODE>static&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
237<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/PingRequestHandler.html#HEALTHCHECK_FILE_PARAM">HEALTHCHECK_FILE_PARAM</A></B></CODE>
238
239<BR>
240&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
241</TR>
242<TR BGCOLOR="white" CLASS="TableRowColor">
243<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
244<CODE>static&nbsp;org.slf4j.Logger</CODE></FONT></TD>
245<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/PingRequestHandler.html#log">log</A></B></CODE>
246
247<BR>
248&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
249</TR>
250</TABLE>
251&nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.handler.RequestHandlerBase"><!-- --></A>
252<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
253<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
254<TH ALIGN="left"><B>Fields inherited from class org.apache.solr.handler.<A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html" title="class in org.apache.solr.handler">RequestHandlerBase</A></B></TH>
255</TR>
256<TR BGCOLOR="white" CLASS="TableRowColor">
257<TD><CODE><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#appends">appends</A>, <A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#defaults">defaults</A>, <A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#httpCaching">httpCaching</A>, <A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#initArgs">initArgs</A>, <A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#invariants">invariants</A></CODE></TD>
258</TR>
259</TABLE>
260&nbsp;
261<!-- ======== CONSTRUCTOR SUMMARY ======== -->
262
263<A NAME="constructor_summary"><!-- --></A>
264<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
265<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
266<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
267<B>Constructor Summary</B></FONT></TH>
268</TR>
269<TR BGCOLOR="white" CLASS="TableRowColor">
270<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/PingRequestHandler.html#PingRequestHandler()">PingRequestHandler</A></B>()</CODE>
271
272<BR>
273&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
274</TR>
275</TABLE>
276&nbsp;
277<!-- ========== METHOD SUMMARY =========== -->
278
279<A NAME="method_summary"><!-- --></A>
280<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
281<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
282<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
283<B>Method Summary</B></FONT></TH>
284</TR>
285<TR BGCOLOR="white" CLASS="TableRowColor">
286<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
287<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
288<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/PingRequestHandler.html#getDescription()">getDescription</A></B>()</CODE>
289
290<BR>
291&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Simple one or two line description</TD>
292</TR>
293<TR BGCOLOR="white" CLASS="TableRowColor">
294<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
295<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
296<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/PingRequestHandler.html#getSource()">getSource</A></B>()</CODE>
297
298<BR>
299&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CVS Source, SVN Source, etc</TD>
300</TR>
301<TR BGCOLOR="white" CLASS="TableRowColor">
302<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
303<CODE>protected &nbsp;void</CODE></FONT></TD>
304<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/PingRequestHandler.html#handleEnable(boolean)">handleEnable</A></B>(boolean&nbsp;enable)</CODE>
305
306<BR>
307&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
308</TR>
309<TR BGCOLOR="white" CLASS="TableRowColor">
310<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
311<CODE>protected &nbsp;void</CODE></FONT></TD>
312<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/PingRequestHandler.html#handlePing(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)">handlePing</A></B>(<A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;req,
313           <A HREF="../../../../org/apache/solr/response/SolrQueryResponse.html" title="class in org.apache.solr.response">SolrQueryResponse</A>&nbsp;rsp)</CODE>
314
315<BR>
316&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
317</TR>
318<TR BGCOLOR="white" CLASS="TableRowColor">
319<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
320<CODE>&nbsp;void</CODE></FONT></TD>
321<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/PingRequestHandler.html#handleRequestBody(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)">handleRequestBody</A></B>(<A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;req,
322                  <A HREF="../../../../org/apache/solr/response/SolrQueryResponse.html" title="class in org.apache.solr.response">SolrQueryResponse</A>&nbsp;rsp)</CODE>
323
324<BR>
325&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
326</TR>
327<TR BGCOLOR="white" CLASS="TableRowColor">
328<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
329<CODE>&nbsp;void</CODE></FONT></TD>
330<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/PingRequestHandler.html#inform(org.apache.solr.core.SolrCore)">inform</A></B>(<A HREF="../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A>&nbsp;core)</CODE>
331
332<BR>
333&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
334</TR>
335<TR BGCOLOR="white" CLASS="TableRowColor">
336<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
337<CODE>&nbsp;void</CODE></FONT></TD>
338<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/PingRequestHandler.html#init(org.apache.solr.common.util.NamedList)">init</A></B>(<A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&nbsp;args)</CODE>
339
340<BR>
341&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initializes the <A HREF="../../../../org/apache/solr/request/SolrRequestHandler.html" title="interface in org.apache.solr.request"><CODE>SolrRequestHandler</CODE></A> by creating three <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params"><CODE>SolrParams</CODE></A> named.</TD>
342</TR>
343<TR BGCOLOR="white" CLASS="TableRowColor">
344<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
345<CODE>&nbsp;boolean</CODE></FONT></TD>
346<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/PingRequestHandler.html#isPingDisabled()">isPingDisabled</A></B>()</CODE>
347
348<BR>
349&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the healthcheck flag-file is enabled but does not exist,
350 otherwise (no file configured, or file configured and exists)
351 returns false.</TD>
352</TR>
353</TABLE>
354&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.handler.RequestHandlerBase"><!-- --></A>
355<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
356<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
357<TH ALIGN="left"><B>Methods inherited from class org.apache.solr.handler.<A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html" title="class in org.apache.solr.handler">RequestHandlerBase</A></B></TH>
358</TR>
359<TR BGCOLOR="white" CLASS="TableRowColor">
360<TD><CODE><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#getCategory()">getCategory</A>, <A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#getDocs()">getDocs</A>, <A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#getInitArgs()">getInitArgs</A>, <A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#getName()">getName</A>, <A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#getStatistics()">getStatistics</A>, <A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#getVersion()">getVersion</A>, <A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#handleRequest(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)">handleRequest</A></CODE></TD>
361</TR>
362</TABLE>
363&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
364<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
365<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
366<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
367</TR>
368<TR BGCOLOR="white" CLASS="TableRowColor">
369<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
370</TR>
371</TABLE>
372&nbsp;
373<P>
374
375<!-- ============ FIELD DETAIL =========== -->
376
377<A NAME="field_detail"><!-- --></A>
378<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
379<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
380<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
381<B>Field Detail</B></FONT></TH>
382</TR>
383</TABLE>
384
385<A NAME="log"><!-- --></A><H3>
386log</H3>
387<PRE>
388public static org.slf4j.Logger <B>log</B></PRE>
389<DL>
390<DL>
391</DL>
392</DL>
393<HR>
394
395<A NAME="HEALTHCHECK_FILE_PARAM"><!-- --></A><H3>
396HEALTHCHECK_FILE_PARAM</H3>
397<PRE>
398public static final <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>HEALTHCHECK_FILE_PARAM</B></PRE>
399<DL>
400<DL>
401<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.solr.handler.PingRequestHandler.HEALTHCHECK_FILE_PARAM">Constant Field Values</A></DL>
402</DL>
403
404<!-- ========= CONSTRUCTOR DETAIL ======== -->
405
406<A NAME="constructor_detail"><!-- --></A>
407<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
408<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
409<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
410<B>Constructor Detail</B></FONT></TH>
411</TR>
412</TABLE>
413
414<A NAME="PingRequestHandler()"><!-- --></A><H3>
415PingRequestHandler</H3>
416<PRE>
417public <B>PingRequestHandler</B>()</PRE>
418<DL>
419</DL>
420
421<!-- ============ METHOD DETAIL ========== -->
422
423<A NAME="method_detail"><!-- --></A>
424<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
425<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
426<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
427<B>Method Detail</B></FONT></TH>
428</TR>
429</TABLE>
430
431<A NAME="init(org.apache.solr.common.util.NamedList)"><!-- --></A><H3>
432init</H3>
433<PRE>
434public void <B>init</B>(<A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&nbsp;args)</PRE>
435<DL>
436<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#init(org.apache.solr.common.util.NamedList)">RequestHandlerBase</A></CODE></B></DD>
437<DD>Initializes the <A HREF="../../../../org/apache/solr/request/SolrRequestHandler.html" title="interface in org.apache.solr.request"><CODE>SolrRequestHandler</CODE></A> by creating three <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params"><CODE>SolrParams</CODE></A> named.
438 <table border="1">
439 <tr><th>Name</th><th>Description</th></tr>
440 <tr><td>defaults</td><td>Contains all of the named arguments contained within the list element named "defaults".</td></tr>
441 <tr><td>appends</td><td>Contains all of the named arguments contained within the list element named "appends".</td></tr>
442 <tr><td>invariants</td><td>Contains all of the named arguments contained within the list element named "invariants".</td></tr>
443 </table>
444
445 Example:
446 <pre>
447 &lt;lst name="defaults"&gt;
448 &lt;str name="echoParams"&gt;explicit&lt;/str&gt;
449 &lt;str name="qf"&gt;text^0.5 features^1.0 name^1.2 sku^1.5 id^10.0&lt;/str&gt;
450 &lt;str name="mm"&gt;2&lt;-1 5&lt;-2 6&lt;90%&lt;/str&gt;
451 &lt;str name="bq"&gt;incubationdate_dt:[* TO NOW/DAY-1MONTH]^2.2&lt;/str&gt;
452 &lt;/lst&gt;
453 &lt;lst name="appends"&gt;
454 &lt;str name="fq"&gt;inStock:true&lt;/str&gt;
455 &lt;/lst&gt;
456
457 &lt;lst name="invariants"&gt;
458 &lt;str name="facet.field"&gt;cat&lt;/str&gt;
459 &lt;str name="facet.field"&gt;manu_exact&lt;/str&gt;
460 &lt;str name="facet.query"&gt;price:[* TO 500]&lt;/str&gt;
461 &lt;str name="facet.query"&gt;price:[500 TO *]&lt;/str&gt;
462 &lt;/lst&gt;
463 </pre>
464<P>
465<DD><DL>
466<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/request/SolrRequestHandler.html#init(org.apache.solr.common.util.NamedList)">init</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/request/SolrRequestHandler.html" title="interface in org.apache.solr.request">SolrRequestHandler</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#init(org.apache.solr.common.util.NamedList)">init</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html" title="class in org.apache.solr.handler">RequestHandlerBase</A></CODE></DL>
467</DD>
468<DD><DL>
469<DT><B>Parameters:</B><DD><CODE>args</CODE> - The <A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util"><CODE>NamedList</CODE></A> to initialize from<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#handleRequest(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)"><CODE>RequestHandlerBase.handleRequest(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)</CODE></A>,
470<A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#handleRequestBody(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)"><CODE>RequestHandlerBase.handleRequestBody(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)</CODE></A>,
471<A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#setDefaults(org.apache.solr.request.SolrQueryRequest, org.apache.solr.common.params.SolrParams, org.apache.solr.common.params.SolrParams, org.apache.solr.common.params.SolrParams)"><CODE>SolrPluginUtils.setDefaults(org.apache.solr.request.SolrQueryRequest, org.apache.solr.common.params.SolrParams, org.apache.solr.common.params.SolrParams, org.apache.solr.common.params.SolrParams)</CODE></A>,
472<A HREF="../../../../org/apache/solr/common/params/SolrParams.html#toSolrParams(org.apache.solr.common.util.NamedList)"><CODE>See also the example solrconfig.xml located in the Solr codebase (example/solr/conf).</CODE></A></DL>
473</DD>
474</DL>
475<HR>
476
477<A NAME="inform(org.apache.solr.core.SolrCore)"><!-- --></A><H3>
478inform</H3>
479<PRE>
480public void <B>inform</B>(<A HREF="../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A>&nbsp;core)</PRE>
481<DL>
482<DD><DL>
483<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/util/plugin/SolrCoreAware.html#inform(org.apache.solr.core.SolrCore)">inform</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/util/plugin/SolrCoreAware.html" title="interface in org.apache.solr.util.plugin">SolrCoreAware</A></CODE></DL>
484</DD>
485<DD><DL>
486</DL>
487</DD>
488</DL>
489<HR>
490
491<A NAME="isPingDisabled()"><!-- --></A><H3>
492isPingDisabled</H3>
493<PRE>
494public boolean <B>isPingDisabled</B>()</PRE>
495<DL>
496<DD>Returns true if the healthcheck flag-file is enabled but does not exist,
497 otherwise (no file configured, or file configured and exists)
498 returns false.
499<P>
500<DD><DL>
501</DL>
502</DD>
503<DD><DL>
504</DL>
505</DD>
506</DL>
507<HR>
508
509<A NAME="handleRequestBody(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)"><!-- --></A><H3>
510handleRequestBody</H3>
511<PRE>
512public void <B>handleRequestBody</B>(<A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;req,
513                              <A HREF="../../../../org/apache/solr/response/SolrQueryResponse.html" title="class in org.apache.solr.response">SolrQueryResponse</A>&nbsp;rsp)
514                       throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
515<DL>
516<DD><DL>
517<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#handleRequestBody(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)">handleRequestBody</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html" title="class in org.apache.solr.handler">RequestHandlerBase</A></CODE></DL>
518</DD>
519<DD><DL>
520
521<DT><B>Throws:</B>
522<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE></DL>
523</DD>
524</DL>
525<HR>
526
527<A NAME="handlePing(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)"><!-- --></A><H3>
528handlePing</H3>
529<PRE>
530protected void <B>handlePing</B>(<A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;req,
531                          <A HREF="../../../../org/apache/solr/response/SolrQueryResponse.html" title="class in org.apache.solr.response">SolrQueryResponse</A>&nbsp;rsp)
532                   throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
533<DL>
534<DD><DL>
535</DL>
536</DD>
537<DD><DL>
538
539<DT><B>Throws:</B>
540<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE></DL>
541</DD>
542</DL>
543<HR>
544
545<A NAME="handleEnable(boolean)"><!-- --></A><H3>
546handleEnable</H3>
547<PRE>
548protected void <B>handleEnable</B>(boolean&nbsp;enable)
549                     throws <A HREF="../../../../org/apache/solr/common/SolrException.html" title="class in org.apache.solr.common">SolrException</A></PRE>
550<DL>
551<DD><DL>
552</DL>
553</DD>
554<DD><DL>
555
556<DT><B>Throws:</B>
557<DD><CODE><A HREF="../../../../org/apache/solr/common/SolrException.html" title="class in org.apache.solr.common">SolrException</A></CODE></DL>
558</DD>
559</DL>
560<HR>
561
562<A NAME="getDescription()"><!-- --></A><H3>
563getDescription</H3>
564<PRE>
565public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getDescription</B>()</PRE>
566<DL>
567<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getDescription()">SolrInfoMBean</A></CODE></B></DD>
568<DD>Simple one or two line description
569<P>
570<DD><DL>
571<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getDescription()">getDescription</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#getDescription()">getDescription</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html" title="class in org.apache.solr.handler">RequestHandlerBase</A></CODE></DL>
572</DD>
573<DD><DL>
574</DL>
575</DD>
576</DL>
577<HR>
578
579<A NAME="getSource()"><!-- --></A><H3>
580getSource</H3>
581<PRE>
582public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getSource</B>()</PRE>
583<DL>
584<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getSource()">SolrInfoMBean</A></CODE></B></DD>
585<DD>CVS Source, SVN Source, etc
586<P>
587<DD><DL>
588<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getSource()">getSource</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#getSource()">getSource</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html" title="class in org.apache.solr.handler">RequestHandlerBase</A></CODE></DL>
589</DD>
590<DD><DL>
591</DL>
592</DD>
593</DL>
594<!-- ========= END OF CLASS DATA ========= -->
595<HR>
596
597
598<!-- ======= START OF BOTTOM NAVBAR ====== -->
599<A NAME="navbar_bottom"><!-- --></A>
600<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
601<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
602<TR>
603<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
604<A NAME="navbar_bottom_firstrow"><!-- --></A>
605<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
606  <TR ALIGN="center" VALIGN="top">
607  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
608  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
609  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
610  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/PingRequestHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
611  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
612  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
613  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
614  </TR>
615</TABLE>
616</TD>
617<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
618</EM>
619</TD>
620</TR>
621
622<TR>
623<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
624&nbsp;<A HREF="../../../../org/apache/solr/handler/MoreLikeThisHandler.MoreLikeThisHelper.html" title="class in org.apache.solr.handler"><B>PREV CLASS</B></A>&nbsp;
625&nbsp;<A HREF="../../../../org/apache/solr/handler/PingRequestHandler.ACTIONS.html" title="enum in org.apache.solr.handler"><B>NEXT CLASS</B></A></FONT></TD>
626<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
627  <A HREF="../../../../index.html?org/apache/solr/handler/PingRequestHandler.html" target="_top"><B>FRAMES</B></A>  &nbsp;
628&nbsp;<A HREF="PingRequestHandler.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
629&nbsp;<SCRIPT type="text/javascript">
630  <!--
631  if(window==top) {
632    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
633  }
634  //-->
635</SCRIPT>
636<NOSCRIPT>
637  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
638</NOSCRIPT>
639
640
641</FONT></TD>
642</TR>
643<TR>
644<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
645  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
646<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
647DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
648</TR>
649</TABLE>
650<A NAME="skip-navbar_bottom"></A>
651<!-- ======== END OF BOTTOM NAVBAR ======= -->
652
653<HR>
654
655          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
656          <script src='../../../../prettify.js' type='text/javascript'></script>
657          <script type='text/javascript'>
658            (function(){
659              var oldonload = window.onload;
660              if (typeof oldonload != 'function') {
661                window.onload = prettyPrint;
662              } else {
663                window.onload = function() {
664                  oldonload();
665                  prettyPrint();
666                }
667              }
668            })();
669          </script>
670       
671</BODY>
672</HTML>
Note: See TracBrowser for help on using the repository browser.