org.wso2.carbon.analytics.restapi.resources

Class AnalyticsResource

java.lang.Object

org.wso2.carbon.analytics.restapi.resources.AbstractResource

org.wso2.carbon.analytics.restapi.resources.AnalyticsResource

@Path(value="/")
public class AnalyticsResource
extends AbstractResource

The Class AnalyticsResource represents the REST APIs for AnalyticsDataService.

Nested Class Summary

Nested classes/interfaces inherited from class org.wso2.carbon.analytics.restapi.resources.AbstractResource

AbstractResource.ResponseStatus

Constructor Summary

Constructors

Constructor and Description
AnalyticsResource()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	clearIndices(String tableName, String authHeader) Clear indices.
javax.ws.rs.core.Response	clearTableCache(String tableName, String authHeader) To clear table information from in memory cache
javax.ws.rs.core.Response	drillDown(DrillDownRequestBean requestBean, String authHeader) Performs the drilldown operation on a given table.
javax.ws.rs.core.Response	drillDownCategories(CategoryDrillDownRequestBean requestBean, String authHeader) Performs the drilldown operation on a given field to get the child categories
javax.ws.rs.core.Response	drillDownCount(DrillDownRequestBean requestBean, String authHeader) Performs the drilldown operation on a given table.
javax.ws.rs.core.Response	drillDownRangeCount(DrillDownRequestBean requestBean, String authHeader) Performs the drilldown operation on a given set of range buckets of a field.
javax.ws.rs.core.Response	getRecordCount(String tableName, String authHeader) Gets the record count.
javax.ws.rs.core.StreamingOutput	getRecords(String tableName, List<String> columns, String authHeader) Gets all the records.
javax.ws.rs.core.StreamingOutput	getRecords(String tableName, long timeFrom, List<String> columns, String authHeader) Gets the records.
javax.ws.rs.core.StreamingOutput	getRecords(String tableName, long timeFrom, long timeTo, int recordsFrom, int count, List<String> columns, String authHeader) Gets the records.
javax.ws.rs.core.StreamingOutput	getRecords(String tableName, long timeFrom, long timeTo, List<String> columns, int start, String authHeader) Gets the records.
javax.ws.rs.core.StreamingOutput	getRecords(String tableName, long timeFrom, long timeTo, List<String> columns, String authHeader) Gets the records.
javax.ws.rs.core.Response	getRecordStoreByTableName(String tableName, String authHeader) Get the record store which a table belongs to
javax.ws.rs.core.StreamingOutput	getRecordsWithKeyValues(String tableName, ColumnKeyValueBean columnKeyValueBean, String authHeader) Gets the records which match the primary key values batch.
javax.ws.rs.core.Response	getTablePersistName(String tableName, String authHeader) Gets the database persist name for a table
javax.ws.rs.core.Response	getTableSchema(String tableName, String authHeader) Gets the analytics schema of a table
javax.ws.rs.core.Response	listRecordStores(String authHeader) List all the record stores in the system.
javax.ws.rs.core.Response	listTables(String authHeader) List all the tables.
javax.ws.rs.core.Response	options() Implements the OPTIONS HTTP method
javax.ws.rs.core.Response	paginationSupported(String recordStoreName, String authHeader) Check if the given recordstore support pagination
javax.ws.rs.core.Response	reIndex(String tableName, long timeFrom, long timeTo, String authHeader) Re-index the records of a given table between given timestamp range.
javax.ws.rs.core.Response	search(QueryBean queryBean, String authHeader) Search records.
javax.ws.rs.core.Response	searchCount(QueryBean queryBean, String authHeader) Returns the search record count.
javax.ws.rs.core.StreamingOutput	searchWithAggregates(AggregateRequestBean[] aggregateRequestBeans, String authHeader) Returns the aggregated values of the given fields grouped by the given facet field.
javax.ws.rs.core.StreamingOutput	searchWithAggregates(AggregateRequestBean aggregateRequestBean, String authHeader) Returns the aggregated values of the given fields grouped by the given facet field.
javax.ws.rs.core.Response	setTableSchema(String tableName, AnalyticsSchemaBean analyticsSchemaBean, String authHeader) Sets a analytics Schema for a table
javax.ws.rs.core.Response	tableExists(String tableName, String authHeader) Check if the table Exists
javax.ws.rs.core.Response	waitForIndexing(long seconds, String tableName, String authHeader) waits till indexing finishes

Methods inherited from class org.wso2.carbon.analytics.restapi.resources.AbstractResource

handleResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalyticsResource

public AnalyticsResource()

Method Detail

options

public javax.ws.rs.core.Response options()

Implements the OPTIONS HTTP method

Returns:

The response

tableExists

@Path(value="table_exists")
public javax.ws.rs.core.Response tableExists(String tableName,
                                         @HeaderParam(value="Authorization")
                                         String authHeader)
                                      throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Check if the table Exists

Returns:

the response

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

paginationSupported

