Ea 4015 set client code #277

SrishtiSingh-eu · 2024-11-25T09:33:10Z

No description provided.

…pi's propety file

…from client, update other modules to adapt tghe new HTTpConnection class, added annotation for deserialising the response

…A-4015_setClientCode

gsergiu

we need to remove the dependencies from defnitions module and adapt the client accordingly

gsergiu · 2024-12-04T16:18:02Z

set-client/pom.xml

+		<dependency>
+			<groupId>jakarta.ws.rs</groupId>
+			<artifactId>jakarta.ws.rs-api</artifactId>
+			<version>4.0.0</version>


this dependency is not needed, only the UriBuilder class is used in BaseApiConnection. The use of UriBuilder needs to be replaced by the use of org.apache.hc.core5.net.URIBuilder from the httclient

removed , used httpclient 5 uri builder

gsergiu · 2024-12-04T16:22:16Z

set-client/src/main/java/eu/europeana/set/client/config/ClientConfiguration.java

-
-	return singleton;
+    public ClientConfiguration() {
+        loadProperties(SET_CLIENT_PROPERTIES_FILE);


is there a reason to change the configuration to not be a singleton anymore? We should avoid reading the properties files multiple times as that can generate major performance loss

also, the filePath for the configuration file should be provided as parameter and stored as class attribute

Usually, we use spring boot and create a bean, only a single instance is always created.
Also, when creating a client for any API, we create an instance of the Client class, and that class should be able to accept a configuration class.
public UserSetApiClient(ClientConfiguration configuration)

yes, but the properties still need to be read and currently we only support properties from the classpath

gsergiu · 2024-12-04T16:33:28Z

set-client/src/main/java/eu/europeana/set/client/config/ClientConfiguration.java

+    private Properties loadProperties(String propertiesFile) {
+        try {
+            properties = new Properties();
+            properties.load(getClass().getResourceAsStream(propertiesFile));


we should support externalization of configurations, meaning to be able to handle absolute file path using the file protocol see: https://stackoverflow.com/questions/8406025/local-file-protocol-for-java-net-url. Third parties should be able to provide the location of configuration files. (absolute file path should use the fille:// protocol)

gsergiu · 2024-12-04T16:34:21Z

set-client/src/main/java/eu/europeana/set/client/connection/BaseApiConnection.java

+import eu.europeana.set.definitions.model.impl.BaseUserSet;
+import eu.europeana.set.definitions.model.vocabulary.ProfileConstants;
+import eu.europeana.set.definitions.model.vocabulary.WebUserSetFields;
+import jakarta.ws.rs.core.UriBuilder;


should be replaced by the use of rg.apache.hc.core5.net.URIBuilder

gsergiu · 2024-12-04T16:43:03Z

set-client/src/main/java/eu/europeana/set/client/connection/BaseApiConnection.java

+                    }
+                    return records;
+                }
+                TypeReference<ResultsPageImpl<RecordPreview>> typeRef = new TypeReference<>() {};


we should have an if/else or switch for profiles. I assume this call is parsing the items.meta profile. see https://docs.google.com/spreadsheets/d/19_5ihd_MKuVenIno-enankAu8bG7v79TGHQuepOtTv8/edit?gid=1005516996#gid=1005516996

need to be aware of the default profile and eventually return an exeption if the requested profile is not supported by the client.

set API will return an Invalid profile Exception if there is a wrong parameter passed. In everycase we return List. But for the profile where only item ids are returned, we need to do bit more processing. here for "items" profile we get List which is converted to List with id value only

I have added a deserializer now to handle all the profile responses

gsergiu · 2024-12-04T16:52:07Z

set-definitions/src/main/java/eu/europeana/set/definitions/model/BaseWebResource.java

 import java.util.Objects;

+@JsonIgnoreProperties(ignoreUnknown = true)


jackson annotations should not be added to base classes which need to be keps as pojos, so that they can be used both by client and server

gsergiu · 2024-12-04T16:52:23Z

set-definitions/src/main/java/eu/europeana/set/definitions/model/agent/impl/BaseAgent.java

 import eu.europeana.set.definitions.model.agent.Agent;
 import eu.europeana.set.definitions.model.vocabulary.AgentTypes;

+@JsonIgnoreProperties(ignoreUnknown = true)


jackson annotations should not be added to base classes which need to be keps as pojos, so that they can be used both by client and server

for client side parsing, the ignore unknown fields should be set directly in object mapper https://www.baeldung.com/jackson-deserialize-json-unknown-properties#2-dealing-with-unknown-fields-using-the-objectmapper

gsergiu · 2024-12-04T16:52:36Z

set-definitions/src/main/java/eu/europeana/set/definitions/model/impl/BaseUserSet.java

 * @author GrafR Modified by Srishti Singh 2-2-2021
 */
-public abstract class BaseUserSet extends BasePageInfo implements UserSet {
+@JsonIgnoreProperties(ignoreUnknown = true)


jackson annotations should not be added to base classes which need to be keps as pojos, so that they can be used both by client and server

gsergiu · 2024-12-04T16:56:17Z

set-definitions/src/main/java/eu/europeana/set/definitions/model/impl/BaseUserSet.java

 * @author GrafR Modified by Srishti Singh 2-2-2021
 */
-public abstract class BaseUserSet extends BasePageInfo implements UserSet {
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class BaseUserSet extends BasePageInfo implements UserSet {


this class should probably stay abstract, as it is not allwed to add jackson annotations to this class.

I have removed annotations but class can not stay abstract. As i need to instantiate it to create response for items profile

Well, we can create a UserSetImpl extends BaseUserSet or so in the client module

gsergiu · 2024-12-04T16:57:00Z

set-definitions/src/main/java/eu/europeana/set/definitions/model/impl/BaseUserSet.java

@@ -74,6 +86,7 @@ public abstract class BaseUserSet extends BasePageInfo implements UserSet {
     * A reference to the user agent that gathers objects together following
     * implicit or explicit criteria or accrual policy.
     */
+    @JsonDeserialize(using = AgentDeserializer.class)


this annotation should be used on a setter method in client

removed add in the mapper in the client side deserialisation

SrishtiSingh-eu added 19 commits November 21, 2024 14:50

EA-4015 updated set client code

c7137ae

EA-4015 added serach user set client methods and classes

8c5decf

EA-4015 few tweaks

5724d0a

EA-4015 fixed the url issues

7fa4917

EA-4015 update class to private

915dfd7

EA-4015 sonarq

b7f4ba7

EA-4015 remove apikey param

9bfdd58

EA-4015 make properties public to instantiate the client with other a…

6eeefd0

…pi's propety file

EA-4015 Update set client to use http5, remove all spring dependency …

291f697

…from client, update other modules to adapt tghe new HTTpConnection class, added annotation for deserialising the response

EA-4015 add another condition

be938be

EA-4015 aremove sysout

47b5f56

EA-4015 make serach return list of sets

b23ea1e

Merge branch 'develop' of https://github.com/europeana/set-api into E…

8812fe6

…A-4015_setClientCode

EA-4015 handle profile

ac9dc4b

EA-4015 remove sysout

fa4667a

EA-4015 FIX serach api client

1ec71f6

EA-4015 sonar suggestation

0f60373

EA-4015 added get user set pagination function

dc4a230

EA-4015 add has operations

ee7594b

gsergiu requested changes Dec 4, 2024

View reviewed changes

SrishtiSingh-eu added 3 commits December 10, 2024 22:47

EA-4015 review comments

ca4857b

EA-4015 fix desrialisation

a6b9ca0

EA-4015 sonar issues

aa169ed

gsergiu merged commit d57a580 into develop Dec 13, 2024
2 of 3 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ea 4015 set client code #277

Ea 4015 set client code #277

SrishtiSingh-eu commented Nov 25, 2024

gsergiu left a comment

gsergiu Dec 4, 2024

SrishtiSingh-eu Dec 9, 2024

gsergiu Dec 4, 2024

gsergiu Dec 4, 2024

SrishtiSingh-eu Dec 9, 2024

gsergiu Dec 9, 2024

gsergiu Dec 4, 2024

gsergiu Dec 4, 2024

SrishtiSingh-eu Dec 9, 2024

gsergiu Dec 4, 2024

gsergiu Dec 4, 2024

SrishtiSingh-eu Dec 9, 2024

SrishtiSingh-eu Dec 9, 2024

gsergiu Dec 4, 2024

SrishtiSingh-eu Dec 9, 2024

gsergiu Dec 4, 2024

gsergiu Dec 4, 2024

SrishtiSingh-eu Dec 9, 2024

gsergiu Dec 4, 2024

SrishtiSingh-eu Dec 9, 2024

gsergiu Dec 4, 2024

SrishtiSingh-eu Dec 11, 2024

gsergiu Dec 11, 2024

gsergiu Dec 4, 2024

SrishtiSingh-eu Dec 9, 2024

		import java.util.Objects;

		@JsonIgnoreProperties(ignoreUnknown = true)

Ea 4015 set client code #277

Ea 4015 set client code #277

Conversation

SrishtiSingh-eu commented Nov 25, 2024

gsergiu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment