org.wso2.carbon.analytics.webservice

Class AnalyticsWebService

java.lang.Object

org.wso2.carbon.core.AbstractAdmin

org.wso2.carbon.analytics.webservice.AnalyticsWebService

public class AnalyticsWebService
extends org.wso2.carbon.core.AbstractAdmin

This class is the service class for analytics data service web service. This will expose some methods in the AnalyticsDataAPI as a web service methods.

Field Summary

Fields inherited from class org.wso2.carbon.core.AbstractAdmin

axisConfig, configurationContext

Constructor Summary

Constructors

Constructor and Description
AnalyticsWebService()

Method Summary

Methods

Modifier and Type	Method and Description
String	addStreamDefinition(StreamDefinitionBean streamDefinitionBean) Add a stream definition using the Event stream publisher.
void	clearIndices(String tableName) Clears all the indices for the given table.
void	createTable(String recordStoreName, String tableName) Creates a table, if not already there, where the columns are not defined here, but can contain any arbitrary number of columns when data is added.
void	deleteByIds(String tableName, String[] ids) Delete data in a table with given ids.
void	destroy() Destroys and frees any resources taken up by the analytics data service implementation.
SubCategoriesBean	drillDownCategories(CategoryDrillDownRequestBean drillDownRequest) Returns the subcategories of a facet field, given CategoryDrillDownRequestBean
RecordBean[]	drillDownSearch(AnalyticsDrillDownRequestBean drillDownRequest) Returns the drill down results of a search query, given AnalyticsDrillDownRequestBean
double	drillDownSearchCount(AnalyticsDrillDownRequestBean drillDownRequest) Returns the count of results of a search query, given AnalyticsDrillDownRequestBean
RecordBean[]	getById(String tableName, int numPartitionsHint, String[] columns, String[] ids) Retrieves data from a table with given ids.
RecordBean[]	getByRange(String tableName, int numPartitionsHint, String[] columns, long timeFrom, long timeTo, int recordsFrom, int recordsCount) Retrieves data from a table, with a given range.
long	getRecordCount(String tableName, long timeFrom, long timeTo) Returns the number of records in the table with the given category and name.
String	getRecordStoreNameByTable(String tableName) Returns the record store name given the table information.
StreamDefinitionBean	getStreamDefinition(String name, String version) get the stream definition using the Event stream publisher.
AnalyticsSchemaBean	getTableSchema(String tableName) Retrieves the table schema for the given table.
protected String	getUsername() This method is use to get logged in username with tenant domain
RecordBean[]	getWithKeyValues(String tableName, int numPartitionsHint, String[] columns, ValuesBatchBean[] valuesBatchBeans) Retrieves data from a table, which matches the primary key values batch.
boolean	isPaginationSupported(String recordStoreName) Check whether under laying data layer implementation support for pagination or not.
boolean	isRecordCountSupported(String recordStoreName) Check whether under laying data layer implementation support for get total record count operation or not.
List<String>	listRecordStoreNames() Lists all the record stores available in the system.
String[]	listTables() Lists all the current tables with the given category.
void	publishEvent(EventBean eventBean) Publishes events to a given stream represented by stream id.
void	reIndex(String tableName, long startTime, long endTime) Given the start time and end time, this method will re-index the records of a table.
void	removeStreamDefinition(String name, String version) This method can use to remove existing stream definition from system using the Event stream publisher.
RecordBean[]	search(String tableName, String query, int start, int count) Searches the data with a given search query.
int	searchCount(String tableName, String query) Returns the search count of results of a given search query.
AggregateResponse[]	searchMultiTablesWithAggregates(AnalyticsAggregateRequest[] requests) Returns a list of records containing the aggregate values computed over the given fields map , grouped by a predefined FACET field for multiple tables.
RecordBean[]	searchWithAggregates(AnalyticsAggregateRequest request) Returns a list of records containing the aggregate values computed over the given fields map , grouped by a predefined FACET field.
RecordBean[]	searchWithSorting(String tableName, String query, int start, int count, String[] columns, SortByFieldBean[] sortByFields) Searches the data with a given search query.
void	setTableSchema(String tableName, AnalyticsSchemaBean schemaBean) Sets the table schema for a table
boolean	tableExists(String tableName) Checks if the specified table with the given category and name exists.
void	waitForIndexing(long maxWait) This method waits until the current indexing operations for the system is done.
void	waitForIndexingForTable(String tableName, long maxWait) This method waits until the current indexing operations for a given table is done.

