net.sparkworks.cargo.client.impl

Class UnitConversionClientImpl

java.lang.Object

net.sparkworks.cargo.client.APIBaseClient

net.sparkworks.cargo.client.impl.UnitConversionClientImpl

All Implemented Interfaces:

UnitConversionClient, net.sparkworks.cargo.common.CargoRoutes

@Component(value="CaRGOUnitConversionClientImplV2")
public class UnitConversionClientImpl
extends APIBaseClient
implements UnitConversionClient

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
UnitConversionClientImpl(org.springframework.web.client.RestOperations restTemplate, CargoClientConfig sparkworksCargoClientConfig, CargoInternalCommunicationConfiguration cargoInternalCommunicationConfiguration)
UnitConversionClientImpl(String apibaseUrl, String accessToken)
UnitConversionClientImpl(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.UnitConversionDTO	create(UUID sourceUuid, UUID targetUuid, String method) Create a UnitConversion
void	delete(UUID uuid) Delete a UnitConversion by its UUID
net.sparkworks.cargo.common.dto.UnitConversionDTO	getByUUID(UUID uuid) Get a UnitConversion by its UUID
Collection<net.sparkworks.cargo.common.dto.UnitConversionDTO>	listAll() Retrieve all the UnitConversions
Collection<net.sparkworks.cargo.common.dto.UnitConversionDTO>	query(UUID sourceUuid, UUID targetUuid, UUID uuid) Retrieve a Collection of UnitConversion by source Unit UUID, target Unit UUID and UnitConversion UUID The query will try to find conversions with the following priority: 1) find UnitConversion that has source with sourceUuid and target with targetUuid 2) find UnitConversions that has source with sourceUuid 3) find UnitConversions that has target with targetUuid 4) find UnitConversion with uuid If no conversion is found then UnitConversionNotFoundException is thrown

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

UnitConversionClientImpl

@Autowired
public UnitConversionClientImpl(@Qualifier(value="cargoRestTemplate")
                                           org.springframework.web.client.RestOperations restTemplate,
                                           CargoClientConfig sparkworksCargoClientConfig,
                                           CargoInternalCommunicationConfiguration cargoInternalCommunicationConfiguration)

UnitConversionClientImpl

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

UnitConversionClientImpl

public UnitConversionClientImpl(String apibaseUrl,
                                String accessToken)

Method Detail

listAll

public Collection<net.sparkworks.cargo.common.dto.UnitConversionDTO> listAll()

Description copied from interface: UnitConversionClient

Retrieve all the UnitConversions

Specified by:

listAll in interface UnitConversionClient

Returns:

a Collection containing all the UnitConversionDTO.

getByUUID

public net.sparkworks.cargo.common.dto.UnitConversionDTO getByUUID(UUID uuid)

Description copied from interface: UnitConversionClient

Get a UnitConversion by its UUID

Specified by:

getByUUID in interface UnitConversionClient

Parameters:

uuid - the UUID of the UnitConversion to retrieve

Returns:

the UnitConversionDTO found

create

public net.sparkworks.cargo.common.dto.UnitConversionDTO create(UUID sourceUuid,
                                                                UUID targetUuid,
                                                                String method)

Description copied from interface: UnitConversionClient

Create a UnitConversion

Specified by:

create in interface UnitConversionClient

Parameters:

sourceUuid - the UUID of the source Unit

targetUuid - the UUID of the target Unit

method - the method applied for the conversion

Returns:

the new UnitConversionDTO

query

public Collection<net.sparkworks.cargo.common.dto.UnitConversionDTO> query(UUID sourceUuid,
                                                                           UUID targetUuid,
                                                                           UUID uuid)

Description copied from interface: UnitConversionClient

Retrieve a Collection of UnitConversion by source Unit UUID, target Unit UUID and UnitConversion UUID The query will try to find conversions with the following priority: 1) find UnitConversion that has source with sourceUuid and target with targetUuid 2) find UnitConversions that has source with sourceUuid 3) find UnitConversions that has target with targetUuid 4) find UnitConversion with uuid If no conversion is found then UnitConversionNotFoundException is thrown

Specified by:

query in interface UnitConversionClient

Parameters:

sourceUuid - the UUID of the source Unit

targetUuid - the UUID of the target Unit

uuid - the UUID of the UnitConversion to retrieve

Returns:

a Collection of UnitConversionDTO that contains all the Unit Conversions found

delete

public void delete(UUID uuid)

Description copied from interface: UnitConversionClient

Delete a UnitConversion by its UUID

Specified by:

delete in interface UnitConversionClient

Parameters:

uuid - the UUID of the UnitConversion to delete