Package org.alfresco.repo.search.impl

Class AbstractJSONAPIResult

java.lang.Object

org.alfresco.repo.search.impl.AbstractJSONAPIResult

All Implemented Interfaces:

JSONAPIResult

Direct Known Subclasses:

SolrActionAclReportResult, SolrActionAclTxReportResult, SolrActionCheckResult, SolrActionFixResult, SolrActionNodeReportResult, SolrActionReportResult, SolrActionStatusResult, SolrActionTxReportResult, SolrCommandBackupResult

public abstract class AbstractJSONAPIResult
extends Object
implements JSONAPIResult

JSON returned from SOLR API Parser This class defines common properties and performs response header parsing. An abstract method is provided for implementers to parse Core Information.

Since:

6.2

Author:

aborroy

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	cores
protected Map<String,Map<String,Object>>	coresInfo
protected Long	queryTime
protected Long	status

Constructor Summary

Constructors

Constructor	Description
AbstractJSONAPIResult()

Method Summary

Modifier and Type	Method	Description
List<String>	getCores()	Name of the cores managed by SOLR
Map<String,Map<String,Object>>	getCoresInfo()	Information from the cores to be exposed in JMX Beans The names and the structure of the properties depend on the type of the Action
protected Map<String,Object>	getPropertyValueMap(org.json.JSONObject json)	Creates a property-value Map from a JSON Object containing properties and values This method provides the right input for MBeans to expose the SOLR response values from the Response
Long	getQueryTime()	Time to perform the requested action or command in SOLR
Long	getStatus()	HTTP Response code But for 200, that is being returned as 0
protected abstract void	processCoresInfoJson(org.json.JSONObject json)	Parses the JSON to set this Java Object values related to Core Information
protected void	processJson(org.json.JSONObject json)	Parses the JSON to set this Java Object values

Methods inherited from class java.lang.Object

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

Field Details

status

protected Long status

queryTime

protected Long queryTime

cores

protected List<String> cores

coresInfo

protected Map<String,Map<String,Object>> coresInfo

Constructor Details

AbstractJSONAPIResult

public AbstractJSONAPIResult()

Method Details

getQueryTime

public Long getQueryTime()

Description copied from interface: JSONAPIResult

Time to perform the requested action or command in SOLR

Specified by:

getQueryTime in interface JSONAPIResult

Returns:

Number of milliseconds

getStatus

public Long getStatus()

Description copied from interface: JSONAPIResult

HTTP Response code But for 200, that is being returned as 0

Specified by:

getStatus in interface JSONAPIResult

Returns:

Number representing an HTTP Status

getCores

public List<String> getCores()

Description copied from interface: JSONAPIResult

Name of the cores managed by SOLR

Specified by:

getCores in interface JSONAPIResult

Returns:

A list with the names of the cores

getCoresInfo

public Map<String,Map<String,Object>> getCoresInfo()

Description copied from interface: JSONAPIResult

Information from the cores to be exposed in JMX Beans The names and the structure of the properties depend on the type of the Action

Specified by:

getCoresInfo in interface JSONAPIResult

Returns:

Core information by core name

processJson

protected void processJson(org.json.JSONObject json)
                    throws org.json.JSONException

Parses the JSON to set this Java Object values

Parameters:

json - JSONObject returned by SOLR API

Throws:

org.json.JSONException

getPropertyValueMap

protected Map<String,Object> getPropertyValueMap(org.json.JSONObject json)
                                          throws org.json.JSONException

Creates a property-value Map from a JSON Object containing properties and values This method provides the right input for MBeans to expose the SOLR response values from the Response

Parameters:

json - Simple JSON Object containing only properties

Returns:

Property-value Map

Throws:

org.json.JSONException

processCoresInfoJson

protected abstract void processCoresInfoJson(org.json.JSONObject json)
                                      throws org.json.JSONException

Parses the JSON to set this Java Object values related to Core Information

Parameters:

json - JSONObject returned by SOLR API

Throws:

org.json.JSONException