Ea 4015 set client code

pom.xml

@@ -56,13 +56,13 @@
 
 		<springdoc.version>1.6.14</springdoc.version>
 
-		<version.httpClient>3.1</version.httpClient>
+		<version.httpClient5>5.4.1</version.httpClient5>
 		<version.javax.annotation>1.3.2</version.javax.annotation>
 		<version.jettison>1.3</version.jettison>
 		<version.jaxb>2.3.1</version.jaxb>
 		<version.junit>5.7.2</version.junit>
 		<version.commonsIO>2.8.0</version.commonsIO>
-
+		<jackson.version>2.18.1</jackson.version>
 		<!-- java version properties -->
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>

set-client/pom.xml

@@ -36,13 +36,13 @@
 			<artifactId>jettison</artifactId>
 			<version>${version.jettison}</version>
 		</dependency>
-
+
+<!--	To fix : "Provider for jakarta.ws.rs.ext.RuntimeDelegate cannot be found error"
+        This issue is tagged with version 2.30 but it doesn't look like it was ever fixed in newer versions as well-->
 		<dependency>
-			<groupId>org.springframework</groupId>
-			<artifactId>spring-webmvc</artifactId>
-			<!--
-			<version>${spring-framework.version}</version>
-			-->
+			<groupId>org.glassfish.jersey.core</groupId>
+			<artifactId>jersey-common</artifactId>
+			<version>3.1.2</version>
 		</dependency>
 
 		<!-- test dependencies --> 

set-client/src/main/java/eu/europeana/set/client/BaseUserSetApi.java

@@ -2,6 +2,16 @@
 
 import eu.europeana.set.client.config.ClientConfiguration;
 import eu.europeana.set.client.connection.UserSetApiConnection;
+import eu.europeana.set.client.exception.SetApiClientException;
+import eu.europeana.set.common.http.HttpConnection;
+import org.apache.hc.client5.http.impl.classic.CloseableHttpResponse;
+import org.apache.hc.core5.http.HttpStatus;
+import org.apache.hc.core5.http.ParseException;
+import org.apache.hc.core5.http.io.entity.EntityUtils;
+import org.codehaus.jettison.json.JSONException;
+import org.codehaus.jettison.json.JSONObject;
+
+import java.io.IOException;
 
 /**
  * Base class for client API
@@ -12,25 +22,65 @@
 public class BaseUserSetApi {
 
     private final ClientConfiguration configuration;
-    protected final UserSetApiConnection apiConnection;
-
-    protected BaseUserSetApi(ClientConfiguration configuration, UserSetApiConnection apiConnection) {
-	this.configuration = configuration;
-	this.apiConnection = apiConnection;
+    private UserSetApiConnection apiConnection;
+
+    /**
+     * Creates BaseUserSetApi instance with client configuration
+     * This allows user to insert property file
+     * @param configuration
+     * @throws SetApiClientException
+     */
+    protected BaseUserSetApi(ClientConfiguration configuration) throws SetApiClientException {
+        this.configuration = configuration;
+        if (this.configuration.getServiceUri() == null) {
+            throw new SetApiClientException(" Set Api Endpoint not provided !!!");
+        }
+
+        if (this.configuration.getOauthServiceUri() == null || this.configuration.getOauthRequestParams() == null) {
+            throw new SetApiClientException("Oauth uri and param not provided !!!");
+        }
+
+        this.apiConnection = new UserSetApiConnection(
+                this.configuration.getServiceUri(),
+                this.configuration.getApiKey(),
+                getOauthToken(this.configuration.getOauthServiceUri(), this.configuration.getOauthRequestParams()));
     }
 
