org.xwiki.activeinstalls.server.script

Class ActiveInstallsScriptService

java.lang.Object

org.xwiki.activeinstalls.server.script.ActiveInstallsScriptService

All Implemented Interfaces:

org.xwiki.script.service.ScriptService

@Component
 @Named(value="activeinstalls")
 @Singleton
public class ActiveInstallsScriptService
extends Object
implements org.xwiki.script.service.ScriptService

Provides Scripting APIs for the Active Installs module.

Since:

5.2M2

Version:

$Id: cccd0a0b18eb3693a85784e344efb669cbd3acf9 $

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIVEINSTALLS_ERROR_KEY The key under which the last encountered error is stored in the current execution context.

Constructor Summary

Constructors

Constructor and Description
ActiveInstallsScriptService()

Method Summary

Modifier and Type	Method and Description
com.google.gson.JsonObject	countInstalls(String indexType, String fullQuery)
com.google.gson.JsonObject	countInstalls(String indexType, String fullQuery, Map<String,Object> parameters) Executes a Count query for Active Installs.
Exception	getLastError() Get the error generated while performing the previously called action.
com.google.gson.JsonObject	searchInstalls(String indexType, String fullQuery)
com.google.gson.JsonObject	searchInstalls(String indexType, String fullQuery, Map<String,Object> parameters) Executes a Search query for Active Installs.

Methods inherited from class java.lang.Object

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

Field Detail

ACTIVEINSTALLS_ERROR_KEY

public static final String ACTIVEINSTALLS_ERROR_KEY

The key under which the last encountered error is stored in the current execution context.

See Also:

Constant Field Values

Constructor Detail

ActiveInstallsScriptService

public ActiveInstallsScriptService()

Method Detail

countInstalls

public com.google.gson.JsonObject countInstalls(String indexType,
                                                String fullQuery,
                                                Map<String,Object> parameters)

Executes a Count query for Active Installs.

Parameters:

indexType - the Elastic Search index type (e.g. "installs" or "installs2". Some XWiki instances may have sent pings stored under a given index type while other instances may have used another index type (and thus another data format). We use the index type to match a given data model. The Active Installs Client module should be checked to understand the data model used.

fullQuery - the full Elastic Search query used to search for installs.

parameters - the ElasticSearch count parameters to use (see for example Count API)

Returns:

the parsed JSON result coming from Elastic Search or null if an error happened, in which case the error can be retrieved with getLastError().

Since:

6.1M1

countInstalls

public com.google.gson.JsonObject countInstalls(String indexType,
                                                String fullQuery)

See Also:

countInstalls(String, String, java.util.Map)

searchInstalls

public com.google.gson.JsonObject searchInstalls(String indexType,
                                                 String fullQuery,
                                                 Map<String,Object> parameters)

Executes a Search query for Active Installs.

Parameters:

indexType - the Elastic Search index type (e.g. "installs" or "installs2". Some XWiki instances may have sent pings stored under a given index type while other instances may have used another index type (and thus another data format). We use the index type to match a given data model. The Active Installs Client module should be checked to understand the data model used.

fullQuery - the full Elastic Search query used to search for installs. For example:

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

parameters - the ElasticSearch search parameters to use (see for example Search URI parameters)

Returns:

the parsed JSON result coming from Elastic Search or null if an error happened, in which case the error can be retrieved with getLastError(). For example:

            {
              "took": 97,
              "timed_out": false,
              "_shards": {
                "total": 1,
                "successful": 1,
                "failed": 0
              },
              "hits": {
                "total": 2,
                "max_score": 1,
                "hits": [
                  {
                    "_index": "installs",
                    "_type": "install",
                    "_id": "id1",
                    "_score": 1,
                    "_source": {
                      "distributionVersion": "5.2",
                      ...
                    }
                  },
                  {
                    "_index": "installs",
                    "_type": "install",
                    "_id": "id2",
                    "_score": 0.625,
                    "_source": {
                      "distributionVersion": "5.2-SNAPSHOT",
                      ...
                    }
                  }
                ]
              }
            }
        

Since:

6.1M1

searchInstalls

public com.google.gson.JsonObject searchInstalls(String indexType,
                                                 String fullQuery)

See Also:

searchInstalls(String, String, java.util.Map)

getLastError

public Exception getLastError()

Get the error generated while performing the previously called action.

Returns:

the exception or null if no exception was thrown