org.wso2.carbon.analytics.api.internal.client

Class AnalyticsAPIHttpClient

java.lang.Object

org.wso2.carbon.analytics.api.internal.client.AnalyticsAPIHttpClient

public class AnalyticsAPIHttpClient
extends Object

This class represents the client implementation which uses the pool of http connection, and communicate between the remote instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	authenticate(String username, String password)
void	clearIndices(int tenantId, String username, String tableName, boolean securityEnabled)
void	createTable(int tenantId, String username, String recordStoreName, String tableName, boolean securityEnabled, boolean ifNotExists)
void	deleteRecords(int tenantId, String username, String tableName, List<String> recordIds, boolean securityEnabled)
void	deleteRecords(int tenantId, String username, String tableName, long timeFrom, long timeTo, boolean securityEnabled)
void	deleteTable(int tenantId, String username, String tableName, boolean securityEnabled)
void	destroy()
org.wso2.carbon.analytics.dataservice.commons.SubCategories	drillDownCategories(int tenantId, String username, org.wso2.carbon.analytics.dataservice.commons.CategoryDrillDownRequest drillDownRequest, boolean securityEnabled)
List<org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRange>	drillDownRangeCount(int tenantId, String username, org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRequest drillDownRequest, boolean securityEnabled)
List<org.wso2.carbon.analytics.dataservice.commons.SearchResultEntry>	drillDownSearch(int tenantId, String username, org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRequest drillDownRequest, boolean securityEnabled)
double	drillDownSearchCount(int tenantId, String username, org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRequest drillDownRequest, boolean securityEnabled)
static AnalyticsAPIHttpClient	getInstance()
long	getRecordCount(int tenantId, String username, String tableName, long timeFrom, long timeTo, boolean securityEnabled)
org.wso2.carbon.analytics.dataservice.commons.AnalyticsDataResponse	getRecordGroup(int tenantId, String username, String tableName, int numPartitionsHint, List<String> columns, List<String> ids, boolean securityEnabled)
org.wso2.carbon.analytics.dataservice.commons.AnalyticsDataResponse	getRecordGroup(int tenantId, String username, String tableName, int numPartitionsHint, List<String> columns, long timeFrom, long timeTo, int recordsFrom, int recordsCount, boolean securityEnabled)
String	getRecordStoreNameByTable(int tenantId, String username, String tableName, boolean securityEnabled)
org.wso2.carbon.analytics.datasource.commons.AnalyticsSchema	getTableSchema(int tenantId, String username, String tableName, boolean securityEnabled)
org.wso2.carbon.analytics.dataservice.commons.AnalyticsDataResponse	getWithKeyValues(int tenantId, String username, String tableName, int numPartitionsHint, List<String> columns, List<Map<String,Object>> valuesBatch, boolean securityEnabled)
static void	init(AnalyticsDataConfiguration dataConfiguration)
void	invalidateSessionAndAuthenticate(String userName, String password)
boolean	isPaginationSupported(String recordStoreName)
boolean	isRecordCountSupported(String recordStoreName)
boolean	isTableExists(int tenantId, String username, String tableName, boolean securityEnabled)
List<String>	listRecordStoreNames()
List<String>	listTables(int tenantId, String username, boolean securityEnabled)
void	putRecords(String username, List<org.wso2.carbon.analytics.datasource.commons.Record> records, boolean securityEnabled)
org.wso2.carbon.analytics.datasource.commons.AnalyticsIterator<org.wso2.carbon.analytics.datasource.commons.Record>	readRecords(String recordStoreName, org.wso2.carbon.analytics.datasource.commons.RecordGroup recordGroup)
void	reIndex(int tenantId, String username, String tableName, long startTime, long endTime, boolean securityEnabled)
List<org.wso2.carbon.analytics.dataservice.commons.SearchResultEntry>	search(int tenantId, String username, String tableName, String query, int start, int count, List<org.wso2.carbon.analytics.dataservice.commons.SortByField> sortByFields, boolean securityEnabled)
int	searchCount(int tenantId, String username, String tableName, String query, boolean securityEnabled)
List<org.wso2.carbon.analytics.datasource.commons.AnalyticsIterator<org.wso2.carbon.analytics.datasource.commons.Record>>	searchWithAggregates(int tenantId, String username, org.wso2.carbon.analytics.dataservice.commons.AggregateRequest[] aggregateRequests, boolean securityEnabled)
org.wso2.carbon.analytics.datasource.commons.AnalyticsIterator<org.wso2.carbon.analytics.datasource.commons.Record>	searchWithAggregates(int tenantId, String username, org.wso2.carbon.analytics.dataservice.commons.AggregateRequest aggregateRequest, boolean securityEnabled)
void	setTableSchema(int tenantId, String username, String tableName, org.wso2.carbon.analytics.datasource.commons.AnalyticsSchema schema, boolean securityEnabled)
void	validateAndAuthenticate(String username, String password)
void	waitForIndexing(int tenantId, String username, String tableName, long maxWait, boolean securityEnabled)

Methods inherited from class java.lang.Object

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

Method Detail

init

public static void init(AnalyticsDataConfiguration dataConfiguration)
                 throws AnalyticsServiceException

Throws:

AnalyticsServiceException

getInstance

public static AnalyticsAPIHttpClient getInstance()

authenticate

public void authenticate(String username,
                String password)
                  throws AnalyticsServiceException

Throws:

AnalyticsServiceException

validateAndAuthenticate

public void validateAndAuthenticate(String username,
                           String password)
                             throws AnalyticsServiceException

Throws:

AnalyticsServiceException

invalidateSessionAndAuthenticate

public void invalidateSessionAndAuthenticate(String userName,
                                    String password)

createTable

public void createTable(int tenantId,
               String username,
               String recordStoreName,
               String tableName,
               boolean securityEnabled,
               boolean ifNotExists)
                 throws AnalyticsServiceException,
                        AnalyticsServiceUnauthorizedException

Throws:

AnalyticsServiceException

AnalyticsServiceUnauthorizedException

setTableSchema

public void setTableSchema(int tenantId,
                  String username,
                  String tableName,
                  org.wso2.carbon.analytics.datasource.commons.AnalyticsSchema schema,
                  boolean securityEnabled)
                    throws AnalyticsServiceException

Throws:

AnalyticsServiceException

getTableSchema

public org.wso2.carbon.analytics.datasource.commons.AnalyticsSchema getTableSchema(int tenantId,
                                                                          String username,
                                                                          String tableName,
                                                                          boolean securityEnabled)
                                                                            throws AnalyticsServiceException

Throws:

AnalyticsServiceException

isTableExists

public boolean isTableExists(int tenantId,
                    String username,
                    String tableName,
                    boolean securityEnabled)
                      throws AnalyticsServiceException

Throws:

AnalyticsServiceException

listTables

public List<String> listTables(int tenantId,
                      String username,
                      boolean securityEnabled)
                        throws AnalyticsServiceException

Throws:

AnalyticsServiceException

deleteTable

public void deleteTable(int tenantId,
               String username,
               String tableName,
               boolean securityEnabled)
                 throws AnalyticsServiceException

Throws:

AnalyticsServiceException

getRecordCount

public long getRecordCount(int tenantId,
                  String username,
                  String tableName,
                  long timeFrom,
                  long timeTo,
                  boolean securityEnabled)
                    throws AnalyticsServiceException

Throws:

AnalyticsServiceException

putRecords

public void putRecords(String username,
              List<org.wso2.carbon.analytics.datasource.commons.Record> records,
              boolean securityEnabled)
                throws AnalyticsServiceException

Throws:

AnalyticsServiceException

deleteRecords

public void deleteRecords(int tenantId,
                 String username,
                 String tableName,
                 long timeFrom,
                 long timeTo,
                 boolean securityEnabled)
                   throws AnalyticsServiceException

Throws:

AnalyticsServiceException

deleteRecords

public void deleteRecords(int tenantId,
                 String username,
                 String tableName,
                 List<String> recordIds,
                 boolean securityEnabled)
                   throws AnalyticsServiceException

Throws:

AnalyticsServiceException

clearIndices

public void clearIndices(int tenantId,
                String username,
                String tableName,
                boolean securityEnabled)
                  throws AnalyticsServiceException

Throws:

AnalyticsServiceException

search

public List<org.wso2.carbon.analytics.dataservice.commons.SearchResultEntry> search(int tenantId,
                                                                           String username,
                                                                           String tableName,
                                                                           String query,
                                                                           int start,
                                                                           int count,
                                                                           List<org.wso2.carbon.analytics.dataservice.commons.SortByField> sortByFields,
                                                                           boolean securityEnabled)
                                                                             throws AnalyticsServiceException

Throws:

AnalyticsServiceException

searchCount

public int searchCount(int tenantId,
              String username,
              String tableName,
              String query,
              boolean securityEnabled)
                throws AnalyticsServiceException

Throws:

AnalyticsServiceException

waitForIndexing

public void waitForIndexing(int tenantId,
                   String username,
                   String tableName,
                   long maxWait,
                   boolean securityEnabled)
                     throws AnalyticsServiceException

Throws:

AnalyticsServiceException

destroy

public void destroy()
             throws AnalyticsServiceException

Throws:

AnalyticsServiceException

getRecordGroup

public org.wso2.carbon.analytics.dataservice.commons.AnalyticsDataResponse getRecordGroup(int tenantId,
                                                                                 String username,
                                                                                 String tableName,
                                                                                 int numPartitionsHint,
                                                                                 List<String> columns,
                                                                                 long timeFrom,
                                                                                 long timeTo,
                                                                                 int recordsFrom,
                                                                                 int recordsCount,
                                                                                 boolean securityEnabled)
                                                                                   throws AnalyticsServiceException

Throws:

AnalyticsServiceException

getWithKeyValues

public org.wso2.carbon.analytics.dataservice.commons.AnalyticsDataResponse getWithKeyValues(int tenantId,
                                                                                   String username,
                                                                                   String tableName,
                                                                                   int numPartitionsHint,
                                                                                   List<String> columns,
                                                                                   List<Map<String,Object>> valuesBatch,
                                                                                   boolean securityEnabled)
                                                                                     throws AnalyticsServiceException

Throws:

AnalyticsServiceException

getRecordStoreNameByTable

public String getRecordStoreNameByTable(int tenantId,
                               String username,
                               String tableName,
                               boolean securityEnabled)

listRecordStoreNames

public List<String> listRecordStoreNames()

getRecordGroup

public org.wso2.carbon.analytics.dataservice.commons.AnalyticsDataResponse getRecordGroup(int tenantId,
                                                                                 String username,
                                                                                 String tableName,
                                                                                 int numPartitionsHint,
                                                                                 List<String> columns,
                                                                                 List<String> ids,
                                                                                 boolean securityEnabled)
                                                                                   throws AnalyticsServiceException

Throws:

AnalyticsServiceException

readRecords

public org.wso2.carbon.analytics.datasource.commons.AnalyticsIterator<org.wso2.carbon.analytics.datasource.commons.Record> readRecords(String recordStoreName,
                                                                                                                              org.wso2.carbon.analytics.datasource.commons.RecordGroup recordGroup)
                                                                                                                                throws AnalyticsServiceException

Throws:

AnalyticsServiceException

isPaginationSupported

public boolean isPaginationSupported(String recordStoreName)

isRecordCountSupported

public boolean isRecordCountSupported(String recordStoreName)

drillDownSearch

public List<org.wso2.carbon.analytics.dataservice.commons.SearchResultEntry> drillDownSearch(int tenantId,
                                                                                    String username,
                                                                                    org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRequest drillDownRequest,
                                                                                    boolean securityEnabled)

drillDownSearchCount

public double drillDownSearchCount(int tenantId,
                          String username,
                          org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRequest drillDownRequest,
                          boolean securityEnabled)

drillDownCategories

public org.wso2.carbon.analytics.dataservice.commons.SubCategories drillDownCategories(int tenantId,
                                                                              String username,
                                                                              org.wso2.carbon.analytics.dataservice.commons.CategoryDrillDownRequest drillDownRequest,
                                                                              boolean securityEnabled)

drillDownRangeCount

public List<org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRange> drillDownRangeCount(int tenantId,
                                                                                              String username,
                                                                                              org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRequest drillDownRequest,
                                                                                              boolean securityEnabled)

searchWithAggregates

public org.wso2.carbon.analytics.datasource.commons.AnalyticsIterator<org.wso2.carbon.analytics.datasource.commons.Record> searchWithAggregates(int tenantId,
                                                                                                                                       String username,
                                                                                                                                       org.wso2.carbon.analytics.dataservice.commons.AggregateRequest aggregateRequest,
                                                                                                                                       boolean securityEnabled)

searchWithAggregates

public List<org.wso2.carbon.analytics.datasource.commons.AnalyticsIterator<org.wso2.carbon.analytics.datasource.commons.Record>> searchWithAggregates(int tenantId,
                                                                                                                                             String username,
                                                                                                                                             org.wso2.carbon.analytics.dataservice.commons.AggregateRequest[] aggregateRequests,
                                                                                                                                             boolean securityEnabled)

reIndex

public void reIndex(int tenantId,
           String username,
           String tableName,
           long startTime,
           long endTime,
           boolean securityEnabled)