Package org.apache.solr.client.solrj.request

Class SolrPing

java.lang.Object

org.apache.solr.client.solrj.SolrRequest<T>

org.apache.solr.client.solrj.request.CollectionRequiringSolrRequest<SolrPingResponse>

org.apache.solr.client.solrj.request.SolrPing

All Implemented Interfaces:

Serializable

public class SolrPing
extends CollectionRequiringSolrRequest<SolrPingResponse>

Verify that there is a working Solr core at the URL of a SolrClient. To use this class, the solrconfig.xml for the relevant core must include the request handler for /admin/ping.

Since:

solr 1.3

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.solr.client.solrj.SolrRequest

SolrRequest.METHOD, SolrRequest.SolrClientContext, SolrRequest.SolrRequestType

Field Summary

Fields inherited from class org.apache.solr.client.solrj.SolrRequest

SUPPORTED_METHODS, useBinaryV2, usev2

Constructor Summary

Constructors

Constructor	Description
SolrPing()	Create a new SolrPing object.

Method Summary

Modifier and Type	Method	Description
protected SolrPingResponse	createResponse(SolrClient client)	Create a new SolrResponse to hold the response from the server
ModifiableSolrParams	getParams()
String	getRequestType()	This method defines the type of this Solr request.
SolrPing	removeAction()	Remove the action parameter from this request.
SolrPing	setActionDisable()	Set the action parameter on this request to enable.
SolrPing	setActionEnable()	Set the action parameter on this request to enable.
SolrPing	setActionPing()	Set the action parameter on this request to ping.

Methods inherited from class org.apache.solr.client.solrj.request.CollectionRequiringSolrRequest

requiresCollection

Methods inherited from class org.apache.solr.client.solrj.SolrRequest

addHeader, addHeaders, getBasePath, getBasicAuthPassword, getBasicAuthUser, getCollection, getContentStreams, getContentWriter, getHeaders, getMethod, getPath, getPreferredNodes, getQueryParams, getResponseParser, getStreamingResponseCallback, getUserPrincipal, process, process, setBasePath, setBasicAuthCredentials, setMethod, setPath, setPreferredNodes, setQueryParams, setResponseParser, setStreamingResponseCallback, setUseBinaryV2, setUserPrincipal, setUseV2

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SolrPing

public SolrPing()

Create a new SolrPing object.

Method Detail

createResponse

protected SolrPingResponse createResponse(SolrClient client)

Description copied from class: SolrRequest

Create a new SolrResponse to hold the response from the server

Specified by:

createResponse in class SolrRequest<SolrPingResponse>

Parameters:

client - the SolrClient the request will be sent to

getParams

public ModifiableSolrParams getParams()

Specified by:

getParams in class SolrRequest<SolrPingResponse>

getRequestType

public String getRequestType()

Description copied from class: SolrRequest

This method defines the type of this Solr request.

Specified by:

getRequestType in class SolrRequest<SolrPingResponse>

removeAction

public SolrPing removeAction()

Remove the action parameter from this request. This will result in the same behavior as SolrPing#setActionPing(). For Solr server version 4.0 and later.

Returns:

this

setActionDisable

public SolrPing setActionDisable()

Set the action parameter on this request to enable. This will delete the health-check file for the Solr core. For Solr server version 4.0 and later.

Returns:

this

setActionEnable

public SolrPing setActionEnable()

Set the action parameter on this request to enable. This will create the health-check file for the Solr core. For Solr server version 4.0 and later.

Returns:

this

setActionPing

public SolrPing setActionPing()

Set the action parameter on this request to ping. This is the same as not including the action at all. For Solr server version 4.0 and later.

Returns:

this