Methods inherited from class org.wso2.carbon.core.AbstractAdmin

getAxisConfig, getConfigContext, getConfigSystemRegistry, getConfigUserRegistry, getGovernanceRegistry, getGovernanceSystemRegistry, getGovernanceUserRegistry, getHttpSession, getLocalRepo, getRegistry, getTenantDomain, getUserRealm, setConfigurationContext, setPermissionUpdateTimestamp

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalyticsWebService

public AnalyticsWebService()

Method Detail

getUsername

protected String getUsername()

This method is use to get logged in username with tenant domain

Overrides:

getUsername in class org.wso2.carbon.core.AbstractAdmin

Returns:

Username with tenant domain

addStreamDefinition

public String addStreamDefinition(StreamDefinitionBean streamDefinitionBean)
                           throws AnalyticsWebServiceException,
                                  org.wso2.carbon.databridge.commons.exception.MalformedStreamDefinitionException

Add a stream definition using the Event stream publisher.

Parameters:

streamDefinitionBean - The stream definition bean class.

Throws:

AnalyticsWebServiceException

org.wso2.carbon.databridge.commons.exception.MalformedStreamDefinitionException

getStreamDefinition

public StreamDefinitionBean getStreamDefinition(String name,
                                       String version)
                                         throws AnalyticsWebServiceException

get the stream definition using the Event stream publisher.

Parameters:

name - The name of the stream.

version - The version of the stream

Returns:

The stream definition bean

Throws:

AnalyticsWebServiceException

removeStreamDefinition

public void removeStreamDefinition(String name,
                          String version)
                            throws AnalyticsWebServiceException

This method can use to remove existing stream definition from system using the Event stream publisher.

Parameters:

name - The name of the stream.

version - The version of the stream

Throws:

AnalyticsWebServiceException

publishEvent

public void publishEvent(EventBean eventBean)
                  throws AnalyticsWebServiceException

Publishes events to a given stream represented by stream id.

Parameters:

eventBean - The event bean representing the event data.

Throws:

AnalyticsWebServiceException

setTableSchema

public void setTableSchema(String tableName,
                  AnalyticsSchemaBean schemaBean)
                    throws AnalyticsWebServiceException

Sets the table schema for a table

Parameters:

schemaBean - The schema bean representing the schema

Throws:

AnalyticsWebServiceException

searchWithAggregates

public RecordBean[] searchWithAggregates(AnalyticsAggregateRequest request)
                                  throws AnalyticsWebServiceException

Returns a list of records containing the aggregate values computed over the given fields map , grouped by a predefined FACET field.

Parameters:

request - The inputs required for performing aggregation. groupByField is used to group the records. It should be a facet field created by the grouping fields. fields attribute represents the record fields and the respective aggregate function. aliases represents the output field names for aggregated values over the fields.

Returns:

List of records of which the record values will be the aggregate values of the given fields

Throws:

AnalyticsWebServiceException

searchMultiTablesWithAggregates

public AggregateResponse[] searchMultiTablesWithAggregates(AnalyticsAggregateRequest[] requests)
                                                    throws AnalyticsWebServiceException

Returns a list of records containing the aggregate values computed over the given fields map , grouped by a predefined FACET field for multiple tables.

Parameters:

requests - The Array of AnalyticsAggregateRequests representing multiple tables groupByField is used to group the records. It should be a facet field created by the grouping fields. fields attribute represents the record fields and the respective aggregate function. aliases represents the output field names for aggregated values over the fields.

Returns:

Array of AggregatedObjects containing arrays of records of which the record values will be the aggregate values of the given fields

Throws:

AnalyticsWebServiceException

getTableSchema

public AnalyticsSchemaBean getTableSchema(String tableName)
                                   throws AnalyticsWebServiceException

Retrieves the table schema for the given table.

Parameters:

tableName - The table name

Returns:

The schema of the table

Throws:

AnalyticsWebServiceException

tableExists

public boolean tableExists(String tableName)
                    throws AnalyticsWebServiceException

Checks if the specified table with the given category and name exists.

Parameters:

tableName - The table name

Returns:

true if the table exists, false otherwise

