Merge pull request #21 from OpenAS2/dev

pete-gilchrist · web-flow · commit 700ed28098f7 · 2016-11-09T08:26:18.000Z
Merge latest changes for 2.1.3 release
diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt
@@ -1,16 +1,17 @@
               OpenAS2 Server
-              Version 2.1.2
+              Version 2.1.3
               RELEASE NOTES
 
-The OpenAS2 project is pleased to announce the release of OpenAS2 2.1.2
+The OpenAS2 project is pleased to announce the release of OpenAS2 2.1.3
 
-The release download file is: OpenAS2Server-2.1.2.zip
+The release download file is: OpenAS2Server-2.1.3.zip
 The zip file contains a PDF document providing information on installing and using the application.
 
-Version 2.1.2 - 2016-10-29
+Version 2.1.3 - 2016-11-09
 This release is a bugfix release:
-  1. Swap call to scan directory with the tracking processing call to ensure there is at least one full poll interval between scan and call to tracking processing to avoid sending incomplete files.
-  2. Add documentation on Java tuning for large fiules and/or busy AS2 systems
+  1. Revert to default for allowing restricted HTTP headers (see OpenAS2HowTo for discussion on this issue)
+  2. Remove \r (CR) character from logging and use the the system property to avoid issues on NIX based systems that parse logs
+  3. Enhance documentation
 
 Upgrade Notes (if upgrading from versions older than 2.1.0):
   1. Add the new module to your existing config.xml (see classname="org.openas2.processor.msgtracking.DbTrackingModule" in release config.xml)
diff --git a/Server/bin/start-openas2.bat b/Server/bin/start-openas2.bat
@@ -5,8 +5,8 @@ rem Set some of the base system properties for the Java environment and logging
 rem remove -Dorg.apache.commons.logging.Log=org.openas2.logging.Log if using another logging package
 rem
 set EXTRA_PARMS=-Xms32m -Xmx384m  -Dorg.apache.commons.logging.Log=org.openas2.logging.Log
-rem By default allow restricted HTTP headers
-set EXTRA_PARMS=%EXTRA_PARMS% -Dsun.net.http.allowRestrictedHeaders=true
+rem For versions of Java that prevent restricted HTTP headers (see documentation for discussion on this)
+rem set EXTRA_PARMS=%EXTRA_PARMS% -Dsun.net.http.allowRestrictedHeaders=true
 
 rem Uncomment any of the following for enhanced debug
 rem set EXTRA_PARMS=%EXTRA_PARMS% -Dmaillogger.debug.enabled=true
diff --git a/Server/bin/start-openas2.sh b/Server/bin/start-openas2.sh
@@ -10,8 +10,8 @@ PWD_OVERRIDE=""
 # remove -Dorg.apache.commons.logging.Log=org.openas2.logging.Log if using another logging package    
 #
 EXTRA_PARMS="-Xms32m -Xmx384m -Dorg.apache.commons.logging.Log=org.openas2.logging.Log"
-# By default allow restricted HTTP headers
-EXTRA_PARMS="$EXTRA_PARMS -Dsun.net.http.allowRestrictedHeaders=true"
+# For versions of Java that prevent restricted HTTP headers (see documentation for discussion on this)
+#EXTRA_PARMS="$EXTRA_PARMS -Dsun.net.http.allowRestrictedHeaders=true"
 # Uncomment any of the following for enhanced debug
 #EXTRA_PARMS="$EXTRA_PARMS -Dmaillogger.debug.enabled=true"
 #EXTRA_PARMS="$EXTRA_PARMS -DlogRxdMsgMimeBodyParts=true"
