Now ships with new install script that automates copying of dependent

libraries, taking into account possible version conflicts. Dependency updates: Norconex Committer Core 2.0.5, Norconex Commons Lang 1.12.0, Apache Commons Lang 2.6.
Norconex · Aug 29, 2016 · fb2a024 · fb2a024
1 parent 6787eb8
commit fb2a024
Show file tree

Hide file tree

Showing 8 changed files with 130 additions and 59 deletions.
diff --git a/norconex-committer-idol/pom.xml b/norconex-committer-idol/pom.xml
@@ -1,5 +1,5 @@
 <!--
-   Copyright 2013-2015 Norconex Inc.
+   Copyright 2013-2016 Norconex Inc.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -19,18 +19,17 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.norconex.collectors</groupId>
   <artifactId>norconex-committer-idol</artifactId>
-  <version>2.0.1</version>
+  <version>2.1.0</version>
   <name>Norconex Committer IDOL</name>
+  <description>HP (Autonomy) IDOL implementation of Norconex Committer. This library will help you commit documents to an Autonomy IDOL Server.</description>
 
-  <!-- PROPERTIES -->
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>    
     <site.baseurl />
   </properties>
   <inceptionYear>2013</inceptionYear>
 
-  <!-- LICENSE INFORMATION -->
   <licenses>
     <license>
       <name>The Apache Software License, Version 2.0</name>
@@ -62,7 +61,7 @@
     <dependency>
       <groupId>com.norconex.collectors</groupId>
       <artifactId>norconex-committer-core</artifactId>
-      <version>2.0.1</version>
+      <version>2.0.5</version>
     </dependency>
     <dependency>
       <groupId>org.slf4j</groupId>
@@ -76,20 +75,20 @@
     </dependency>
   </dependencies>
 
-  <description>HP (Autonomy) IDOL implementation of Norconex Committer. This library will help you commit documents to an Autonomy IDOL Server.</description>
-  <organization>
-    <name>Norconex Inc.</name>
-    <url>http://www.norconex.com</url>
-  </organization>
-  <scm>
-    <url>https://github.com/Norconex/committer-idol</url>
-    <connection>scm:git:[email protected]:Norconex/committer-idol.git</connection>
-    <developerConnection>scm:git:[email protected]:Norconex/committer-idol.git</developerConnection>
-  </scm>
-  <issueManagement>
-    <system>GitHub</system>
-    <url>https://github.com/Norconex/committer-idol/issues</url>
-  </issueManagement>
+  <dependencyManagement>
+    <dependencies>
+      <dependency>
+        <groupId>com.norconex.commons</groupId>
+        <artifactId>norconex-commons-lang</artifactId>
+        <version>1.12.0</version>
+      </dependency>
+      <dependency>
+        <groupId>commons-lang</groupId>
+        <artifactId>commons-lang</artifactId>
+        <version>2.6</version>
+      </dependency>      
+    </dependencies>
+  </dependencyManagement>
 
   <build>
     <resources>
@@ -219,12 +218,13 @@
         <configuration>
           <overview>${basedir}/src/main/javadoc/overview.html</overview>
           <show>protected</show>
-          <detectLinks>false</detectLinks>
+          <nodeprecated>false</nodeprecated>
           <source>1.7</source>
+          <detectLinks>false</detectLinks>
           <links>
-            <link>http://www.norconex.com/product/commons-lang/apidocs/</link>
-            <link>http://www.norconex.com/collectors/committer-core/latest/apidocs/</link>
-            <link>http://commons.apache.org/proper/commons-configuration/apidocs/</link>
+            <link>https://www.norconex.com/product/commons-lang/apidocs/</link>
+            <link>https://www.norconex.com/collectors/committer-core/latest/apidocs/</link>
+            <link>https://commons.apache.org/proper/commons-configuration/javadocs/v1.10/apidocs/</link>
           </links>
         </configuration>
         <executions>
@@ -260,6 +260,14 @@
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-jar-plugin</artifactId>
         <version>2.6</version>
+        <configuration>
+          <archive>
+            <manifest>
+              <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
+              <addDefaultSpecificationEntries>true</addDefaultSpecificationEntries>
+            </manifest>
+          </archive>
+        </configuration>
         <executions>
           <execution>
             <goals>
@@ -340,6 +348,10 @@
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-project-info-reports-plugin</artifactId>
         <version>2.7</version>
+        <configuration>
+          <dependencyDetailsEnabled>false</dependencyDetailsEnabled>
+          <dependencyLocationsEnabled>false</dependencyLocationsEnabled>
+        </configuration>
         <reportSets>
           <reportSet>
             <reports>