Throws:

AnalyticsWebServiceException

listTables

public String[] listTables()
                    throws AnalyticsWebServiceException

Lists all the current tables with the given category.

Returns:

The list of table names

Throws:

AnalyticsWebServiceException

getRecordCount

public long getRecordCount(String tableName,
                  long timeFrom,
                  long timeTo)
                    throws AnalyticsWebServiceException

Returns the number of records in the table with the given category and name.

Parameters:

tableName - The name of the table to get the count from

timeFrom - The starting time to consider the count from, inclusive, relatively to epoch, Long.MIN_VALUE should signal, this restriction to be disregarded

timeTo - The ending time to consider the count to, non-inclusive, relatively to epoch, Long.MAX_VALUE should signal, this restriction to be disregarded

Returns:

The record count

Throws:

AnalyticsWebServiceException

getByRange

public RecordBean[] getByRange(String tableName,
                      int numPartitionsHint,
                      String[] columns,
                      long timeFrom,
                      long timeTo,
                      int recordsFrom,
                      int recordsCount)
                        throws AnalyticsWebServiceException

Retrieves data from a table, with a given range.

Parameters:

tableName - The name of the table to search on

numPartitionsHint - The best effort number of splits this should return

columns - The list of columns to required in results, null if all needs to be returned

timeFrom - The starting time to get records from, inclusive, relatively to epoch, Long.MIN_VALUE should signal, this restriction to be disregarded

timeTo - The ending time to get records to, non-inclusive, relatively to epoch, Long.MAX_VALUE should signal, this restriction to be disregarded

recordsFrom - The paginated index from value, zero based, inclusive

recordsCount - The paginated records count to be read, -getUsername() for infinity

Returns:

An array of RecordBean objects, which represents individual data sets in their local location

Throws:

AnalyticsWebServiceException

getWithKeyValues

public RecordBean[] getWithKeyValues(String tableName,
                            int numPartitionsHint,
                            String[] columns,
                            ValuesBatchBean[] valuesBatchBeans)
                              throws AnalyticsWebServiceException

Retrieves data from a table, which matches the primary key values batch.

Parameters:

tableName - The name of the table to search on

numPartitionsHint - The best effort number of splits this should return

columns - The list of columns to required in results, null if all needs to be returned

valuesBatchBeans - The values batch containing the key values of primary keys to match

Returns:

An array of RecordBean objects, which represents individual data sets in their local location

Throws:

AnalyticsWebServiceException

getById

public RecordBean[] getById(String tableName,
                   int numPartitionsHint,
                   String[] columns,
                   String[] ids)
                     throws AnalyticsWebServiceException

Retrieves data from a table with given ids.

Parameters:

tableName - The name of the table to search on

numPartitionsHint - The best effort number of splits this should return

columns - The list of columns to required in results, null if all needs to be returned

ids - The list of ids of the records to be read

Returns:

An array of RecordBean objects, which contains individual data sets in their local location

Throws:

AnalyticsWebServiceException

deleteByIds

public void deleteByIds(String tableName,
               String[] ids)
                 throws AnalyticsWebServiceException

Delete data in a table with given ids.

Parameters:

tableName - The name of the table to search on

ids - The list of ids of the records to be deleted

Throws:

AnalyticsWebServiceException

clearIndices

public void clearIndices(String tableName)
                  throws AnalyticsWebServiceException

Clears all the indices for the given table.

Parameters:

tableName - The table name

Throws:

AnalyticsWebServiceException

searchWithSorting

public RecordBean[] searchWithSorting(String tableName,
                             String query,
                             int start,
                             int count,
                             String[] columns,
                             SortByFieldBean[] sortByFields)
                               throws AnalyticsWebServiceException

Searches the data with a given search query.

Parameters:

tableName - The table name

query - The search query

start - The start location of the result, 0 based

count - The maximum number of result entries to be returned

columns - The columns needed from each record

sortByFields - The fields by which the records needs to be sorted

Returns:

An arrays of RecordBeans

Throws:

AnalyticsWebServiceException

search

public RecordBean[] search(String tableName,
                  String query,
                  int start,
                  int count)
                    throws AnalyticsWebServiceException

Searches the data with a given search query.

Parameters:

tableName - The table name

query - The search query

start - The start location of the result, 0 based

