net.sparkworks.cargo.client.impl

Class ResourceClientImpl

java.lang.Object

net.sparkworks.cargo.client.APIBaseClient

net.sparkworks.cargo.client.impl.ResourceClientImpl

All Implemented Interfaces:

ResourceClient, net.sparkworks.cargo.common.CargoRoutes

@Component(value="CaRGOResourceClientV2")
public class ResourceClientImpl
extends APIBaseClient
implements ResourceClient

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
ResourceClientImpl(org.springframework.web.client.RestOperations restTemplate, CargoClientConfig sparkworksCargoClientConfig, CargoInternalCommunicationConfiguration cargoInternalCommunicationConfiguration)
ResourceClientImpl(String apibaseUrl, String accessToken)
ResourceClientImpl(String apiBaseUrl, String clientId, String clientSecret, String username, String password, String oauth2TokenUrl, String oauth2GrantType, String oauth2Scope)

Method Summary

Modifier and Type	Method and Description
Long	count() Retrieve the number of the Resources the user has access to.
net.sparkworks.cargo.common.dto.ResourceDTO	create(String systemName, String userFriendlyName, net.sparkworks.cargo.common.enumerator.ResourceType type, String phenomenon, String unit, String controls, UUID groupUUID) Create a new Resource.
void	delete(UUID uuid) Delete a Resource by its UUID.
net.sparkworks.cargo.common.dto.ResourceDTO	getBySystemName(String systemName) Retrieve a Resource by its name
net.sparkworks.cargo.common.dto.ResourceDTO	getByUUID(UUID uuid) Retrieve a Resource by its UUID
Collection<net.sparkworks.cargo.common.dto.ResourceDTO>	listAll() Retrieve all the Resources the user has access to.
net.sparkworks.cargo.common.dto.ResourceDTO	move(UUID resourceUuid, UUID targetGroupUuid) Move a Resource to a Group
net.sparkworks.cargo.common.dto.ResourceDTO	update(UUID uuid, String userFriendlyName, net.sparkworks.cargo.common.enumerator.ResourceType type, String controls, UUID phenomenonUuid, UUID unitUuid)

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

ResourceClientImpl

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

ResourceClientImpl

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

ResourceClientImpl

public ResourceClientImpl(String apibaseUrl,
                          String accessToken)

Method Detail

listAll

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

Description copied from interface: ResourceClient

Retrieve all the Resources the user has access to.

Specified by:

listAll in interface ResourceClient

Returns:

a Collection containing all the ResourceDTO the user has access to.

create

public net.sparkworks.cargo.common.dto.ResourceDTO create(String systemName,
                                                          String userFriendlyName,
                                                          net.sparkworks.cargo.common.enumerator.ResourceType type,
                                                          String phenomenon,
                                                          String unit,
                                                          String controls,
                                                          UUID groupUUID)

Description copied from interface: ResourceClient

Create a new Resource.

Specified by:

create in interface ResourceClient

Parameters:

systemName - the uri of the new Resource

userFriendlyName - the user friendly name of the Resource

type - Sensor/Actuator

phenomenon - the phenomenon name of the Resource observes

unit - the unit of measurement the Resource

controls - // TODO: 3/12/2018 add description to controls

groupUUID - the UUID of the Group the new Resource will belong to

Returns:

the new ResourceDTO

getByUUID

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

Description copied from interface: ResourceClient

Retrieve a Resource by its UUID

Specified by:

getByUUID in interface ResourceClient

Parameters:

uuid - the UUID of the Resource to retrieve

Returns:

the ResourceDTO found

getBySystemName

public net.sparkworks.cargo.common.dto.ResourceDTO getBySystemName(String systemName)

Description copied from interface: ResourceClient

Retrieve a Resource by its name

Specified by:

getBySystemName in interface ResourceClient

Parameters:

systemName - the system name of the Resource to retrieve

Returns:

the ResourceDTO found

count

public Long count()

Description copied from interface: ResourceClient

Retrieve the number of the Resources the user has access to.

Specified by:

count in interface ResourceClient

Returns:

the number of the Resources the user has access to

delete

public void delete(UUID uuid)

Description copied from interface: ResourceClient

Delete a Resource by its UUID.

Specified by:

delete in interface ResourceClient

Parameters:

uuid - the UUID of the Resource to delete

move

public net.sparkworks.cargo.common.dto.ResourceDTO move(UUID resourceUuid,
                                                        UUID targetGroupUuid)

Description copied from interface: ResourceClient

Move a Resource to a Group

Specified by:

move in interface ResourceClient

Parameters:

resourceUuid - the Resource UUID

targetGroupUuid - the Group UUID

Returns:

the updated ResourceDTO

update

public net.sparkworks.cargo.common.dto.ResourceDTO update(UUID uuid,
                                                          String userFriendlyName,
                                                          net.sparkworks.cargo.common.enumerator.ResourceType type,
                                                          String controls,
                                                          UUID phenomenonUuid,
                                                          UUID unitUuid)

Specified by:

update in interface ResourceClient