net.sparkworks.cargo.client

Interface GatewayClient

All Known Implementing Classes:

GatewayClientImpl

public interface GatewayClient

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.

Method Detail

listAll

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

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

Returns:

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

getByUUID

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

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

Parameters:

uuid - the UUID of the Gateway to retrieve

Returns:

the GatewayDTO found with the requested UUID

getBySystemName

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

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

Parameters:

systemName - the system name of the Gateway to retrieve

Returns:

the GatewayDTO found with the requested system name

create

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

Create a new Gateway.

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

Long count()

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

Returns:

the number of the Gateways the user has access to

delete

void delete(UUID uuid)

Delete a Gateway by its UUID.

Parameters:

uuid - the UUID of the Gateway to delete

getResources

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

Retrieve the Resources of a Gateway with specific UUID.

Parameters:

gatewayUuid - the Gateway UUID to retrieve the Resources from

Returns:

a Collection containing the ResourceDTOs of the Gateway