net.sparkworks.cargo.client.impl

Class DataClientImpl

java.lang.Object

net.sparkworks.cargo.client.APIBaseClient

net.sparkworks.cargo.client.impl.DataClientImpl

All Implemented Interfaces:

DataClient, net.sparkworks.cargo.common.CargoRoutes

@Component(value="CaRGODataClientV2")
public class DataClientImpl
extends APIBaseClient
implements DataClient

Field Summary

Fields inherited from class net.sparkworks.cargo.client.APIBaseClient

apiBaseUrl, AUTH_BEARER_PREFIX, AUTHORIZATION_HEADER, restTemplate

Fields inherited from interface net.sparkworks.cargo.common.CargoRoutes

API_V1, API_V2, COMMAND, COMMAND_BY_UUID, CONVERSION, CONVERSION_BY_QUERY, CONVERSION_BY_UUID, COPY, COUNT, DEPTH, DEPTH_PATH, GATEWAY, GATEWAY_BY_QUERY, GATEWAY_BY_UUID, GATEWAY_COUNT, GATEWAY_RESOURCE, GROUP, GROUP_BY_UUID, GROUP_COUNT, GROUP_GATEWAY, GROUP_MAIN, GROUP_MOVE, GROUP_RESOURCES, GROUP_SUBGROUPS, GROUP_TREE, INTERNAL_PATH, MOVE, MOVE_RESOURCE_BY_UUID, PATH_LEVEL, PHENOMENON, PHENOMENON_BY_QUERY, PHENOMENON_BY_UUID, QUERY, RESOURCE, RESOURCE_BY_ID, RESOURCE_BY_QUERY, RESOURCE_BY_UUID, RESOURCE_COUNT, RESOURCE_DATA_PUBLISH, RESOURCE_ID, RESOURCE_LATEST, RESOURCE_LATEST_BY_UUID, RESOURCE_LATEST_UOM, RESOURCE_QUERY_LATEST, RESOURCE_QUERY_SUMMARY, RESOURCE_QUERY_TIMERANGE, RESOURCE_SUMMARY, RESOURCE_SUMMARY_BY_UUID, RESOURCE_SUMMARY_UOM, SOURCE, SOURCE_UUID, SUBGROUP, TARGET, TARGET_UOM, TARGET_UUID, UNIT, UNIT_BY_QUERY, UNIT_BY_UUID, UUID, UUID_PATH

Constructor Summary

Constructors

Constructor and Description
DataClientImpl(org.springframework.web.client.RestOperations restTemplate, CargoClientConfig sparkworksClientConfig, CargoInternalCommunicationConfiguration internalCommunicationConfiguration)
DataClientImpl(String apibaseUrl, String accessToken)
DataClientImpl(String apiBaseUrl, String clientId, String clientSecret, String username, String password, String oauth2TokenUrl, String oauth2GrantType, String oauth2Scope)

Method Summary

Modifier and Type	Method and Description
net.sparkworks.cargo.common.dto.data.SummaryDTO	getLatestSummary(UUID resourceUuid) Retrieve latest summary values of a Resource Retrieve a summary of the data for a specific Resource by its resource ID.
net.sparkworks.cargo.common.dto.data.LatestDTO	getLatestValues(UUID resourceUuid) Retrieve latest values of a Resource Retrieve the latest aggregated values for a specific Resource by its resource ID The response contains the latest aggregated values for intervals of 5 minutes, 1 hour, 1 day and 1 month.
net.sparkworks.cargo.common.dto.data.PublishDataListDTO	publishData(net.sparkworks.cargo.common.dto.data.PublishDataListDTO publishDataListDTO) Publish data to the provided Resource.
net.sparkworks.cargo.common.dto.data.QueryLatestResourceDataResultDTO	queryLatestResourcesData(net.sparkworks.cargo.common.dto.data.QueryLatestResourceDataDTO queryLatestResourceDataDTO) Retrieve latest values of criteria matching Resources Query the latest aggregated values for multiple Resources.
net.sparkworks.cargo.common.dto.data.QueryTimeRangeResourceDataResultDTO	queryTimeRangeResourcesData(net.sparkworks.cargo.common.dto.data.QueryTimeRangeResourceDataDTO queryTimeRangeResourceDataDTO) Retrieve latest values of criteria matching Resources within a requested time window Query the aggregated historical values for multiple Resources within a requested time window.

Methods inherited from class net.sparkworks.cargo.client.APIBaseClient