diff --git a/Server/dist/OpenAS2Server-2.1.3.zip b/Server/dist/OpenAS2Server-2.1.3.zip
diff --git a/Server/lib/openas2-server.jar b/Server/lib/openas2-server.jar
diff --git a/Server/src/org/openas2/Session.java b/Server/src/org/openas2/Session.java
@@ -20,7 +20,7 @@
  */
 public interface Session {
     /** Official OpenAS2 release version */
-    public static final String VERSION = "2.1.2";
+    public static final String VERSION = "2.1.3";
 
     /** Official OpenAS2 title */
     public static final String TITLE = "OpenAS2 v" + VERSION;
diff --git a/Server/src/org/openas2/app/OpenAS2Server.java b/Server/src/org/openas2/app/OpenAS2Server.java
@@ -47,32 +47,32 @@ public void run()
 		try {
 			Log logger = LogFactory.getLog(OpenAS2Server.class.getSimpleName());
 			
-			write(Session.TITLE + "\r\nStarting Server...\r\n");
+			write(Session.TITLE + System.getProperty("line.separator") + "Starting Server..." + System.getProperty("line.separator"));
 
 			// create the OpenAS2 Session object
 			// this is used by all other objects to access global configs and functionality
-			write("Loading configuration...\r\n");
+			write("Loading configuration..." + System.getProperty("line.separator"));
 
 			if (args.length > 0) {
 				session = new XMLSession(args[0]);
 			} else {
-				write("Usage:\r\n");
-				write("java org.openas2.app.OpenAS2Server <configuration file>\r\n");
+				write("Usage:" + System.getProperty("line.separator"));
+				write("java org.openas2.app.OpenAS2Server <configuration file>" + System.getProperty("line.separator"));
 				throw new Exception("Missing configuration file");
 			}
 			// create a command processor
 
 			// get a registry of Command objects, and add Commands for the Session
-			write("Registering Session to Command Processor...\r\n");
+			write("Registering Session to Command Processor..." + System.getProperty("line.separator"));
 
 			CommandRegistry reg = session.getCommandRegistry();
 
 			// start the active processor modules
-			write("Starting Active Modules...\r\n");
+			write("Starting Active Modules..." + System.getProperty("line.separator"));
 			session.getProcessor().startActiveModules();
 
 			// enter the command processing loop
-			write("OpenAS2 V" + Session.VERSION + " Started\r\n");
+			write("OpenAS2 V" + Session.VERSION + " Started" + System.getProperty("line.separator"));
 
 			
 			logger.info("- OpenAS2 Started - V" + Session.VERSION);
@@ -81,7 +81,7 @@ public void run()
 			List<BaseCommandProcessor> processors = cmdMgr.getProcessors();
 			for (int i = 0; i < processors.size(); i++) {
 				write("Loading Command Processor..." + processors.toString()
-						+ "\r\n");
+						+ System.getProperty("line.separator"));
 				cmd = (BaseCommandProcessor) processors.get(i);
 				cmd.init();
 				cmd.addCommands(reg);
diff --git a/Server/src/org/openas2/logging/DefaultFormatter.java b/Server/src/org/openas2/logging/DefaultFormatter.java
@@ -12,7 +12,7 @@
 
 public class DefaultFormatter extends BaseFormatter {
     public String getTerminatedMessage(OpenAS2Exception exception) {
-        StringBuffer buf = new StringBuffer("Termination of exception:\r\n");
+        StringBuffer buf = new StringBuffer("Termination of exception:" + System.getProperty("line.separator"));
 
         // Write exception trace
         StringWriter strWriter = new StringWriter();
@@ -27,8 +27,8 @@ public String getTerminatedMessage(OpenAS2Exception exception) {
 
         while (sourceIt.hasNext()) {
             source = sourceIt.next();
-            buf.append(source.getKey().toString()).append("\r\n");
-            buf.append(source.getValue().toString()).append("\r\n\r\n");
+            buf.append(source.getKey().toString()).append(System.getProperty("line.separator"));
+            buf.append(source.getValue().toString()).append(System.getProperty("line.separator")).append(System.getProperty("line.separator"));
         }
 
         return buf.toString();
diff --git a/Server/src/org/openas2/logging/EmailLogger.java b/Server/src/org/openas2/logging/EmailLogger.java
@@ -118,7 +118,7 @@ protected void doLog(OpenAS2Exception exception, boolean terminated) {
                 body.append(parseText(exception, terminated, getParameter(PARAM_BODY, false)));
             }
 
-            body.append("\r\n");
+            body.append(System.getProperty("line.separator"));
 
             if (getParameter(PARAM_BODYTEMPLATE, false) != null) {
                 body.append(parseText(exception, terminated, getTemplateText()));
diff --git a/Server/src/org/openas2/message/BaseMessage.java b/Server/src/org/openas2/message/BaseMessage.java
@@ -285,7 +285,7 @@ public String toString() {
         buf.append("To:").append(getPartnership().getReceiverIDs());
 
         Enumeration<Header> headerEn = getHeaders().getAllHeaders();
-        buf.append("\r\nHeaders:{");
+        buf.append(System.getProperty("line.separator") + "Headers:{");
 
         while (headerEn.hasMoreElements()) {
             Header header = headerEn.nextElement();
@@ -297,12 +297,12 @@ public String toString() {
         }
 
         buf.append("}");
-        buf.append("\r\nAttributes:").append(getAttributes());
+        buf.append(System.getProperty("line.separator") + "Attributes:").append(getAttributes());
 
         MessageMDN mdn = getMDN();
 
         if (mdn != null) {
-            buf.append("\r\nMDN:");
+            buf.append(System.getProperty("line.separator") + "MDN:");
             buf.append(mdn.toString());
         }
 
diff --git a/Server/src/org/openas2/message/BaseMessageMDN.java b/Server/src/org/openas2/message/BaseMessageMDN.java
@@ -153,7 +153,7 @@ public String toString() {
         buf.append("To:").append(getPartnership().getSenderIDs());
         
         Enumeration<Header> headerEn = getHeaders().getAllHeaders();
-        buf.append("\r\nHeaders:{");
+        buf.append(System.getProperty("line.separator") + "Headers:{");
 
         while (headerEn.hasMoreElements()) {
             Header header = headerEn.nextElement();
@@ -165,9 +165,9 @@ public String toString() {
         }
 
         buf.append("}");
-        buf.append("\r\nAttributes:").append(getAttributes());
-        buf.append("\r\nText: \r\n");
-        buf.append(getText()).append("\r\n");
+        buf.append(System.getProperty("line.separator") + "Attributes:").append(getAttributes());
+        buf.append(System.getProperty("line.separator") + "Text: " + System.getProperty("line.separator"));
+        buf.append(getText()).append(System.getProperty("line.separator"));
 
         return buf.toString();
     }
diff --git a/Server/src/org/openas2/processor/storage/MDNFileModule.java b/Server/src/org/openas2/processor/storage/MDNFileModule.java
@@ -56,31 +56,31 @@ protected InputStream getMDNStream(MessageMDN mdn) throws IOException {
         StringBuffer mdnBuf = new StringBuffer();
 
         // write headers to the string buffer
-        mdnBuf.append("Headers:\r\n");
+        mdnBuf.append("Headers:" + System.getProperty("line.separator"));
 
         Enumeration<String> headers = mdn.getHeaders().getAllHeaderLines();
         String header;
 
         while (headers.hasMoreElements()) {
             header = headers.nextElement();
-            mdnBuf.append(header).append("\r\n");
+            mdnBuf.append(header).append(System.getProperty("line.separator"));
         }
 
-        mdnBuf.append("\r\n");
+        mdnBuf.append(System.getProperty("line.separator"));
 
         // write attributes to the string buffer
-        mdnBuf.append("Attributes:\r\n");
+        mdnBuf.append("Attributes:" + System.getProperty("line.separator"));
 
         Iterator<Map.Entry<String,String>> attrIt = mdn.getAttributes().entrySet().iterator();
         Map.Entry<?, String> attrEntry;
 
         while (attrIt.hasNext()) {
             attrEntry = attrIt.next();
             mdnBuf.append(attrEntry.getKey()).append(": ");
-            mdnBuf.append(attrEntry.getValue()).append("\r\n");
+            mdnBuf.append(attrEntry.getValue()).append(System.getProperty("line.separator"));
         }
      // finaly, write the MDN text
-        mdnBuf.append("Text:\r\n");
+        mdnBuf.append("Text:" + System.getProperty("line.separator"));
         mdnBuf.append(mdn.getText());
         
         return new ByteArrayInputStream(mdnBuf.toString().getBytes());
diff --git a/Server/src/org/openas2/processor/storage/MessageFileModule.java b/Server/src/org/openas2/processor/storage/MessageFileModule.java
@@ -74,28 +74,28 @@ protected InputStream getHeaderStream(Message msg) throws IOException {
         StringBuffer headerBuf = new StringBuffer();
 
         // write headers to the string buffer
-        headerBuf.append("Headers:\r\n");
+        headerBuf.append("Headers:" + System.getProperty("line.separator"));
 
         Enumeration<String> headers = msg.getHeaders().getAllHeaderLines();
         String header;
 
         while (headers.hasMoreElements()) {
             header = (String) headers.nextElement();
-            headerBuf.append(header).append("\r\n");
+            headerBuf.append(header).append(System.getProperty("line.separator"));
         }
 
-        headerBuf.append("\r\n");
+        headerBuf.append(System.getProperty("line.separator"));
 
         // write attributes to the string buffer
-        headerBuf.append("Attributes:\r\n");
+        headerBuf.append("Attributes:" + System.getProperty("line.separator"));
 
         Iterator<Map.Entry<String,String>> attrIt = msg.getAttributes().entrySet().iterator();
         Map.Entry<String,String> attrEntry;
 
         while (attrIt.hasNext()) {
             attrEntry = attrIt.next();
             headerBuf.append(attrEntry.getKey()).append(": ");
-            headerBuf.append(attrEntry.getValue()).append("\r\n");
+            headerBuf.append(attrEntry.getValue()).append(System.getProperty("line.separator"));
         }
 
         return new ByteArrayInputStream(headerBuf.toString().getBytes());
diff --git a/Server/src/org/openas2/test/MimeBodyPartEncodingTest.java b/Server/src/org/openas2/test/MimeBodyPartEncodingTest.java
@@ -45,34 +45,34 @@ public static void main(String[] args)
 		System.setProperty("org.apache.commons.logging.Log", "org.openas2.logging.Log");
 		//System.setProperty("openas2log.properties", "Server/bin/openas2log.properties");
 		LogFactory.getFactory().setAttribute("level", "TRACE");
-		System.out.println("Current working directory: " + System.getProperty("user.dir") + "\n");
-		System.out.println("Logging prop: " + System.getProperty("org.apache.commons.logging.Log") + "\n");
+		System.out.println("Current working directory: " + System.getProperty("user.dir") + System.getProperty("line.separator"));
+		System.out.println("Logging prop: " + System.getProperty("org.apache.commons.logging.Log") + System.getProperty("line.separator"));
 		File f = new File(TestConfig.TEST_OUTPUT_FOLDER);
 		f.mkdirs();
 
 		try
 		{
-			write(Session.TITLE + "\r\nStarting test...\r\n");
+			write(Session.TITLE + System.getProperty("line.separator") + "Starting test..." + System.getProperty("line.separator"));
 
 			// create the OpenAS2 Session object
 			// this is used by all other objects to access global configs and
 			// functionality
-			write("Loading configuration...\r\n");
+			write("Loading configuration..." + System.getProperty("line.separator"));
 			String configFile = "Server/config/config.xml";
 			if (args.length == 1)
 			{
 				configFile = args[0];
 			}
 		    else if (args.length > 1)
 			{
-				write("Current working directory: " + System.getProperty("user.dir") + "\n");
-				write("Usage:\r\n");
-				write("java org.openas2.app.OpenAS2Server <configuration file>\r\n");
+				write("Current working directory: " + System.getProperty("user.dir") + System.getProperty("line.separator"));
+				write("Usage:" + System.getProperty("line.separator"));
+				write("java org.openas2.app.OpenAS2Server <configuration file>" + System.getProperty("line.separator"));
 				throw new Exception("Missing configuration file");
 			}
 			session = new XMLSession(configFile);
 			// Do the deed...
-			write("Entering test phase....\r\n");
+			write("Entering test phase...." + System.getProperty("line.separator"));
 			Message msg = new AS2Message();
 			getPartnerInfo(msg);
 			// update the message's partnership with any stored information
@@ -81,7 +81,7 @@ else if (args.length > 1)
 			write("Partnership attributes:\n" + msg.getPartnership().getName());
 			for (String key : attribs.keySet())
 			{
-				write("\t" + key + " ::= " + attribs.get(key) + "\n");
+				write("\t" + key + " ::= " + attribs.get(key) + System.getProperty("line.separator"));
 			}
 
 			msg.setAttribute(FileAttribute.MA_FILEPATH, TestConfig.TEST_SOURCE_FOLDER);
@@ -107,7 +107,7 @@ else if (args.length > 1)
 			String contentTxfrEncoding = msg.getPartnership().getAttribute(Partnership.PA_CONTENT_TRANSFER_ENCODING);
 			if (contentTxfrEncoding == null)
 				contentTxfrEncoding = Session.DEFAULT_CONTENT_TRANSFER_ENCODING;
-			write("Using Content-Transfer-Encoding: " + contentTxfrEncoding + "\n");
+			write("Using Content-Transfer-Encoding: " + contentTxfrEncoding + System.getProperty("line.separator"));
 			body.addHeader("Content-Transfer-Encoding", contentTxfrEncoding);
 			
 			msg.setData(body);
@@ -163,17 +163,17 @@ else if (args.length > 1)
 		} finally
 		{
 
-			write("OpenAS2 test has shut down\r\n");
+			write("OpenAS2 test has shut down." + System.getProperty("line.separator"));
 
 			System.exit(exitStatus);
 		}
 	}
 
 	public static void write(OutputStream os, MimeBodyPart mbp) throws MessagingException, IOException
 	{
-		os.write("\n========BEGIN MIMEBODYPART=========\n".getBytes());
+		os.write((System.getProperty("line.separator") + "========BEGIN MIMEBODYPART=========" + System.getProperty("line.separator")).getBytes());
 		mbp.writeTo(os);
-		os.write("\n========END MIMEBODYPART=========\n".getBytes());
+		os.write((System.getProperty("line.separator") + "========END MIMEBODYPART=========" + System.getProperty("line.separator")).getBytes());
 	}
 
 	public static void write(String msg)
diff --git a/changes.txt b/changes.txt
@@ -1,3 +1,9 @@
+Version 2.1.3 - 2016-11-09
+This release is a bugfix release:
+  1. Revert to default for allowing restricted HTTP headers (see OpenAS2HowTo for discussion on this issue)
+  2. Remove \r (CR) character from logging and use the the system property to avoid issues on NIX based systems that parse logs
+  3. Enhance documentation
+
 Version 2.1.2 - 2016-10-29
 This release is a bugfix release:
   1. Swap call to scan directory with the tracking processing call to ensure there is at least one full poll interval between scan and call to tracking processing to avoid sending incomplete files.
diff --git a/docs/OpenAS2HowTo.odt b/docs/OpenAS2HowTo.odt
diff --git a/docs/OpenAS2HowTo.pdf b/docs/OpenAS2HowTo.pdf

Original file line number	Diff line number	Diff line change
`@@ -118,7 +118,7 @@ protected void doLog(OpenAS2Exception exception, boolean terminated) {`
`118`	`118`	`body.append(parseText(exception, terminated, getParameter(PARAM_BODY, false)));`
`119`	`119`	`}`
`120`	`120`
`121`		`- body.append("\r\n");`
	`121`	`+ body.append(System.getProperty("line.separator"));`
`122`	`122`
`123`	`123`	`if (getParameter(PARAM_BODYTEMPLATE, false) != null) {`
`124`	`124`	`body.append(parseText(exception, terminated, getTemplateText()));`