completely rewritten pingGoogle / pingBing methods

Author: jirka.pinkas@gmail.com

README.md

@@ -12,7 +12,7 @@ Add this library to classpath:
     <dependency>
       <groupId>cz.jiripinkas</groupId>
       <artifactId>jsitemapgenerator</artifactId>
-      <version>4.2</version>
+      <version>4.3</version>
     </dependency>
 
 If you want to use "ping google / bing" functionality, also add this library to classpath:
@@ -91,19 +91,29 @@ String sitemap = SitemapGenerator.of("https://example.com")
         .toString();
 ```
 
-or to store it to file & ping google:
+or to store it to file & ping Google:
 
 ```java
+Ping ping = Ping.builder()
+        .engines(Ping.SearchEngine.GOOGLE)
+        .build();
 SitemapGenerator.of("https://example.com")
     .addPage(WebPage.builder().maxPriorityRoot().changeFreqNever().lastModNow().build())
     .addPage("foo.html")
     .addPage("bar.html")
     // generate sitemap and save it to file ./sitemap.xml
     .toFile(Paths.get("sitemap.xml"))
     // inform Google that this sitemap has changed
-    .ping(SearchEngine.GOOGLE); // this requires okhttp in classpath!!!
+    .ping(ping); // this requires okhttp in classpath!!!
+    .callOnSuccess(() -> System.out.println("Pinged Google")) // what will happen on success
+    .catchOnFailure(e -> System.out.println("Could not ping Google!")); // what will happen on error
 ```
 
+Note: To ping Google / Bing, you can either use built-in support (requires OkHttp in classpath!!!), 
+or you can use your own http client implementation. Supported http clients: Custom OkHttpClient, 
+CloseableHttpClient (Apache Http Client), RestTemplate (from Spring). To use your own http client 
+implementation just call on PingBuilder method: httpClient*() and pass inside your implementation.
+
 ### How to create sitemap index:
 
 ```java
@@ -115,7 +125,8 @@ String sitemapIndex = SitemapIndexGenerator.of("https://javalibs.com")
 
 ### How to create RSS channel:
 
-... RSS ISN'T sitemap :-), but it's basically just a list of links (like sitemap) and if you need sitemap, then probably you also need RSS
+... RSS ISN'T sitemap :-), but it's basically just a list of links (like sitemap) and if you need sitemap, 
+then probably you also need RSS. Note: RssGenerator has lots of common methods with SitemapGenerator.
 
 ```java
 String rss = RssGenerator.of("https://topjavablogs.com", "Top Java Blogs", "Best Java Blogs")

pom.xml

@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>cz.jiripinkas</groupId>
     <artifactId>jsitemapgenerator</artifactId>
-    <version>4.2</version>
+    <version>4.3</version>
     <packaging>jar</packaging>
     <name>Java sitemap generator</name>
     <description>This library generates a web sitemap and can ping Google that it has changed. This project has been
@@ -30,6 +30,8 @@
         <junit.version>5.5.2</junit.version>
         <assertj.version>3.14.0</assertj.version>
         <mockito.version>3.1.0</mockito.version>
+        <spring.version>5.2.1.RELEASE</spring.version>
+        <httpclient.version>4.5.10</httpclient.version>
     </properties>
 
     <developers>
@@ -47,6 +49,18 @@
             <version>${okhttp.version}</version>
             <optional>true</optional>
         </dependency>
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-web</artifactId>
+            <version>${spring.version}</version>
+            <optional>true</optional>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.httpcomponents</groupId>
+            <artifactId>httpclient</artifactId>
+            <version>${httpclient.version}</version>
+            <optional>true</optional>
+        </dependency>
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter-api</artifactId>

src/main/java/cz/jiripinkas/jsitemapgenerator/AbstractSitemapGenerator.java

@@ -1,8 +1,18 @@
 package cz.jiripinkas.jsitemapgenerator;
 
-import cz.jiripinkas.jsitemapgenerator.exception.WebmasterToolsException;
 import cz.jiripinkas.jsitemapgenerator.exception.InvalidPriorityException;
 import cz.jiripinkas.jsitemapgenerator.exception.InvalidUrlException;
+import cz.jiripinkas.jsitemapgenerator.exception.WebmasterToolsException;
+import okhttp3.OkHttpClient;
+import okhttp3.Request;
+import okhttp3.Response;
+import org.apache.http.HttpEntity;
+import org.apache.http.client.methods.CloseableHttpResponse;
+import org.apache.http.client.methods.HttpGet;
+import org.apache.http.impl.client.CloseableHttpClient;
+import org.apache.http.util.EntityUtils;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.client.RestTemplate;
 
 import java.io.*;
 import java.net.*;
@@ -203,88 +213,76 @@ public T toFile(File parent, String child) throws IOException {
     }
 
     /**
-     * Ping search engine that sitemap has changed. For Google it will call this URL:
-     * https://www.google.com/ping?sitemap=URL_Encoded_sitemapUrl
-     *
-     * @param searchEngines Search engines to ping
-     * @param sitemapUrl   sitemap url
-     */
-    public void ping(String sitemapUrl, SearchEngine ... searchEngines) {
-        if(searchEngines.length == 0) {
-            throw new UnsupportedOperationException("Must provide at least one search engine!");
-        }
-        for (SearchEngine searchEngine : searchEngines) {
-            ping(searchEngine.getPingUrl(), sitemapUrl, searchEngine.getPrettyName());
-        }
-    }
-
-    /**
-     * Ping search engine that sitemap has changed. Sitemap must be on this location:
-     * baseUrl/sitemap.xml (for example http://www.javavids.com/sitemap.xml)
-     *
-     * @param doNotThrowExceptionOnFailure If this is true and it's not possible to ping search engine,
-     *                                     this method won't throw any exception, but will return false.
-     * @param searchEngines                Search engines to ping
-     * @return If operation succeeded
+     * Ping search engine(s) that sitemap has changed.
+     * @param ping Ping object
+     * @return true if operation succeeded. If ping.isThrowExceptionOnFailure() == false and operation doesn't succeed, returns false.
      */
-    public boolean ping(boolean doNotThrowExceptionOnFailure, SearchEngine ... searchEngines) {
-        if(searchEngines.length == 0) {
-            throw new UnsupportedOperationException("Must provide at least one search engine!");
-        }
+    public PingResponse ping(Ping ping) {
         try {
-            ping(searchEngines);
-            return true;
-        } catch (Exception e) {
-            if (doNotThrowExceptionOnFailure) {
-                return false;
+            for (Ping.SearchEngine searchEngine : ping.getSearchEngines()) {
+                String resourceUrl;
+                if (searchEngine == Ping.SearchEngine.GOOGLE) {
+                    resourceUrl = "https://www.google.com/ping?sitemap=";
+                } else if (searchEngine == Ping.SearchEngine.BING) {
+                    resourceUrl = "https://www.bing.com/ping?sitemap=";
+                } else {
+                    throw new UnsupportedOperationException("Unknown search engine: " + searchEngine);
+                }
+                String sitemapUrl;
+                if (ping.getSitemapUrl() == null) {
+                    sitemapUrl = getAbsoluteUrl("sitemap.xml", false);
+                } else {
+                    sitemapUrl = getAbsoluteUrl(ping.getSitemapUrl(), false);
+                }
+                boolean responseIsNot200 = false;
+                if (ping.getHttpClientType() == null) {
+                    ping(resourceUrl, sitemapUrl, searchEngine.getPrettyName());
+                } else if(ping.getHttpClientType() == Ping.HttpClientType.REST_TEMPLATE) {
+                    String pingUrl = resourceUrl + sitemapUrl;
+                    RestTemplate restTemplate = (RestTemplate) ping.getHttpClientImplementation();
+                    ResponseEntity<String> responseEntity = restTemplate.getForEntity(pingUrl, String.class);
+                    if (responseEntity.getStatusCodeValue() != 200) {
+                        responseIsNot200 = true;
+                    }
+                } else if(ping.getHttpClientType() == Ping.HttpClientType.OK_HTTP) {
+                    String pingUrl = resourceUrl + URLEncoder.encode(sitemapUrl, "UTF-8");
+                    OkHttpClient okHttpClient = (OkHttpClient) ping.getHttpClientImplementation();
+                    Request request = new Request.Builder().url(pingUrl).build();
+                    try (Response response = okHttpClient.newCall(request).execute()) {
+                        if (!response.isSuccessful()) {
+                            responseIsNot200 = true;
+                        }
+                    }
+                } else if(ping.getHttpClientType() == Ping.HttpClientType.APACHE_HTTP_CLIENT) {
+                    String pingUrl = resourceUrl + URLEncoder.encode(sitemapUrl, "UTF-8");
+                    CloseableHttpClient closeableHttpClient = (CloseableHttpClient) ping.getHttpClientImplementation();
+                    HttpGet httpGet = new HttpGet(pingUrl);
+                    try (CloseableHttpResponse httpResponse = closeableHttpClient.execute(httpGet)) {
+                        HttpEntity httpEntity = httpResponse.getEntity();
+                        EntityUtils.consume(httpEntity);
+                        if(httpResponse.getStatusLine().getStatusCode() != 200) {
+                            responseIsNot200 = true;
+                        }
+                    }
+                } else {
+                    throw new UnsupportedOperationException("Unknown HttpClientType!");
+                }
+                if(responseIsNot200) {
+                    throw new WebmasterToolsException(searchEngine.getPrettyName() + " could not be informed about new sitemap! Return code != 200");
+                }
             }
-            throw e;
-        }
-    }
-
-    /**
-     * Ping search engine that sitemap has changed. For Google it will call this URL:
-     * https://www.google.com/ping?sitemap=URL_Encoded_sitemapUrl
-     *
-     * @param sitemapUrl                   sitemap url
-     * @param doNotThrowExceptionOnFailure If this is true and it's not possible to ping search engine,
-     *                                     this method won't throw any exception, but will return false.
-     * @param searchEngines                Search engines to ping
-     * @return If operation succeeded
-     */
-    public boolean ping(String sitemapUrl, boolean doNotThrowExceptionOnFailure, SearchEngine... searchEngines) {
-        if(searchEngines.length == 0) {
-            throw new UnsupportedOperationException("Must provide at least one search engine!");
-        }
-        try {
-            ping(sitemapUrl, searchEngines);
-            return true;
         } catch (Exception e) {
-            if (doNotThrowExceptionOnFailure) {
-                return false;
-            }
-            throw e;
+            return new PingResponse(true, new WebmasterToolsException(e));
         }
-    }
-
-    /**
-     * Ping search engine that sitemap has changed. Sitemap must be on this location:
-     * baseUrl/sitemap.xml (for example http://www.javavids.com/sitemap.xml)
-     * @param searchEngines Search engines to ping
-     */
-    public void ping(SearchEngine ... searchEngines) {
-        if(searchEngines.length == 0) {
-            throw new UnsupportedOperationException("Must provide at least one search engine!");
-        }
-        ping(baseUrl + "sitemap.xml", searchEngines);
+        return new PingResponse(false);
     }
 
     /**
      * Ping Google that sitemap has changed. Will call this URL:
      * https://www.google.com/ping?sitemap=URL_Encoded_sitemapUrl
      *
      * @param sitemapUrl sitemap url
-     * @deprecated Use {@link #ping(String, SearchEngine...)}
+     * @deprecated Use {@link #ping(Ping)}
      */
     @Deprecated
     public void pingGoogle(String sitemapUrl) {
@@ -299,7 +297,7 @@ public void pingGoogle(String sitemapUrl) {
      * @param doNotThrowExceptionOnFailure If this is true and it's not possible to ping google,
      *                                     this method won't throw any exception, but will return false.
      * @return If operation succeeded
-     * @deprecated Use {@link #ping(String, boolean, SearchEngine...)}
+     * @deprecated Use {@link #ping(Ping)}
      */
     @Deprecated
     public boolean pingGoogle(String sitemapUrl, boolean doNotThrowExceptionOnFailure) {
@@ -319,7 +317,7 @@ public boolean pingGoogle(String sitemapUrl, boolean doNotThrowExceptionOnFailur
      * https://www.bing.com/ping?sitemap=URL_Encoded_sitemapUrl
      *
      * @param sitemapUrl sitemap url
-     * @deprecated Use {@link #ping(String, SearchEngine...)}
+     * @deprecated Use {@link #ping(Ping)}
      */
     @Deprecated
     public void pingBing(String sitemapUrl) {
@@ -334,7 +332,7 @@ public void pingBing(String sitemapUrl) {
      * @param doNotThrowExceptionOnFailure If this is true and it's not possible to ping google,
      *                                     this method won't throw any exception, but will return false.
      * @return If operation succeeded
-     * @deprecated Use {@link #ping(String, boolean, SearchEngine...)}
+     * @deprecated Use {@link #ping(Ping)}
      */
     @Deprecated
     public boolean pingBing(String sitemapUrl, boolean doNotThrowExceptionOnFailure) {
@@ -353,7 +351,7 @@ public boolean pingBing(String sitemapUrl, boolean doNotThrowExceptionOnFailure)
      * Ping Google that sitemap has changed. Sitemap must be on this location:
      * baseUrl/sitemap.xml (for example http://www.javavids.com/sitemap.xml)
      *
-     * @deprecated Use {@link #ping(SearchEngine...)}
+     * @deprecated Use {@link #ping(Ping)}
      */
     @Deprecated
     public void pingGoogle() {
@@ -367,7 +365,7 @@ public void pingGoogle() {
      * @param doNotThrowExceptionOnFailure If this is true and it's not possible to ping google,
      *                                     this method won't throw any exception, but will return false.
      * @return If operation succeeded
-     * @deprecated Use {@link #ping(boolean, SearchEngine...)}
+     * @deprecated Use {@link #ping(Ping)}
      */
     @Deprecated
     public boolean pingGoogle(boolean doNotThrowExceptionOnFailure) {
@@ -386,7 +384,7 @@ public boolean pingGoogle(boolean doNotThrowExceptionOnFailure) {
      * Ping Google that sitemap has changed. Sitemap must be on this location:
      * baseUrl/sitemap.xml (for example http://www.javavids.com/sitemap.xml)
      *
-     * @deprecated Use {@link #ping(SearchEngine...)}
+     * @deprecated Use {@link #ping(Ping)}
      */
     @Deprecated
     public void pingBing() {
@@ -400,7 +398,7 @@ public void pingBing() {
      * @param doNotThrowExceptionOnFailure If this is true and it's not possible to ping google,
      *                                     this method won't throw any exception, but will return false.
      * @return If operation succeeded
-     * @deprecated Use {@link #ping(boolean, SearchEngine...)}
+     * @deprecated Use {@link #ping(Ping)}
      */
     @Deprecated
     public boolean pingBing(boolean doNotThrowExceptionOnFailure) {
@@ -421,10 +419,10 @@ private void ping(String resourceUrl, String sitemapUrl, String serviceName) {
             // ping Google / Bing
             int returnCode = httpClient.get(pingUrl);
             if (returnCode != 200) {
-                throw new WebmasterToolsException(serviceName + " could not be informed about new sitemap!");
+                throw new WebmasterToolsException(serviceName + " could not be informed about new sitemap! Return code != 200");
             }
         } catch (Exception ex) {
-            throw new WebmasterToolsException(serviceName + " could not be informed about new sitemap!");
+            throw new WebmasterToolsException(serviceName + " could not be informed about new sitemap!", ex);
         }
     }
 
@@ -675,13 +673,32 @@ public void setHttpClient(HttpClient httpClient) {
      * Get absolute URL:
      * If webPageName is null, return baseUrl.
      * If webPageName is not null, check if webPageName is absolute (can be URL from CDN) or relative URL.
-     * If it's relative URL, prepend baseUrl and return result
+     * If it's relative URL, prepend baseUrl and return result.
+     * This method escapes webPageName's special characters, thus it must not be called for ping Google / Bing functionality!
      *
      * @param webPageName WebPageName
      * @return Correct URL
      */
     protected String getAbsoluteUrl(String webPageName) {
-        webPageName = UrlUtil.escapeXmlSpecialCharacters(webPageName);
+        return getAbsoluteUrl(webPageName, true);
+    }
+
+    /**
+     * Get absolute URL:
+     * If webPageName is null, return baseUrl.
+     * If webPageName is not null, check if webPageName is absolute (can be URL from CDN) or relative URL.
+     * If it's relative URL, prepend baseUrl and return result
+     *
+     * @param webPageName WebPageName
+     * @param escapeSpecialCharacters Escape special characters?
+     *                                Special characters must be escaped if the URL will be stored to sitemap.
+     *                                If this method is called for ping Google / Bing functionality, special characters must not be escaped.
+     * @return Correct URL
+     */
+    protected String getAbsoluteUrl(String webPageName, boolean escapeSpecialCharacters) {
+        if(escapeSpecialCharacters) {
+            webPageName = UrlUtil.escapeXmlSpecialCharacters(webPageName);
+        }
         try {
             String resultString;
             if (webPageName != null) {