prepareHeaders

Methods inherited from class java.lang.Object

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

Constructor Detail

DataClientImpl

@Autowired
public DataClientImpl(@Qualifier(value="cargoRestTemplate")
                                 org.springframework.web.client.RestOperations restTemplate,
                                 CargoClientConfig sparkworksClientConfig,
                                 CargoInternalCommunicationConfiguration internalCommunicationConfiguration)

DataClientImpl

public DataClientImpl(String apiBaseUrl,
                      String clientId,
                      String clientSecret,
                      String username,
                      String password,
                      String oauth2TokenUrl,
                      String oauth2GrantType,
                      String oauth2Scope)

DataClientImpl

public DataClientImpl(String apibaseUrl,
                      String accessToken)

Method Detail

getLatestSummary

public net.sparkworks.cargo.common.dto.data.SummaryDTO getLatestSummary(UUID resourceUuid)

Description copied from interface: DataClient

Retrieve latest summary values of a Resource Retrieve a summary of the data for a specific Resource by its resource ID. The summary contains the 42 latest aggregated values for intervals of 5 minutes, 1 hour, 1 day and 1 month. A Spark Works Accounts authenticated common user is able to query Resources that has permissions on. An administrator is able to query any Resource of the Platform

Specified by:

getLatestSummary in interface DataClient

Parameters:

resourceUuid - the Resource UUID

Returns:

SummaryDTO containing the latest summary values

getLatestValues

public net.sparkworks.cargo.common.dto.data.LatestDTO getLatestValues(UUID resourceUuid)

Description copied from interface: DataClient

Retrieve latest values of a Resource Retrieve the latest aggregated values for a specific Resource by its resource ID The response contains the latest aggregated values for intervals of 5 minutes, 1 hour, 1 day and 1 month. A Spark Works Accounts authenticated common user is able to query Resources that has permissions on. An administrator is able to query any Resource of the Platform

Specified by:

getLatestValues in interface DataClient

Parameters:

resourceUuid - the Resource UUID

Returns:

LatestDTO containing latest values

queryLatestResourcesData

public net.sparkworks.cargo.common.dto.data.QueryLatestResourceDataResultDTO queryLatestResourcesData(net.sparkworks.cargo.common.dto.data.QueryLatestResourceDataDTO queryLatestResourceDataDTO)

Description copied from interface: DataClient

Retrieve latest values of criteria matching Resources Query the latest aggregated values for multiple Resources. The values can be converted to a requested unit of measurement. The response contains the latest aggregated values for intervals of 5 minutes, 1 hour, 1 day and 1 month. A Spark Works Accounts authenticated common user is able to query Resources that has permissions on. An administrator is able to query any Resource of the Platform

Specified by:

queryLatestResourcesData in interface DataClient

Parameters:

queryLatestResourceDataDTO - contains a list of query criteria QueryResourceDataCriteriaDTO

Returns:

QueryLatestResourceDataResultDTO that contains a Map that holds the requested data response for each query criteria

queryTimeRangeResourcesData

public net.sparkworks.cargo.common.dto.data.QueryTimeRangeResourceDataResultDTO queryTimeRangeResourcesData(net.sparkworks.cargo.common.dto.data.QueryTimeRangeResourceDataDTO queryTimeRangeResourceDataDTO)

Description copied from interface: DataClient

Retrieve latest values of criteria matching Resources within a requested time window Query the aggregated historical values for multiple Resources within a requested time window. The values can be retrieved in intervals of 5minutes, 1 hour, 1 day, 1 month and can be converted to a requested unit of measurement. A Spark Works Accounts authenticated common user is able to query Resources that has permissions on. An administrator is able to query any Resource of the Platform

Specified by:

queryTimeRangeResourcesData in interface DataClient

Parameters:

queryTimeRangeResourceDataDTO - cointains a list of query criteria for time range requests

Returns:

QueryTimeRangeResourceDataResultDTO that contains a Map that holds the requested data response for each query criteria

publishData

public net.sparkworks.cargo.common.dto.data.PublishDataListDTO publishData(net.sparkworks.cargo.common.dto.data.PublishDataListDTO publishDataListDTO)

Description copied from interface: DataClient

Publish data to the provided Resource.

Specified by:

publishData in interface DataClient

Parameters:

publishDataListDTO - PublishDataListDTO that holds the info of the resources and the data to publish on these resource

Returns:

PublishDataListDTO the list of the published data