Package org.xwiki.activeinstalls2

Interface DataManager

@Role
public interface DataManager

Provides access to stored ping data.

Since:

5.2M2

Version:

$Id: b104b449125485dcccd3ca5b74c2a1d0df0584e6 $

Method Summary

Modifier and Type	Method	Description
long	countInstalls(String jsonQuery)	Executes a Count query for Active Installs.
List<org.xwiki.activeinstalls2.internal.data.Ping>	searchInstalls(String jsonQuery)	Executes a Search query for Active Installs.

Method Detail

searchInstalls

List<org.xwiki.activeinstalls2.internal.data.Ping> searchInstalls(String jsonQuery)
                                                           throws Exception

Executes a Search query for Active Installs.

Parameters:

jsonQuery - the Elastic Search JSON query used to search for installs. For example:

            {
                "term": { "distributionVersion" : "5.2" }
            }
        

Returns:

the parsed JSON result coming from Elastic Search, as a list of Ping object. Passing an empty or null json string results in returning all data found in the index (i.e no query constraint)

Throws:

Exception - when an error happens while retrieving the data

Since:

14.4RC1

countInstalls

long countInstalls(String jsonQuery)
            throws Exception

Executes a Count query for Active Installs.

Parameters:

jsonQuery - the Elastic Search JSON query used to search for installs. Passing an empty or null json string results in returning a count of all data in the index (i.e no query constraint)

Returns:

the count number

Throws:

Exception - when an error happens while retrieving the data

Since:

14.4RC1