net.sparkworks.cargo.client.impl

Class GroupClientImpl

java.lang.Object

net.sparkworks.cargo.client.APIBaseClient

net.sparkworks.cargo.client.impl.GroupClientImpl

All Implemented Interfaces:

GroupClient, net.sparkworks.cargo.common.CargoRoutes

@Component(value="CaRGOGroupClientImplV2")
public class GroupClientImpl
extends APIBaseClient
implements GroupClient

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
GroupClientImpl(org.springframework.web.client.RestOperations restTemplate, CargoClientConfig sparkworksCargoClientConfig, CargoInternalCommunicationConfiguration cargoInternalCommunicationConfiguration)
GroupClientImpl(String apibaseUrl, String accessToken)
GroupClientImpl(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 Groups the user has access to.
net.sparkworks.cargo.common.dto.GroupDTO	create(String name, String path) Create a new Group.
void	delete(UUID uuid) Delete a Group by its UUID.
net.sparkworks.cargo.common.dto.GroupDTO	getByUUID(UUID uuid) Retrieve a Group by its UUID if the user has access to it.
Collection<net.sparkworks.cargo.common.dto.GatewayDTO>	getGroupGateways(UUID uuid) Retrieve the Gateways that belong to a specific Group
Collection<net.sparkworks.cargo.common.dto.ResourceDTO>	getGroupResources(UUID uuid) Retrieve the Resources of a Group with specific UUID.
net.sparkworks.cargo.common.dto.GroupNodeDTO	getGroupsTree() Retrieve the Tree structure of the Groups starting from the Root
Collection<net.sparkworks.cargo.common.dto.GroupDTO>	getRootGroups() Retrieve the Main Groups of the current User
Collection<net.sparkworks.cargo.common.dto.GroupDTO>	getSubGroups(UUID uuid, int depth) Retrieve the SubGroups of a specific Group in certain depth.
Collection<net.sparkworks.cargo.common.dto.GroupDTO>	listAll() Retrieve a list of all the Groups the user has access to.
void	move(UUID sourceUUID, UUID targetUUID) Move a Group under another Group.
net.sparkworks.cargo.common.dto.GroupDTO	update(UUID uuid, String name) Update a Group by its UUID

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

GroupClientImpl

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

GroupClientImpl

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

GroupClientImpl

public GroupClientImpl(String apibaseUrl,
                       String accessToken)

Method Detail

listAll

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

Description copied from interface: GroupClient

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

Specified by:

listAll in interface GroupClient

Returns:

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

create

public net.sparkworks.cargo.common.dto.GroupDTO create(String name,
                                                       String path)

Description copied from interface: GroupClient

Create a new Group.

Specified by:

create in interface GroupClient

Parameters:

name - the name of the new Group

path - the path of the Parent Group

Returns:

the new GroupDTO

getByUUID

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

Description copied from interface: GroupClient

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

Specified by:

getByUUID in interface GroupClient

Parameters:

uuid - the UUID of the Group to retrieve

Returns:

the GroupDTO found by the UUID

count

public Long count()

Description copied from interface: GroupClient

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

Specified by:

count in interface GroupClient

Returns:

the number of the Groups the user has access to

delete

public void delete(UUID uuid)

Description copied from interface: GroupClient

Delete a Group by its UUID.

Specified by:

delete in interface GroupClient

Parameters:

uuid - the UUID of the Group to delete

move

public void move(UUID sourceUUID,
                 UUID targetUUID)

Description copied from interface: GroupClient

Move a Group under another Group. e.g. (using invalid UUID just for the purpose of readability in the example) GroupA = {uuid=111, path=ROOT.PATH.TO.GROUPA} GroupB = {uuid=333, path=ROOT.PATH.TO.ANOTHER.GROUPB} GroupC = {uuid=555, path=ROOT.PATH.TO.GROUPA.GROUPC} After executing move(111, 333) the Groups data will be like: GroupA = {uuid=111, path=ROOT.PATH.TO.ANOTHER.GROUPB.GROUPA} GroupB = {uuid=333, path=ROOT.PATH.TO.ANOTHER.GROUPB} GroupC = {uuid=555, path=ROOT.PATH.TO.ANOTHER.GROUPB.GROUPA.GROUPC}

Specified by:

move in interface GroupClient

Parameters:

sourceUUID - the UUID of the Group to be moved

targetUUID - the UUID of the target Group

getGroupResources

public Collection<net.sparkworks.cargo.common.dto.ResourceDTO> getGroupResources(UUID uuid)

Description copied from interface: GroupClient

Retrieve the Resources of a Group with specific UUID.

Specified by:

getGroupResources in interface GroupClient

Parameters:

uuid - the the UUID of the Group to get the Resources from

Returns:

a Collection of ResourceDTOs that belong to the Group

getSubGroups

public Collection<net.sparkworks.cargo.common.dto.GroupDTO> getSubGroups(UUID uuid,
                                                                         int depth)

Description copied from interface: GroupClient

Retrieve the SubGroups of a specific Group in certain depth.

Specified by:

getSubGroups in interface GroupClient

Parameters:

uuid - the UUID of the Group to get the SubGroups from

depth - the depth of the SubGroups

Returns:

a Collection of GroupDTO containing the SubGroups of the Group

getGroupGateways

public Collection<net.sparkworks.cargo.common.dto.GatewayDTO> getGroupGateways(UUID uuid)

Description copied from interface: GroupClient

Retrieve the Gateways that belong to a specific Group

Specified by:

getGroupGateways in interface GroupClient

Parameters:

uuid - the UUID of the Group

Returns:

a Collection of GatewayDTO that belong to the Group

getRootGroups

public Collection<net.sparkworks.cargo.common.dto.GroupDTO> getRootGroups()

Description copied from interface: GroupClient

Retrieve the Main Groups of the current User

Specified by:

getRootGroups in interface GroupClient

Returns:

a Collection of GroupDTO that contains the main Groups of the user

update

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

Description copied from interface: GroupClient

Update a Group by its UUID

Specified by:

update in interface GroupClient

Parameters:

uuid - the UUID of the Group

name - the new name of the Group

Returns:

the updated GroupDTO

getGroupsTree

public net.sparkworks.cargo.common.dto.GroupNodeDTO getGroupsTree()

Description copied from interface: GroupClient

Retrieve the Tree structure of the Groups starting from the Root

Specified by:

getGroupsTree in interface GroupClient

Returns:

a GroupNodeDTO that contains all the Tree