@@ -356,7 +368,7 @@
           <header><![CDATA[
             <style>div.aboutLanguage .siteLink {font-size: 2em;}</style>
             <span class="siteLink">
-              <a target="_top" href="http://www.norconex.com/collectors/committer-idol">Norconex IDOL Committer</a>
+              <a target="_top" href="https://www.norconex.com/collectors/committer-idol">Norconex IDOL Committer</a>
             </span>
             ]]>
           </header>
@@ -374,15 +386,17 @@
             </script>
             <a style="font-size: 1.4em;" target="_top" href="https://github.com/norconex/committer-idol/issues">Submit an Issue</a>
             &nbsp;&nbsp;|&nbsp;&nbsp; 
-            <a style="font-size: 1.4em;" target="_top" href="http://www.norconex.com">www.norconex.com</a>
+            <a style="font-size: 1.4em;" target="_top" href="https://www.norconex.com">www.norconex.com</a>
             ]]>
           </footer>
           <show>protected</show>
-          <detectLinks>false</detectLinks>
+          <nodeprecated>false</nodeprecated>
+          <source>1.7</source>
+          <detectLinks>false</detectLinks>          
           <links>
-            <link>http://www.norconex.com/product/commons-lang/apidocs/</link>
-            <link>http://www.norconex.com/collectors/committer-core/latest/apidocs/</link>
-            <link>http://commons.apache.org/proper/commons-configuration/apidocs/</link>
+            <link>https://www.norconex.com/product/commons-lang/apidocs/</link>
+            <link>https://www.norconex.com/collectors/committer-core/latest/apidocs/</link>
+            <link>https://commons.apache.org/proper/commons-configuration/javadocs/v1.10/apidocs/</link>
           </links>
         </configuration>
         <reportSets>
@@ -398,41 +412,33 @@
       </plugin>
     </plugins>
   </reporting>
+
+  <organization>
+    <name>Norconex Inc.</name>
+    <url>https://www.norconex.com</url>
+  </organization>
+  <scm>
+    <url>https://github.com/Norconex/committer-idol</url>
+    <connection>scm:git:[email protected]:Norconex/committer-idol.git</connection>
+    <developerConnection>scm:git:[email protected]:Norconex/committer-idol.git</developerConnection>
+  </scm>
+  <issueManagement>
+    <system>GitHub</system>
+    <url>https://github.com/Norconex/committer-idol/issues</url>
+  </issueManagement>
   <developers>
-    <developer>
-      <id>jacobs</id>
-      <name>Stephen Jacob</name>
-      <email>[email protected]</email>
-      <organization>Norconex Inc.</organization>
-      <organizationUrl>http://www.norconex.com</organizationUrl>
-      <roles>
-        <role>developer</role>
-      </roles>
-      <timezone>-4</timezone>
-    </developer>
-    <developer>
-      <id>fourniem</id>
-      <name>Martin Fournier</name>
-      <email>[email protected]</email>
-      <organization>Norconex Inc.</organization>
-      <organizationUrl>http://www.norconex.com</organizationUrl>
-      <roles>
-        <role>developer</role>
-      </roles>
-      <timezone>-4</timezone>
-    </developer>
     <developer>
         <id>essiembp</id>
         <name>Pascal Essiembre</name>
         <email>[email protected]</email>
         <organization>Norconex Inc.</organization>
-        <organizationUrl>http://www.norconex.com</organizationUrl>
+        <organizationUrl>https://www.norconex.com</organizationUrl>
         <roles>
           <role>project leader</role>
           <role>developer</role>
         </roles>
         <timezone>-4</timezone>
     </developer>
   </developers>
-  <url>http://norconex.com/collectors/committer-idol/</url>
+  <url>https://www.norconex.com/collectors/committer-idol/</url>
 </project>
diff --git a/norconex-committer-idol/src/changes/changes.xml b/norconex-committer-idol/src/changes/changes.xml
@@ -7,6 +7,17 @@
   </properties>
   <body>
 
+    <release version="2.1.0" date="2016-08-29" description="Feature release">
+      <action dev="essiembre" type="add">
+        Now ships with new install script that automates copying of dependent 
+        libraries, taking into account possible version conflicts.
+      </action>
+      <action dev="essiembre" type="update">
+        Dependency updates: Norconex Committer Core 2.0.5, 
+        Norconex Commons Lang 1.12.0, Apache Commons Lang 2.6.
+      </action>
+    </release>
+
     <release version="2.0.1" date="2015-04-01" description="Maintenance release">
       <action dev="essiembre" type="update">
         Added Sonatype repository to pom.xml for snapshot releases.

diff --git a/norconex-committer-idol/src/main/assembly/NOTICE.txt b/norconex-committer-idol/src/main/assembly/NOTICE.txt
@@ -1,5 +1,5 @@
 Norconex IDOL Committer
-Copyright 2010-2014 Norconex Inc.
+Copyright 2010-2016 Norconex Inc.
 
 General Information:
 ====================
@@ -8,7 +8,7 @@ For any inquiries about Norconex IDOL Committer, please contact
 Norconex Inc. at [email protected].
 
 This product website and documentation is located at:
