net.sparkworks.cargo.client.impl

Class GatewayClientImpl

java.lang.Object

net.sparkworks.cargo.client.APIBaseClient

net.sparkworks.cargo.client.impl.GatewayClientImpl

All Implemented Interfaces:

GatewayClient, net.sparkworks.cargo.common.CargoRoutes

@Component(value="CaRGOGatewayClientV2")
public class GatewayClientImpl
extends APIBaseClient
implements GatewayClient

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
GatewayClientImpl(org.springframework.web.client.RestOperations restTemplate, CargoClientConfig sparkworksCargoClientConfig, CargoInternalCommunicationConfiguration cargoInternalCommunicationConfiguration)
GatewayClientImpl(String apibaseUrl, String accessToken)
GatewayClientImpl(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 Gateways the user has access to.
net.sparkworks.cargo.common.dto.GatewayDTO	create(String systemName, UUID groupUUID) Create a new Gateway.
void	delete(UUID uuid) Delete a Gateway by its UUID.
net.sparkworks.cargo.common.dto.GatewayDTO	getBySystemName(String systemName) Retrieve a Gateway by its name if the user has access to it.
net.sparkworks.cargo.common.dto.GatewayDTO	getByUUID(UUID uuid) Retrieve a Gateway by its UUID if the user has access to it.
Collection<net.sparkworks.cargo.common.dto.ResourceDTO>	getResources(UUID gatewayUuid) Retrieve the Resources of a Gateway with specific UUID.
Collection<net.sparkworks.cargo.common.dto.GatewayDTO>	listAll() Retrieve a list of all the Gateways the user has access to.

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

GatewayClientImpl

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

GatewayClientImpl

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

GatewayClientImpl

public GatewayClientImpl(String apibaseUrl,
                         String accessToken)

Method Detail

listAll

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

Description copied from interface: GatewayClient

Retrieve a list of all the Gateways the user has access to.

Specified by:

listAll in interface GatewayClient

Returns:

Collection GatewayDTO containst all the Gateways the user has access to.

getByUUID

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

Description copied from interface: GatewayClient

Retrieve a Gateway by its UUID if the user has access to it.

Specified by:

getByUUID in interface GatewayClient

Parameters:

uuid - the UUID of the Gateway to retrieve

Returns:

the GatewayDTO found with the requested UUID

getBySystemName

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

Description copied from interface: GatewayClient

Retrieve a Gateway by its name if the user has access to it.

Specified by:

getBySystemName in interface GatewayClient

Parameters:

systemName - the system name of the Gateway to retrieve

Returns:

the GatewayDTO found with the requested system name

create

public net.sparkworks.cargo.common.dto.GatewayDTO create(String systemName,
                                                         UUID groupUUID)

Description copied from interface: GatewayClient

Create a new Gateway.

Specified by:

create in interface GatewayClient

Parameters:

systemName - the name of the new Gateway

groupUUID - the Group UUID of the Group the Gateway will belong to

Returns:

the new GatewayDTO

count

public Long count()

Description copied from interface: GatewayClient

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

Specified by:

count in interface GatewayClient

Returns:

the number of the Gateways the user has access to

delete

public void delete(UUID uuid)

Description copied from interface: GatewayClient

Delete a Gateway by its UUID.

Specified by:

delete in interface GatewayClient

Parameters:

uuid - the UUID of the Gateway to delete

getResources

public Collection<net.sparkworks.cargo.common.dto.ResourceDTO> getResources(UUID gatewayUuid)

Description copied from interface: GatewayClient

Retrieve the Resources of a Gateway with specific UUID.

Specified by:

getResources in interface GatewayClient

Parameters:

gatewayUuid - the Gateway UUID to retrieve the Resources from

Returns:

a Collection containing the ResourceDTOs of the Gateway