add: events when cookie was updated

Author: florianepitech

src/main/java/net/httpclient/wrapper/HttpClientWrapper.java

@@ -1,7 +1,9 @@
 package net.httpclient.wrapper;
 
+import org.apache.http.impl.client.BasicCookieStore;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.json.Cookie;
 
 public class HttpClientWrapper {
 

src/main/java/net/httpclient/wrapper/events/HttpClientSessionEvent.java

@@ -0,0 +1,47 @@
+package net.httpclient.wrapper.events;
+
+import net.httpclient.wrapper.session.HttpClientSession;
+
+import java.util.ArrayList;
+
+/**
+ * This static class manage the HttpClientSession events.
+ */
+public class HttpClientSessionEvent {
+
+    private static final ArrayList<HttpClientSessionListener> httpClientSessionBasics = new ArrayList<>();
+
+    /*
+     $      Add and remove listeners
+     */
+
+    /**
+     * Add a listener to the list of listeners.
+     * @param listener The listener to add.
+     */
+    public static void addHttpClientSessionListener(HttpClientSessionListener listener) {
+        httpClientSessionBasics.add(listener);
+    }
+
+    /**
+     * Remove a listener from the list of listeners.
+     * @param listener The listener to remove.
+     */
+    public static void removeHttpClientSessionListener(HttpClientSessionListener listener) {
+        httpClientSessionBasics.remove(listener);
+    }
+
+    /*
+     $      Trigger events
+     */
+
+    /**
+     * Trigger the event onHttpClientCookiesUpdated in all listeners.
+     * @param httpClientSession The HttpClientSession who has updated his cookies.
+     */
+    public static void triggerHttpClientCookiesUpdated(HttpClientSession httpClientSession) {
+        httpClientSessionBasics.forEach(listener -> listener.onHttpClientCookiesUpdated(httpClientSession));
+    }
+
+
+}

src/main/java/net/httpclient/wrapper/events/HttpClientSessionListener.java

@@ -0,0 +1,17 @@
+package net.httpclient.wrapper.events;
+
+import net.httpclient.wrapper.session.HttpClientSession;
+
+/**
+ * This class should be implemented and registered to listen events.
+ */
+public interface HttpClientSessionListener {
+
+    /**
+     * This method should be call when a session has updated his cookies.
+     * @param httpClientSession The session who has the cookies updated.
+     */
+    void onHttpClientCookiesUpdated(HttpClientSession httpClientSession);
+
+
+}

src/main/java/net/httpclient/wrapper/exception/HttpException.java

@@ -1,9 +1,6 @@
 package net.httpclient.wrapper.exception;
 
 import net.httpclient.wrapper.response.RequestResponse;
-import org.apache.http.HttpResponse;
-
-import java.io.IOException;
 
 public class HttpException extends Exception {
 
@@ -14,7 +11,7 @@ public HttpException(RequestResponse requestResponse) {
         this.requestResponse = requestResponse;
     }
 
-    public RequestResponse getRequestResponse() throws IOException {
+    public RequestResponse getRequestResponse() {
         return (requestResponse);
     }
 

…pper/session/HttpClientSessionBasic.java …t/wrapper/session/HttpClientSession.javasrc/main/java/net/httpclient/wrapper/session/HttpClientSessionBasic.java renamed to src/main/java/net/httpclient/wrapper/session/HttpClientSession.java src/main/java/net/httpclient/wrapper/session/HttpClientSessionBasic.java renamed to src/main/java/net/httpclient/wrapper/session/HttpClientSession.java

@@ -1,9 +1,11 @@
 package net.httpclient.wrapper.session;
 
 import net.httpclient.wrapper.HttpClientWrapper;
+import net.httpclient.wrapper.events.HttpClientSessionEvent;
 import net.httpclient.wrapper.exception.HttpClientException;
 import net.httpclient.wrapper.exception.HttpServerException;
 import net.httpclient.wrapper.response.RequestResponse;
+import net.httpclient.wrapper.utils.BasicCookieStoreSerializerUtils;
 import net.httpclient.wrapper.utils.RandomUserAgent;
 import org.apache.http.*;
 import org.apache.http.auth.AuthScope;
@@ -36,11 +38,13 @@
 import java.util.List;
 import java.util.concurrent.TimeUnit;
 
+import static net.httpclient.wrapper.HttpClientWrapper.logger;
+
 /**
  * The basic class for all the http requests.
  * No security for multithreaded application.
  */
-public class HttpClientSessionBasic {
+public class HttpClientSession {
 
     /*
      $      Variable of the class
@@ -57,7 +61,7 @@ public class HttpClientSessionBasic {
      $      Constructor
      */
 
-    public HttpClientSessionBasic() {
+    public HttpClientSession() {
         try {
             this.httpClient = newHttpClient();
             this.requestConfig = setRequestConfig();
@@ -121,60 +125,92 @@ public HttpClient newHttpClient() throws NoSuchAlgorithmException, KeyManagement
 
     public RequestResponse sendGet(String url) throws IOException, HttpClientException, HttpServerException {
         Date start = new Date();
+        String oldCookieStoreSerialized = BasicCookieStoreSerializerUtils.serializableToBase64(httpCookieStore);
+
         HttpGet httpGet = new HttpGet(url);
         httpGet.setConfig(getRequestConfig().build());
         httpGet.addHeader(HttpHeaders.ACCEPT, "application/json, text/plain, */*");
         HttpResponse httpResponse = getHttpClient().execute(httpGet);
+
         assertRequest(httpResponse, start);
+        verifyCookiesEvents(oldCookieStoreSerialized);
         return (new RequestResponse(httpResponse, start));
     }
 
     public RequestResponse sendPost(String url, String content, ContentType contentType) throws IOException, HttpClientException, HttpServerException {
         Date start = new Date();
+        String oldCookieStoreSerialized = BasicCookieStoreSerializerUtils.serializableToBase64(httpCookieStore);
+
         HttpPost httpPost = new HttpPost(url);
         httpPost.setConfig(getRequestConfig().build());
         httpPost.addHeader(HttpHeaders.CONTENT_TYPE, contentType.getMimeType());
         httpPost.addHeader(HttpHeaders.ACCEPT, "application/json, text/plain, */*");
         httpPost.setEntity(new StringEntity(content));
         HttpResponse httpResponse = getHttpClient().execute(httpPost);
+
         assertRequest(httpResponse, start);
+        verifyCookiesEvents(oldCookieStoreSerialized);
         return (new RequestResponse(httpResponse, start));
     }
 
     public RequestResponse sendForm(String url, List<NameValuePair> form) throws IOException, HttpClientException, HttpServerException {
         Date start = new Date();
+        String oldCookieStoreSerialized = BasicCookieStoreSerializerUtils.serializableToBase64(httpCookieStore);
+
         HttpPost httpPost = new HttpPost(url);
         httpPost.setConfig(getRequestConfig().build());
         httpPost.addHeader(HttpHeaders.ACCEPT, "application/json, text/plain, */*");
         UrlEncodedFormEntity entity = new UrlEncodedFormEntity(form, Consts.UTF_8);
         httpPost.setEntity(entity);
         HttpResponse httpResponse = httpClient.execute(httpPost);
+
         assertRequest(httpResponse, start);
+        verifyCookiesEvents(oldCookieStoreSerialized);
         return (new RequestResponse(httpResponse, start));
     }
 
     public RequestResponse sendDelete(String url) throws IOException, HttpClientException, HttpServerException {
         Date start = new Date();
+        String oldCookieStoreSerialized = BasicCookieStoreSerializerUtils.serializableToBase64(httpCookieStore);
+
         HttpDelete httpDelete = new HttpDelete(url);
         httpDelete.setConfig(getRequestConfig().build());
         httpDelete.addHeader(HttpHeaders.ACCEPT, "application/json, text/plain, */*");
         HttpResponse httpResponse = httpClient.execute(httpDelete);
+
         assertRequest(httpResponse, start);
+        verifyCookiesEvents(oldCookieStoreSerialized);
         return (new RequestResponse(httpResponse, start));
     }
 
     public RequestResponse sendPut(String url, String content, ContentType contentType) throws IOException, HttpClientException, HttpServerException {
         Date start = new Date();
+        String oldCookieStoreSerialized = BasicCookieStoreSerializerUtils.serializableToBase64(httpCookieStore);
+
         HttpPut httpPut = new HttpPut(url);
         httpPut.setConfig(getRequestConfig().build());
         httpPut.addHeader(HttpHeaders.CONTENT_TYPE, contentType.getMimeType());
         httpPut.addHeader(HttpHeaders.ACCEPT, "application/json, text/plain, */*");
         httpPut.setEntity(new StringEntity(content));
         HttpResponse httpResponse = getHttpClient().execute(httpPut);
+
         assertRequest(httpResponse, start);
+        verifyCookiesEvents(oldCookieStoreSerialized);
         return (new RequestResponse(httpResponse, start));
     }
 
+    /*
+     $      Private mehtods
+     */
+
+    /**
+     * Assert the request and throw an exception if the request is not valid.
+     * @param httpResponse The response of the request.
+     * @param startDate The start date of the request.
+     * @throws HttpClientException If the request is not successful.
+     * @throws HttpServerException If the server is not available.
+     * @throws IOException If the request is not successful because of an network error.
+     */
     private void assertRequest(HttpResponse httpResponse, Date startDate) throws HttpClientException, HttpServerException, IOException {
         int statusCode = httpResponse.getStatusLine().getStatusCode();
         if (statusCode >= 500 && statusCode <= 599)
@@ -183,6 +219,23 @@ else if (statusCode >= 400 && statusCode <= 499)
             throw new HttpClientException(new RequestResponse(httpResponse, startDate));
     }
 
+    /**
+     * Verify if the cookie store has been modified.
+     * Some requests can modify the cookie store, and this method will verify if the cookie store has been modified.
+     * This methods can trigger HttpClientCookiesUpdatedEvent.
+     * This methods should be called after a request.
+     * @param serializedOldCookieStore The old cookie store before the request serialized as string.
+     */
+    private void verifyCookiesEvents(String serializedOldCookieStore) {
+        try {
+            String serializedNewCookieStore = BasicCookieStoreSerializerUtils.serializableToBase64(httpCookieStore);
+            if (!serializedOldCookieStore.equals(serializedNewCookieStore))
+                HttpClientSessionEvent.triggerHttpClientCookiesUpdated(this);
+        } catch (Exception e) {
+            logger.warn("Error while verifying cookies events", e);
+        }
+    }
+
     /*
      *      Getters and Setters
      */

src/main/java/net/httpclient/wrapper/session/HttpClientSessionAsync.java

@@ -32,7 +32,7 @@
 
 import static net.httpclient.wrapper.HttpClientWrapper.logger;
 
-public class HttpClientSessionAsync extends HttpClientSessionBasic {
+public class HttpClientSessionAsync extends HttpClientSession {
 
     /*
      $      Variable of the class

src/main/java/net/httpclient/wrapper/session/HttpClientSessionRateLimited.java

@@ -10,7 +10,7 @@
 import java.io.IOException;
 import java.util.List;
 
-public class HttpClientSessionRateLimited extends HttpClientSessionBasic {
+public class HttpClientSessionRateLimited extends HttpClientSession {
 
     private final RateLimiter rateLimiter;
 

src/main/java/net/httpclient/wrapper/utils/BasicCookieStoreSerializerUtils.java

@@ -0,0 +1,26 @@
+package net.httpclient.wrapper.utils;
+
+import org.apache.http.impl.client.BasicCookieStore;
+
+import java.io.*;
+import java.util.Base64;
+
+public class BasicCookieStoreSerializerUtils {
+
+    public static String serializableToBase64(BasicCookieStore serializable) throws IOException {
+        ByteArrayOutputStream baos = new ByteArrayOutputStream();
+        ObjectOutputStream oos = new ObjectOutputStream(baos);
+        oos.writeObject(serializable);
+        oos.close();
+        return Base64.getEncoder().encodeToString(baos.toByteArray());
+    }
+
+    public static BasicCookieStore base64ToSerializable(String base64) throws IOException, ClassNotFoundException {
+        byte[] data = Base64.getDecoder().decode(base64);
+        ObjectInputStream ois = new ObjectInputStream(new ByteArrayInputStream(data));
+        BasicCookieStore object = (BasicCookieStore)ois.readObject();
+        ois.close();
+        return (object);
+    }
+
+}