-http://www.norconex.com/collectors/committer-idol
+https://www.norconex.com/collectors/committer-idol
 
 Norconex licenses:
 ==================

diff --git a/norconex-committer-idol/src/main/assembly/dist.xml b/norconex-committer-idol/src/main/assembly/dist.xml
@@ -1,5 +1,5 @@
 <!-- 
-   Copyright 2010-2014 Norconex Inc.
+   Copyright 2010-2016 Norconex Inc.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -23,6 +23,13 @@
   <includeSiteDirectory>false</includeSiteDirectory>
 
   <fileSets>
+    <fileSet>
+      <directory>${basedir}/src/main/scripts</directory>
+      <includes>
+        <include>**</include>
+      </includes>
+      <outputDirectory>/</outputDirectory>
+    </fileSet>  
     <fileSet>
       <directory>${basedir}/src/main/assembly/</directory>
       <includes>

diff --git a/norconex-committer-idol/src/main/java/com/norconex/committer/idol/IdolCommitter.java b/norconex-committer-idol/src/main/java/com/norconex/committer/idol/IdolCommitter.java
@@ -534,7 +534,8 @@ private void postToIDOL(String url, String content) {
                 LOG.debug("Post parameters : " + content);
                 LOG.debug("Server Response Code : " + responseCode);
             }
-            String response = IOUtils.toString(con.getInputStream());
+            String response = IOUtils.toString(
+                    con.getInputStream(), CharEncoding.UTF_8);
             if ((isCFS() && !StringUtils.contains(response, "SUCCESS"))
                     || (!isCFS() 
                             && !StringUtils.contains(response, "INDEXID"))) {

diff --git a/norconex-committer-idol/src/main/javadoc/overview.html b/norconex-committer-idol/src/main/javadoc/overview.html
@@ -2,9 +2,9 @@
 
 <div style="text-align: center; font-weight: bold;">
 &nbsp;&nbsp;&nbsp;&nbsp;
-<a target="_top" href="http://www.norconex.com/collectors/committer-idol/">Web Site</a>
+<a target="_top" href="https://www.norconex.com/collectors/committer-idol/">Web Site</a>
 &nbsp;&nbsp;|&nbsp;&nbsp; 
-<a target="_top" href="http://www.norconex.com/collectors/committer-idol/support">Support</a>
+<a target="_top" href="https://www.norconex.com/collectors/committer-idol/support">Support</a>
 &nbsp;&nbsp;|&nbsp;&nbsp; 
 <a target="_top" href="https://github.com/norconex/committer-idol/issues">Issues</a>
 </div>

diff --git a/norconex-committer-idol/src/main/scripts/install.bat b/norconex-committer-idol/src/main/scripts/install.bat
@@ -0,0 +1,24 @@
+@echo off
+cd %~dp0
+
+echo.
+echo PLEASE READ CAREFULLY
+echo.
+echo To install this component and its dependencies into another product, 
+echo please specify the target product directory where libraries (.jar files)
+echo can be found.
+echo.
+echo This is often a "lib" directory. For example, to install this component  
+echo into the Norconex HTTP Collector, specify the full path to the Collector
+echo "lib" directory, which may look somewhat like this:
+echo. 
+echo    C:\MyProject\norconex-collector-http-x.x.x\lib
+echo.
+echo If .jar duplicates are found, you will be asked how you wish to deal with
+echo them. It is recommended to try keep most recent versions upon encountering
+echo version conflicts. When in doubt, simply choose the default option.
+echo.
+
+java -Dfile.encoding=UTF8 -cp "./lib/*" com.norconex.commons.lang.jar.JarCopier ./lib
+
+pause
diff --git a/norconex-committer-idol/src/main/scripts/install.sh b/norconex-committer-idol/src/main/scripts/install.sh
@@ -0,0 +1,22 @@
+#!/bin/sh
+cd $(dirname $0)
+
+echo ""
+echo "PLEASE READ CAREFULLY"
+echo ""
+echo "To install this component and its dependencies into another product,"
+echo "please specify the target product directory where libraries (.jar files)"
+echo "can be found."
+echo ""
+echo "This is often a "lib" directory. For example, to install this component"
+echo "into the Norconex HTTP Collector, specify the full path to the Collector"
+echo "\"lib\" directory, which may look somewhat like this:"
+echo ""
+echo "   /myProject/norconex-collector-http-x.x.x/lib"
+echo ""
+echo "If .jar duplicates are found, you will be asked how you wish to deal with"
+echo "them. It is recommended to try keep most recent versions upon encountering"
+echo "version conflicts. When in doubt, simply choose the default option."
+echo ""
+
+java -Dfile.encoding=UTF8 -cp "./lib/*" com.norconex.commons.lang.jar.JarCopier "./lib"