@Path(value="pagination/{recordStoreName}")
public javax.ws.rs.core.Response paginationSupported(String recordStoreName,
                                                 @HeaderParam(value="Authorization")
                                                 String authHeader)
                                              throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Check if the given recordstore support pagination

Returns:

the response

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

listTables

@Path(value="tables")
public javax.ws.rs.core.Response listTables(@HeaderParam(value="Authorization")
                                        String authHeader)
                                     throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

List all the tables.

Returns:

the response

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

listRecordStores

@Path(value="recordstores")
public javax.ws.rs.core.Response listRecordStores(@HeaderParam(value="Authorization")
                                              String authHeader)
                                           throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

List all the record stores in the system.

Returns:

the response

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

getRecordStoreByTableName

@Path(value="recordstore")
public javax.ws.rs.core.Response getRecordStoreByTableName(String tableName,
                                                       @HeaderParam(value="Authorization")
                                                       String authHeader)
                                                    throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Get the record store which a table belongs to

Returns:

the response

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

getRecordCount

@Path(value="tables/{tableName}/recordcount")
public javax.ws.rs.core.Response getRecordCount(String tableName,
                                            @HeaderParam(value="Authorization")
                                            String authHeader)
                                         throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Gets the record count.

Parameters:

tableName - the table name

Returns:

the record count

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

getRecords

@Path(value="tables/{tableName}/{from}/{to}/{start}/{count}")
public javax.ws.rs.core.StreamingOutput getRecords(String tableName,
                                               long timeFrom,
                                               long timeTo,
                                               int recordsFrom,
                                               int count,
                                               List<String> columns,
                                               @HeaderParam(value="Authorization")
                                               String authHeader)
                                            throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Gets the records.

Parameters:

tableName - the table name

timeFrom - the start time

timeTo - the end time

recordsFrom - the starting record

count - the count

Returns:

the record groups

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

getRecords

@Path(value="tables/{tableName}/{from}/{to}/{start}")
public javax.ws.rs.core.StreamingOutput getRecords(String tableName,
                                               long timeFrom,
                                               long timeTo,
                                               List<String> columns,
                                               int start,
                                               @HeaderParam(value="Authorization")
                                               String authHeader)
                                            throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Gets the records.

Parameters:

tableName - the table name

timeFrom - the time from

timeTo - the time to

Returns:

the records

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

getRecords

@Path(value="tables/{tableName}/{from}/{to}")
public javax.ws.rs.core.StreamingOutput getRecords(String tableName,
                                               long timeFrom,
                                               long timeTo,
                                               List<String> columns,
                                               @HeaderParam(value="Authorization")
                                               String authHeader)
                                            throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Gets the records.

Parameters:

tableName - the table name

timeFrom - the time from

timeTo - the time to

Returns:

the records

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

getRecords

@Path(value="tables/{tableName}/{from}")
public javax.ws.rs.core.StreamingOutput getRecords(String tableName,
                                               long timeFrom,
                                               List<String> columns,
                                               @HeaderParam(value="Authorization")
                                               String authHeader)
                                            throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Gets the records.

Parameters:

tableName - the table name

timeFrom - the time from

Returns:

the records

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

getRecords

@Path(value="tables/{tableName}")
public javax.ws.rs.core.StreamingOutput getRecords(String tableName,
                                               List<String> columns,
                                               @HeaderParam(value="Authorization")
                                               String authHeader)
                                            throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Gets all the records.

Parameters:

tableName - the table name

Returns:

the records

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

getRecordsWithKeyValues

@Path(value="tables/{tableName}/keyed_records")
public javax.ws.rs.core.StreamingOutput getRecordsWithKeyValues(String tableName,
                                                            ColumnKeyValueBean columnKeyValueBean,
                                                            @HeaderParam(value="Authorization")
                                                            String authHeader)
                                                         throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Gets the records which match the primary key values batch.

Parameters:

tableName - the table name

columnKeyValueBean - bean containing the columns and values batch

authHeader - the count

Returns:

the record groups

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

clearIndices

@Path(value="tables/{tableName}/indexData")
public javax.ws.rs.core.Response clearIndices(String tableName,
                                          @HeaderParam(value="Authorization")
                                          String authHeader)
                                       throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Clear indices.

Parameters:

tableName - the table name

Returns:

the response

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

search

@Path(value="search")
public javax.ws.rs.core.Response search(QueryBean queryBean,
                                    @HeaderParam(value="Authorization")
                                    String authHeader)
                                 throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Search records.

Parameters:

queryBean - the query bean

Returns:

the response

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

drillDown

@Path(value="drilldown")
public javax.ws.rs.core.Response drillDown(DrillDownRequestBean requestBean,
                                       @HeaderParam(value="Authorization")
                                       String authHeader)
                                    throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Performs the drilldown operation on a given table.

Parameters:

requestBean - request for drilldown which contains all the details to be drilled down

authHeader - basic authentication header base64 encoded

Returns:

