net.sparkworks.cargo.client.impl

Class UnitClientImpl

java.lang.Object

net.sparkworks.cargo.client.APIBaseClient

net.sparkworks.cargo.client.impl.UnitClientImpl

All Implemented Interfaces:

UnitClient, net.sparkworks.cargo.common.CargoRoutes

@Component(value="CaRGOUnitClientImplV2")
public class UnitClientImpl
extends APIBaseClient
implements UnitClient

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
UnitClientImpl(org.springframework.web.client.RestOperations restTemplate, CargoClientConfig sparkworksCargoClientConfig, CargoInternalCommunicationConfiguration cargoInternalCommunicationConfiguration)
UnitClientImpl(String apibaseUrl, String accessToken)
UnitClientImpl(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.UnitDTO	create(String name) Create a Unit
void	delete(UUID uuid) Delete a Unit by its UUID
net.sparkworks.cargo.common.dto.UnitDTO	getByUUID(UUID uuid) Get a Unit by its UUID
Collection<net.sparkworks.cargo.common.dto.UnitDTO>	listAll() Retrieve all the Units
net.sparkworks.cargo.common.dto.UnitDTO	query(String name, UUID uuid) Retrieve a Unit by its name or UUID
net.sparkworks.cargo.common.dto.UnitDTO	update(UUID uuid, String name)

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

UnitClientImpl

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

UnitClientImpl

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

UnitClientImpl

public UnitClientImpl(String apibaseUrl,
                      String accessToken)

Method Detail

listAll

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

Description copied from interface: UnitClient

Retrieve all the Units

Specified by:

listAll in interface UnitClient

Returns:

a Collection containing all the UnitDTO.

getByUUID

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

Description copied from interface: UnitClient

Get a Unit by its UUID

Specified by:

getByUUID in interface UnitClient

Parameters:

uuid - the UUID of the Unit to retrieve

Returns:

the UnitDTO found

create

public net.sparkworks.cargo.common.dto.UnitDTO create(String name)

Description copied from interface: UnitClient

Create a Unit

Specified by:

create in interface UnitClient

Parameters:

name - the name of the Unit

Returns:

the new UnitDTO

query

public net.sparkworks.cargo.common.dto.UnitDTO query(String name,
                                                     UUID uuid)

Description copied from interface: UnitClient

Retrieve a Unit by its name or UUID

Specified by:

query in interface UnitClient

Parameters:

name - the name of the Unit

uuid - the UUID of the Unit

Returns:

the UnitDTO found

delete

public void delete(UUID uuid)

Description copied from interface: UnitClient

Delete a Unit by its UUID

Specified by:

delete in interface UnitClient

Parameters:

uuid - the UUID of the Unit to delete

update

public net.sparkworks.cargo.common.dto.UnitDTO update(UUID uuid,
                                                      String name)

Specified by:

update in interface UnitClient