count - The maximum number of result entries to be returned

Returns:

An arrays of RecordBeans

Throws:

AnalyticsWebServiceException

searchCount

public int searchCount(String tableName,
              String query)
                throws AnalyticsWebServiceException

Returns the search count of results of a given search query.

Parameters:

tableName - The table name

query - The search query

Returns:

The count of results

Throws:

AnalyticsWebServiceException

waitForIndexing

public void waitForIndexing(long maxWait)
                     throws AnalyticsWebServiceException

This method waits until the current indexing operations for the system is done.

Parameters:

maxWait - Maximum amount of time in milliseconds, -getUsername() for infinity

Throws:

AnalyticsWebServiceException

waitForIndexingForTable

public void waitForIndexingForTable(String tableName,
                           long maxWait)
                             throws AnalyticsWebServiceException

This method waits until the current indexing operations for a given table is done.

Parameters:

tableName - table being checked

maxWait - Maximum amount of time in milliseconds, -getUsername() for infinity

Throws:

AnalyticsWebServiceException

reIndex

public void reIndex(String tableName,
           long startTime,
           long endTime)
             throws AnalyticsWebServiceException

Given the start time and end time, this method will re-index the records of a table.

Parameters:

tableName - the table name of which the records are being re-indexed.

startTime - lowerbound of the timestamp range of records

endTime - upperbound of the timestamp range of records

Throws:

AnalyticsWebServiceException

destroy

public void destroy()
             throws AnalyticsWebServiceException

Destroys and frees any resources taken up by the analytics data service implementation.

Throws:

AnalyticsWebServiceException

isPaginationSupported

public boolean isPaginationSupported(String recordStoreName)
                              throws AnalyticsWebServiceException

Check whether under laying data layer implementation support for pagination or not.

Returns:

boolean true or false based on under laying data layer implementation

Throws:

AnalyticsWebServiceException

isRecordCountSupported

public boolean isRecordCountSupported(String recordStoreName)
                               throws AnalyticsWebServiceException

Check whether under laying data layer implementation support for get total record count operation or not.

Parameters:

recordStoreName - Record store name

Returns:

Record store support for record count or not.

Throws:

AnalyticsWebServiceException

drillDownCategories

public SubCategoriesBean drillDownCategories(CategoryDrillDownRequestBean drillDownRequest)
                                      throws AnalyticsWebServiceException

Returns the subcategories of a facet field, given CategoryDrillDownRequestBean

Parameters:

drillDownRequest - The category drilldown object which contains the category drilldown information

Returns:

SubCategoriesBean instance that contains the immediate category information

Throws:

AnalyticsWebServiceException

drillDownSearch

public RecordBean[] drillDownSearch(AnalyticsDrillDownRequestBean drillDownRequest)
                             throws AnalyticsWebServiceException

Returns the drill down results of a search query, given AnalyticsDrillDownRequestBean

Parameters:

drillDownRequest - The drilldown object which contains the drilldown information

Returns:

An arrays of RecordBeans

Throws:

AnalyticsWebServiceException

drillDownSearchCount

public double drillDownSearchCount(AnalyticsDrillDownRequestBean drillDownRequest)
                            throws AnalyticsWebServiceException

Returns the count of results of a search query, given AnalyticsDrillDownRequestBean

Parameters:

drillDownRequest - The drilldown object which contains the drilldown information

Returns:

the count of the records which match the drilldown query

Throws:

AnalyticsWebServiceException

listRecordStoreNames

public List<String> listRecordStoreNames()
                                  throws AnalyticsWebServiceException

Lists all the record stores available in the system.

Returns:

The list of record store names

Throws:

AnalyticsWebServiceException

createTable

public void createTable(String recordStoreName,
               String tableName)
                 throws AnalyticsWebServiceException

Creates a table, if not already there, where the columns are not defined here, but can contain any arbitrary number of columns when data is added. The table names are not case sensitive.

Parameters:

recordStoreName - The name of the target record store to store the table at

tableName - The name of the table to be created

Throws:

AnalyticsWebServiceException

getRecordStoreNameByTable

public String getRecordStoreNameByTable(String tableName)
                                 throws AnalyticsWebServiceException

Returns the record store name given the table information.

Parameters:

tableName - The table name

Returns:

The record store name

Throws:

AnalyticsWebServiceException