Map containing with each field and respective list of results

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

drillDownCount

@Path(value="drillDownScoreCount")
public javax.ws.rs.core.Response drillDownCount(DrillDownRequestBean requestBean,
                                            @HeaderParam(value="Authorization")
                                            String authHeader)
                                         throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Performs the drilldown operation on a given table.

Parameters:

requestBean - request for drilldown which contains all the details to be drilled down

authHeader - basic authentication header base64 encoded

Returns:

Map containing with each field and respective list of results

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

drillDownRangeCount

@Path(value="rangecount")
public javax.ws.rs.core.Response drillDownRangeCount(DrillDownRequestBean requestBean,
                                                 @HeaderParam(value="Authorization")
                                                 String authHeader)
                                              throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Performs the drilldown operation on a given set of range buckets of a field.

Parameters:

requestBean - request for drilldown which contains all the details to be drilled down

authHeader - basic authentication header base64 encoded

Returns:

List of analyticsDrilldownRange objects with scores not-null

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

drillDownCategories

@Path(value="facets")
public javax.ws.rs.core.Response drillDownCategories(CategoryDrillDownRequestBean requestBean,
                                                 @HeaderParam(value="Authorization")
                                                 String authHeader)
                                              throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Performs the drilldown operation on a given field to get the child categories

Parameters:

requestBean - request for drilldown which contains all the details of the category drilldown

authHeader - basic authentication header base64 encoded

Returns:

List of subcategories

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

searchCount

@Path(value="search_count")
public javax.ws.rs.core.Response searchCount(QueryBean queryBean,
                                         @HeaderParam(value="Authorization")
                                         String authHeader)
                                      throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Returns the search record count.

Parameters:

queryBean - the query bean

Returns:

the Responseresponse

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

waitForIndexing

@Path(value="indexing_done")
public javax.ws.rs.core.Response waitForIndexing(long seconds,
                                             String tableName,
                                             @HeaderParam(value="Authorization")
                                             String authHeader)
                                          throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

waits till indexing finishes

Parameters:

seconds - tthe timeout for waiting till response returns

Returns:

the Responseresponse

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

setTableSchema

@Path(value="tables/{tableName}/schema")
public javax.ws.rs.core.Response setTableSchema(String tableName,
                                            AnalyticsSchemaBean analyticsSchemaBean,
                                            @HeaderParam(value="Authorization")
                                            String authHeader)
                                         throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Sets a analytics Schema for a table

Parameters:

tableName - table Name of which the analytics schema to be set

analyticsSchemaBean - table schema which represents the analytics schema

Returns:

the Response response

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

getTableSchema

@Path(value="tables/{tableName}/schema")
public javax.ws.rs.core.Response getTableSchema(String tableName,
                                            @HeaderParam(value="Authorization")
                                            String authHeader)
                                         throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Gets the analytics schema of a table

Parameters:

tableName - the table name of which the schema to be retrieved

Returns:

Response containing the analytics schema

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

searchWithAggregates

@Path(value="multi_aggregates")
public javax.ws.rs.core.StreamingOutput searchWithAggregates(AggregateRequestBean[] aggregateRequestBeans,
                                                         @HeaderParam(value="Authorization")
                                                         String authHeader)
                                                      throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Returns the aggregated values of the given fields grouped by the given facet field.

Parameters:

aggregateRequestBeans - the aggregate request bean

Returns:

the Responseresponse

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

searchWithAggregates

@Path(value="aggregates")
public javax.ws.rs.core.StreamingOutput searchWithAggregates(AggregateRequestBean aggregateRequestBean,
                                                         @HeaderParam(value="Authorization")
                                                         String authHeader)
                                                      throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Returns the aggregated values of the given fields grouped by the given facet field.

Parameters:

aggregateRequestBean - the aggregate request bean

Returns:

the Responseresponse

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

reIndex

@Path(value="tables/{tableName}")
public javax.ws.rs.core.Response reIndex(String tableName,
                                     long timeFrom,
                                     long timeTo,
                                     @HeaderParam(value="Authorization")
                                     String authHeader)
                                  throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Re-index the records of a given table between given timestamp range.

Parameters:

tableName - the table name

timeFrom - the time from

timeTo - the time to

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

getTablePersistName

@Path(value="tables/{tableName}/persistName")
public javax.ws.rs.core.Response getTablePersistName(String tableName,
                                                 @HeaderParam(value="Authorization")
                                                 String authHeader)
                                              throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Gets the database persist name for a table

Parameters:

tableName - the table name of which the persist name to be retrieved

Returns:

Response containing the table persist name in database

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

clearTableCache

@Path(value="tables/{tableName}/schema-invalidate")
public javax.ws.rs.core.Response clearTableCache(String tableName,
                                             @HeaderParam(value="Authorization")
                                             String authHeader)
                                          throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

To clear table information from in memory cache

Parameters:

tableName - table Name of which that cache going to clear

Returns:

the Response response

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException