Cumulocity IoT SDK/Java client supports /group/* API methods?

Michael_Voigt2 · October 11, 2022, 12:50pm

What product/components do you use and which version/fix level are you on?

Cumulocity IoT Microservice SDK / Cumulocity IoT Java Client 1009.0.12

Is your question related to the free trial, or to a production (customer) instance?

no

What are you trying to achieve? Please describe it in detail.

We’re trying to find out if the Microservice SDK/Java client offers methods to access the REST APIs to

check if a group (“MyApp Reader”, “MyApp Admin”) exists:
https://cumulocity.com/api/10.13.0/#operation/getGroupCollectionResource
create a group (“MyApp Reader”, “MyApp Admin”):
https://cumulocity.com/api/10.13.0/#operation/postGroupCollectionResource
assign a role/permission (“ROLE_MYAPP_READ”, “ROLE_MYAPP_ADMIN”) to a group:
https://cumulocity.com/api/10.13.0/#operation/postGroupsRoleReferenceCollectionResource

We couldnt find the corresponding classes/methods in the java client and wonder if someone might be able to help us here? Maybe there are added in a more recent version of the client?

Regards
Michael

Harald_Meyer · October 12, 2022, 11:14am

These REST APIs are not directly supported by the SDK. You will have to use e.g. the RestConnector to do the call yourself. Here is an example at least for the first of the calls you are looking for:

github.com

SoftwareAG/cumulocity-clients-java/blob/develop/lpwan-backend/src/main/java/com/cumulocity/lpwan/platform/repository/LpwanRepository.java#L180


      
                  }
              }
              return user;
          }
          
          
private void linkUserToGroup(String tenantId, String username) {
              GroupRepresentation deviceGroup = findGroupByName(tenantId, "devices");
              addUserToDeviceGroup(deviceGroup.getId(), tenantId, username);
          }
          
          
private GroupRepresentation findGroupByName(String tenantId, String groupName) {
              String path = String.format(GROUP_BY_NAME_URL_PATTERN, tenantId, groupName);
              return restConnector.get(path, UserMediaType.GROUP, GroupRepresentation.class);
          }
          
          
private void addUserToDeviceGroup(long deviceGroupId, String tenantId, String username) {
              String path = String.format(ADD_USER_TO_GROUP_URL_PATTERN, tenantId, deviceGroupId);
              UserReferenceRepresentation userReferenceRepresentation = new UserReferenceRepresentation();
              UserRepresentation user = new UserRepresentation();
              user.setSelf("/users/" + username);
              userReferenceRepresentation.setUser(user);

Michael_Voigt2 · October 14, 2022, 9:00am

Thanks @Harald_Meyer! We’ll look into this solution!
In the meanwhile we started implementing the REST calls using a org.springframework.web.client.RestTemplate. Do you know the main differences or dis/advantages between the two solutions?

Regards
Michael

Harald_Meyer · October 14, 2022, 9:20am

The main benefit of RestConnector is that is is managed by the Microservice SDK so you do not have to care about credentials. It is somewhat limited especially when it comes to post and put methods as it expects to interact with the Cumulocity API. So parameters and return types have to implement ResourceRepresentation.

Note that Spring Framework’s RestTemplate is in maintenance mode. Instead you can for example also use the HttpRequest implementation of Java.

Stefan_Witschel · October 14, 2022, 10:07am

The official successor of RestTemplates is the WebClient Spring 5 WebClient | Baeldung

system · April 12, 2023, 10:07am

This topic was automatically closed 180 days after the last reply. New replies are no longer allowed.

Topic		Replies	Views
RestConnector POST method with an entity/instance (headers and/or body) to write to the request and a different response type instance Cumulocity-IoT , IoT , IoT-Platform	3	524	May 28, 2023
Adding devices to groups via Cumulocity IOT api Cumulocity-IoT , IoT , IoT-Platform	3	601	April 5, 2023
Need a GIT Hub java code example which uses the java sdk to access cumulocity apis Cumulocity-IoT , IoT	5	365	September 14, 2022
Mapping fails with RestConnector for List/Array response Cumulocity-IoT , IoT , IoT-Platform	1	497	August 8, 2023
Microservice SDK (java) best way to call unsupperted but available REST endpoints Cumulocity-IoT , IoT	7	1077	September 5, 2023

Cumulocity IoT SDK/Java client supports /group/* API methods?

What product/components do you use and which version/fix level are you on?

Is your question related to the free trial, or to a production (customer) instance?

What are you trying to achieve? Please describe it in detail.

Related topics