-    protected BaseUserSetApi() {
-	this.configuration = ClientConfiguration.getInstance();
-	this.apiConnection = new UserSetApiConnection(getConfiguration().getServiceUri(),
-		getConfiguration().getApiKey());
+    /**
+     * Constructor
+     * @throws SetApiClientException
+     */
+    public BaseUserSetApi() throws SetApiClientException {
+	this(new ClientConfiguration());
+    }
+
+    private String getOauthToken(String oauthServiceUri, String oauthRequestParams ) throws SetApiClientException{
+        try {
+            String accessToken = "access_token";
+            HttpConnection connection = new HttpConnection();
+
+            CloseableHttpResponse response = connection.post(oauthServiceUri, oauthRequestParams, "application/x-www-form-urlencoded", null);
+            String body = EntityUtils.toString(response.getEntity());
+            if (HttpStatus.SC_OK == response.getCode()) {
+                JSONObject json = new JSONObject(body);
+                if (json.has(accessToken)) {
+                    return "Bearer " + json.getString(accessToken);
+                } else {
+                    throw new SetApiClientException("Cannot extract authentication token from reponse:" + body);
+                }
+            } else {
+                throw new SetApiClientException("Error occured when calling oath service! " + response);
+            }
+        } catch (IOException | JSONException | ParseException e) {
+            throw new SetApiClientException("Cannot retrieve authentication token!", 0 ,  e);
+        }
     }
 
     public UserSetApiConnection getApiConnection() {
-	return apiConnection;
+        return apiConnection;
     }
 
     public ClientConfiguration getConfiguration() {
-	return configuration;
+        return configuration;
     }
-
 }

set-client/src/main/java/eu/europeana/set/client/UserSetApiClient.java

@@ -0,0 +1,77 @@
+package eu.europeana.set.client;
+
+import eu.europeana.set.client.config.ClientConfiguration;
+import eu.europeana.set.client.exception.SetApiClientException;
+import eu.europeana.set.client.model.result.RecordPreview;
+import eu.europeana.set.client.web.SearchUserSetApi;
+import eu.europeana.set.client.web.WebUserSetApi;
+import eu.europeana.set.definitions.model.UserSet;
+
+import java.util.List;
+
+/**
+ * Implementation of client api
+ *
+ * @author GordeaS
+ * Refractored by Srishti Singh
+ */
+
+public class UserSetApiClient extends BaseUserSetApi {
+
+    private final WebUserSetClient webUserSetClient;
+    private final SearchUserSetClient searchUserSetClient;
+
+    public UserSetApiClient(ClientConfiguration configuration) throws SetApiClientException {
+        super(configuration);
+        this.webUserSetClient = new WebUserSetClient();
+        this.searchUserSetClient = new SearchUserSetClient();
+    }
+
+    public WebUserSetApi getWebUserSetApi() {
+        return webUserSetClient;
+    }
+
+    public SearchUserSetApi getSearchUserSetApi() {
+        return searchUserSetClient;
+    }
+
+    /**
+     * Web User Set Client class
+     */
+    private class WebUserSetClient implements WebUserSetApi {
+        @Override
+        public UserSet createUserSet(String set, String profile) throws SetApiClientException {
+            return getApiConnection().createUserSet(set, profile);
+
+        }
+
+        @Override
+        public String deleteUserSet(String identifier) throws SetApiClientException {
+            return getApiConnection().deleteUserSet(identifier);
+        }
+
+        @Override
+        public UserSet getUserSet(String identifier, String profile) throws SetApiClientException {
+            return getApiConnection().getUserSet(identifier, profile);
+        }
+
+        @Override
+        public UserSet updateUserSet(String identifier, String set, String profile) throws SetApiClientException {
+            return getApiConnection().updateUserSet(identifier, set, profile);
+        }
+
+        @Override
+        public List<RecordPreview> getPaginationUserSet(String identifier, String sort, String sortOrder, String page, String pageSize, String profile) throws SetApiClientException {
+            return getApiConnection().getPaginationUserSet(identifier, sort, sortOrder, page, pageSize, profile);
+        }
+    }
+
+    private class SearchUserSetClient implements SearchUserSetApi {
+
+        @Override
+        public List<? extends UserSet> searchUserSet(String query, String[] qf,
+                                                     String sort, String page, String pageSize, String facet, int facetLimit, String profile) throws SetApiClientException {
+            return getApiConnection().searchUserSet(query, qf, sort, page, pageSize, facet, facetLimit, profile);
+        }
+    }
+}

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

@@ -1,126 +1,76 @@
 package eu.europeana.set.client.config;
 
 import java.io.IOException;
-import java.io.InputStream;
 import java.util.Properties;
 
-import eu.europeana.set.client.exception.TechnicalRuntimeException;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 
 /**
  * configuration for accessing remote api
- * 
  * @author GordeaS
- *
  */
 
 public final class ClientConfiguration {
 
+    private static final Logger LOGGER = LogManager.getLogger(ClientConfiguration.class);
+
     protected static final String SET_CLIENT_PROPERTIES_FILE = "/set-client.user.properties";
-    protected static final String PROP_SET_API_KEY = "set.api.key";
-    protected static final String PROP_SET_SERVICE_URI = "set.service.uri";
-    protected static final String PROP_OAUTH_SERVICE_URI = "oauth.service.uri";
-    protected static final String PROP_OAUTH_REQUEST_PARAMS = "oauth.token.request.params";
+    public static final String PROP_SET_API_KEY = "set.api.key";
+    public static final String PROP_SET_SERVICE_URI = "set.service.uri";
+    public static final String PROP_OAUTH_SERVICE_URI = "oauth.service.uri";
+    public static final String PROP_OAUTH_REQUEST_PARAMS = "oauth.token.request.params";
 
     private Properties properties;
-    private static ClientConfiguration singleton;
-
-    /**
-     * Hide the default constructor
-     */
-    private ClientConfiguration() {
-    }
 
     /**
-     * Accessor method for the singleton
-     * 
-     * @return
+     * Creates ClientConfiguration instance with set client properties
      */
-    public static synchronized ClientConfiguration getInstance() {
-	if (singleton == null) {
-	    singleton = new ClientConfiguration();
-	    singleton.loadProperties();
-	}
-
-	return singleton;
+    public ClientConfiguration() {
+        loadProperties(SET_CLIENT_PROPERTIES_FILE);
     }
 
     /**
-     * Laizy loading of configuration properties
+     * CConstructor to inject properties
+     * @param properties
      */
-    public synchronized void loadProperties() {
-
-	try {
-	    properties = new Properties();
-	    InputStream resourceAsStream = getClass().getResourceAsStream(SET_CLIENT_PROPERTIES_FILE);
-	    if (resourceAsStream == null) {
-		throw new TechnicalRuntimeException(
-			"No properties file found in classpath! " + SET_CLIENT_PROPERTIES_FILE);
-	    }
-	    getProperties().load(resourceAsStream);
-
-	} catch (RuntimeException | IOException e) {
-	    throw new TechnicalRuntimeException("Cannot read configuration file: " + SET_CLIENT_PROPERTIES_FILE, e);
-	}
-
+    public ClientConfiguration(Properties properties) {
+        this.properties = properties;
     }
 
-    /**
-     * provides access to the configuration properties. It is not recommended to use
-     * the properties directly, but the
-     * 
-     * @return
-     */
-    Properties getProperties() {
-	return properties;
+    private Properties loadProperties(String propertiesFile) {
+        try {
+            properties = new Properties();
+            properties.load(getClass().getResourceAsStream(propertiesFile));
+        } catch (IOException e) {
+            LOGGER.error("Error loading the properties file {}", propertiesFile);
+        }
+        return properties;
     }
 
-    /**
-     * 
-     * @return the name of the file storing the client configuration
-     */
     String getConfigurationFile() {
 	return SET_CLIENT_PROPERTIES_FILE;
     }
 
-    /**
-     * This method provides access to the API key defined in the configuration file
-     * 
-     * @see PROP_EUROPEANA_API_KEY
-     * 
-     * @return
-     */
     public String getApiKey() {
-	return getProperties().getProperty(PROP_SET_API_KEY);
+	return getProperty(PROP_SET_API_KEY);
     }
 
-    /**
-     * This method provides access to the search uri value defined in the
-     * configuration file
-     * 
-     * @see PROP_EUROPEANA_SEARCH_URI
-     * 
-     * @return
-     */
+
     public String getServiceUri() {
-	return getProperties().getProperty(PROP_SET_SERVICE_URI);
+	return getProperty(PROP_SET_SERVICE_URI);
     }
 
-    /**
-     * This method returns the uri of the oauth service as configured in
-     * 
-     * @return
-     */
     public String getOauthServiceUri() {
-	return getProperties().getProperty(PROP_OAUTH_SERVICE_URI);
+	return getProperty(PROP_OAUTH_SERVICE_URI);
     }
 
-    /**
-     * This method returns the request params needed to acquire a new token
-     * 
-     * @return
-     */
     public String getOauthRequestParams() {
-	return getProperties().getProperty(PROP_OAUTH_REQUEST_PARAMS);
+	return getProperty(PROP_OAUTH_REQUEST_PARAMS);
+    }
+
+    private String getProperty(String propertyName) {
+        return properties.getProperty(propertyName);
     }
 
 }