Logging issues fixed:

 - Added possibility to configure logging of BKUWebstart. Logging is now configured from log4j configuration deployed with BKUWebstart in a first step. In a second step the webstart launcher looks for a log4j configuration file in the user's mooca configuration directory and updates the log4j configuration.
 - Logging of IAIK PKI properly initialized. IAIK PKI does not mess with the log4j configuration any longer.
 - Changed log4j accordingly (an appender is now needed as IAIK PKI does not reconfigure log4j any longer).

Added css-stylesheet to ErrorResponses issued by the BKU to improve the presentation to the user.

Changed dependencies of BKUWebStart (see Issue#469 https://egovlabs.gv.at/tracker/index.php?func=detail&aid=469&group_id=13&atid=134).

DataURLConnection now uses the request encoding of SL < 1.2. application/x-www-form-urlencoded is now used as default encoding method. multipart/form-data is used only if transfer parameters are present in the request that require a Content-Type parameter. This can only be set with multipart/form-data. This is not in conformance with SL 1.2, however it should improve compatibility with applications. 

Therefore, removed the ability to configure the DataURLConnection implementation class.

DataURLConnection now uses a streaming implementation for encoding of application/x-www-form-urlencoded requests. 

XWWWFormUrlImputDecoder now uses a streaming implementation for decoding of application/x-www-form-urlencoded requests.

Fixed Bug in SLResultPart that caused a binary response to be provided as parameter "XMLResponse" in a multipart/form-data encoded request to DataURL.

SLCommandFactory now supports unmarshalling of SL < 1.2 requests in order issue meaningful error messages. Therefore, the marshaling context for response marshaling had to be separated from the marshaling context for requests in order to avoid the marshaling of SL < 1.2 namespace prefixes in SL 1.2 responses.

Target attribute in QualifiedProperties is now marshaled. (see Issue#470 https://egovlabs.gv.at/tracker/index.php?func=detail&aid=470&group_id=13&atid=134)

Reporting of XML validation errors improved.

git-svn-id: https://joinup.ec.europa.eu/svn/mocca/trunk@510 8a26b1a7-26f0-462f-b9ef-d0e30c41f5a4

1 files changed, 296 insertions, 46 deletions

diff --git a/bkucommon/src/main/java/at/gv/egiz/bku/binding/DataUrlConnectionImpl.java b/bkucommon/src/main/java/at/gv/egiz/bku/binding/DataUrlConnectionImpl.java
index 4f2d2e00..b092ba41 100644
--- a/bkucommon/src/main/java/at/gv/egiz/bku/binding/DataUrlConnectionImpl.java
+++ b/bkucommon/src/main/java/at/gv/egiz/bku/binding/DataUrlConnectionImpl.java
@@ -18,10 +18,14 @@ package at.gv.egiz.bku.binding;
 
 import java.io.IOException;
 import java.io.InputStream;
+import java.io.InputStreamReader;
 import java.io.OutputStream;
+import java.io.OutputStreamWriter;
 import java.net.HttpURLConnection;
 import java.net.SocketTimeoutException;
 import java.net.URL;
+import java.net.URLEncoder;
+import java.nio.charset.Charset;
 import java.security.cert.X509Certificate;
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -34,6 +38,7 @@ import java.util.Set;
 import javax.net.ssl.HostnameVerifier;
 import javax.net.ssl.HttpsURLConnection;
 import javax.net.ssl.SSLSocketFactory;
+import javax.xml.transform.stream.StreamResult;
 
 import org.apache.commons.httpclient.methods.multipart.FilePart;
 import org.apache.commons.httpclient.methods.multipart.Part;
@@ -47,32 +52,92 @@ import at.gv.egiz.bku.conf.Configurator;
 import at.gv.egiz.bku.slcommands.SLResult;
 import at.gv.egiz.bku.slcommands.SLResult.SLResultType;
 import at.gv.egiz.bku.slexceptions.SLRuntimeException;
+import at.gv.egiz.bku.utils.URLEncodingWriter;
 import at.gv.egiz.bku.utils.binding.Protocol;
 
 /**
- * not thread-safe thus newInsance always returns a new object
+ * An implementation of the DataUrlConnectionSPI that supports
+ * <code>multipart/form-data</code> encoding and
+ * <code>application/x-www-form-urlencoded</code> for compatibility with legacy
+ * systems.
  * 
  */
 public class DataUrlConnectionImpl implements DataUrlConnectionSPI {
 
   private final static Log log = LogFactory.getLog(DataUrlConnectionImpl.class);
+  
+  public static final byte[] B_DEFAULT_RESPONSETYPE = DEFAULT_RESPONSETYPE.getBytes(Charset.forName("UTF-8"));
 
+  /**
+   * Supported protocols are HTTP and HTTPS. 
+   */
   public final static Protocol[] SUPPORTED_PROTOCOLS = { Protocol.HTTP,
       Protocol.HTTPS };
 
+  /**
+   * The X509 certificate of the DataURL server.
+   */
   protected X509Certificate serverCertificate;
+  
+  /**
+   * The protocol of the DataURL.
+   */
   protected Protocol protocol;
+  
+  /**
+   * Use <code>application/x-www-form-urlencoded</code> instead of
+   * standard conform <code>application/x-www-form-urlencoded</code>.
+   */
+  protected boolean urlEncoded = true;
+  
+  /**
+   * The value of the DataURL.
+   */
   protected URL url;
+  
+  /**
+   * The URLConnection used for communication with the DataURL server.
+   */
   private HttpURLConnection connection;
+  
+  /**
+   * The HTTP request headers.
+   */
   protected Map<String, String> requestHttpHeaders;
-  protected ArrayList<Part> formParams;
+  
+  /**
+   * The HTTP form parameters.
+   */
+  protected ArrayList<HTTPFormParameter> httpFormParameter;
+  
+  /**
+   * The boundary for multipart/form-data requests.
+   */
   protected String boundary;
+  
+  /**
+   * The configuration properties.
+   */
   protected Properties config = null;
+  
+  /**
+   * The SSLSocketFactory for HTTPS connections.
+   */
   protected SSLSocketFactory sslSocketFactory;
+  
+  /**
+   * The HostnameVerifier for HTTPS connections. 
+   */
   protected HostnameVerifier hostnameVerifier;
 
+  /**
+   * The response of the DataURL server.
+   */
   protected DataUrlResponse result;
 
+  /* (non-Javadoc)
+   * @see at.gv.egiz.bku.binding.DataUrlConnection#getProtocol()
+   */
   public String getProtocol() {
     if (protocol == null) {
       return null;
@@ -80,13 +145,8 @@ public class DataUrlConnectionImpl implements DataUrlConnectionSPI {
     return protocol.toString();
   }
 
-  /**
-   * opens a connection sets the headers gets the server certificate
-   * 
-   * @throws java.net.SocketTimeoutException
-   * @throws java.io.IOException
-   * @pre url != null
-   * @pre httpHeaders != null
+  /* (non-Javadoc)
+   * @see at.gv.egiz.bku.binding.DataUrlConnection#connect()
    */
   public void connect() throws SocketTimeoutException, IOException {
     connection = (HttpURLConnection) url.openConnection();
@@ -104,9 +164,26 @@ public class DataUrlConnectionImpl implements DataUrlConnectionSPI {
         https.setHostnameVerifier(hostnameVerifier);
       }
     } else {
-      log.trace("No secure connection with: "+url+ " class="+connection.getClass());
+      log.trace("No secure connection with: " + url + " class="
+          + connection.getClass());
     }
     connection.setDoOutput(true);
+    // Transfer-Encoding: chunked is problematic ...
+    // e.g. https://issues.apache.org/bugzilla/show_bug.cgi?id=37794
+    // ... therefore disabled.
+    // connection.setChunkedStreamingMode(5*1024);
+    if (urlEncoded) {
+      log.debug("Setting DataURL Content-Type to "
+          + HttpUtil.APPLICATION_URL_ENCODED);
+      connection.addRequestProperty(HttpUtil.HTTP_HEADER_CONTENT_TYPE,
+          HttpUtil.APPLICATION_URL_ENCODED);
+    } else {
+      log.debug("Setting DataURL Content-Type to "
+          + HttpUtil.MULTIPART_FOTMDATA_BOUNDARY);
+      connection.addRequestProperty(HttpUtil.HTTP_HEADER_CONTENT_TYPE,
+          HttpUtil.MULTIPART_FOTMDATA + HttpUtil.SEPERATOR[0]
+              + HttpUtil.MULTIPART_FOTMDATA_BOUNDARY + "=" + boundary);
+    }
     Set<String> headers = requestHttpHeaders.keySet();
     Iterator<String> headerIt = headers.iterator();
     while (headerIt.hasNext()) {
@@ -125,51 +202,128 @@ public class DataUrlConnectionImpl implements DataUrlConnectionSPI {
     }
   }
 
+  /* (non-Javadoc)
+   * @see at.gv.egiz.bku.binding.DataUrlConnection#getServerCertificate()
+   */
   public X509Certificate getServerCertificate() {
     return serverCertificate;
   }
 
+  /* (non-Javadoc)
+   * @see at.gv.egiz.bku.binding.DataUrlConnection#setHTTPHeader(java.lang.String, java.lang.String)
+   */
   public void setHTTPHeader(String name, String value) {
     if (name != null && value != null) {
       requestHttpHeaders.put(name, value);
     }
   }
 
+  /* (non-Javadoc)
+   * @see at.gv.egiz.bku.binding.DataUrlConnection#setHTTPFormParameter(java.lang.String, java.io.InputStream, java.lang.String, java.lang.String, java.lang.String)
+   */
   public void setHTTPFormParameter(String name, InputStream data,
       String contentType, String charSet, String transferEncoding) {
-    InputStreamPartSource source = new InputStreamPartSource(null, data);
-    FilePart formParam = new FilePart(name, source, contentType, charSet);
-    if (transferEncoding != null) {
-      formParam.setTransferEncoding(transferEncoding);
-    } else {
-      formParam.setTransferEncoding(null);
+    // if a content type is specified we have to switch to multipart/formdata encoding
+    if (contentType != null && contentType.length() > 0) {
+      urlEncoded = false;
     }
-    formParams.add(formParam);
+    httpFormParameter.add(new HTTPFormParameter(name, data, contentType,
+        charSet, transferEncoding));
   }
 
-  /**
-   * send all formParameters
-   * 
-   * @throws java.io.IOException
+  
+  
+  /* (non-Javadoc)
+   * @see at.gv.egiz.bku.binding.DataUrlConnection#transmit(at.gv.egiz.bku.slcommands.SLResult)
    */
   public void transmit(SLResult slResult) throws IOException {
-    SLResultPart slResultPart = new SLResultPart(slResult,
-        XML_RESPONSE_ENCODING);
-    if (slResult.getResultType() == SLResultType.XML) {
-      slResultPart.setTransferEncoding(null);
-      slResultPart.setContentType(slResult.getMimeType());
-      slResultPart.setCharSet(XML_RESPONSE_ENCODING);
+    log.trace("Sending data");
+    if (urlEncoded) {
+      //
+      // application/x-www-form-urlencoded (legacy, SL < 1.2)
+      //
+      
+      OutputStream os = connection.getOutputStream();
+      OutputStreamWriter streamWriter = new OutputStreamWriter(os, HttpUtil.DEFAULT_CHARSET);
+
+      // ResponseType
+      streamWriter.write(FORMPARAM_RESPONSETYPE);
+      streamWriter.write("=");
+      streamWriter.write(URLEncoder.encode(DEFAULT_RESPONSETYPE, "UTF-8"));
+      streamWriter.write("&");
+      
+      // XMLResponse / Binary Response
+      if (slResult.getResultType() == SLResultType.XML) {
+        streamWriter.write(DataUrlConnection.FORMPARAM_XMLRESPONSE);
+      } else {
+        streamWriter.write(DataUrlConnection.FORMPARAM_BINARYRESPONSE);
+      }
+      streamWriter.write("=");
+      streamWriter.flush();
+      URLEncodingWriter urlEnc = new URLEncodingWriter(streamWriter);
+      slResult.writeTo(new StreamResult(urlEnc), false);
+      urlEnc.flush();
+
+      // transfer parameters
+      char[] cbuf = new char[512];
+      int len;
+      for (HTTPFormParameter formParameter : httpFormParameter) {
+        streamWriter.write("&");
+        streamWriter.write(URLEncoder.encode(formParameter.getName(), "UTF-8"));
+        streamWriter.write("=");
+        InputStreamReader reader = new InputStreamReader(formParameter.getData(), 
+            (formParameter.getCharSet() != null) 
+                ? formParameter.getCharSet()
+                : null);
+        while ((len = reader.read(cbuf)) != -1) {
+          urlEnc.write(cbuf, 0, len);
+        }
+        urlEnc.flush();
+      }
+      streamWriter.close();
+      
     } else {
-      slResultPart.setTransferEncoding(null);
-      slResultPart.setContentType(slResult.getMimeType());
-    }
-    formParams.add(slResultPart);
+      //
+      // multipart/form-data (conforming to SL 1.2)
+      //
 
-    OutputStream os = connection.getOutputStream();
-    log.trace("Sending data");
-    Part[] parts = new Part[formParams.size()];
-    Part.sendParts(os, formParams.toArray(parts), boundary.getBytes());
-    os.close();
+      ArrayList<Part> parts = new ArrayList<Part>();
+
+      // ResponseType
+      StringPart responseType = new StringPart(FORMPARAM_RESPONSETYPE,
+          DEFAULT_RESPONSETYPE, "UTF-8");
+      responseType.setTransferEncoding(null);
+      parts.add(responseType);
+      
+      // XMLResponse / Binary Response
+      SLResultPart slResultPart = new SLResultPart(slResult,
+          XML_RESPONSE_ENCODING);
+      if (slResult.getResultType() == SLResultType.XML) {
+        slResultPart.setTransferEncoding(null);
+        slResultPart.setContentType(slResult.getMimeType());
+        slResultPart.setCharSet(XML_RESPONSE_ENCODING);
+      } else {
+        slResultPart.setTransferEncoding(null);
+        slResultPart.setContentType(slResult.getMimeType());
+      }
+      parts.add(slResultPart);
+      
+      // transfer parameters
+      for (HTTPFormParameter formParameter : httpFormParameter) {
+        InputStreamPartSource source = new InputStreamPartSource(null,
+            formParameter.getData());
+        FilePart part = new FilePart(formParameter.getName(), source,
+            formParameter.getContentType(), formParameter.getCharSet());
+        part.setTransferEncoding(formParameter.getTransferEncoding());
+        parts.add(part);
+      }
+
+      OutputStream os = connection.getOutputStream();
+      Part.sendParts(os, parts.toArray(new Part[parts.size()]), boundary.getBytes());
+      os.close();
+      
+    }
+    
     // MultipartRequestEntity PostMethod
     InputStream is = null;
     try {
@@ -241,16 +395,9 @@ public class DataUrlConnectionImpl implements DataUrlConnectionSPI {
           .put(HttpUtil.HTTP_HEADER_USER_AGENT, Configurator.USERAGENT_DEFAULT);
 
     }
-    requestHttpHeaders.put(HttpUtil.HTTP_HEADER_CONTENT_TYPE,
-        HttpUtil.MULTIPART_FOTMDATA + HttpUtil.SEPERATOR[0]
-            + HttpUtil.MULTIPART_FOTMDATA_BOUNDARY + "=" + boundary);
-
-    formParams = new ArrayList<Part>();
-    StringPart responseType = new StringPart(FORMPARAM_RESPONSETYPE,
-        DEFAULT_RESPONSETYPE);
-    responseType.setCharSet("UTF-8");
-    responseType.setTransferEncoding(null);
-    formParams.add(responseType);
+
+    httpFormParameter = new ArrayList<HTTPFormParameter>();
+
   }
 
   @Override
@@ -281,4 +428,107 @@ public class DataUrlConnectionImpl implements DataUrlConnectionSPI {
   public void setHostnameVerifier(HostnameVerifier hostnameVerifier) {
     this.hostnameVerifier = hostnameVerifier;
   }
+  
+  public class HTTPFormParameter {
+
+    private String name; 
+    
+    private InputStream data;
+    
+    private String contentType;
+    
+    private String charSet;
+    
+    private String transferEncoding;
+    
+    /**
+     * @param name
+     * @param data
+     * @param contentType
+     * @param charSet
+     * @param transferEncoding
+     */
+    public HTTPFormParameter(String name, InputStream data, String contentType,
+        String charSet, String transferEncoding) {
+      super();
+      this.name = name;
+      this.data = data;
+      this.contentType = contentType;
+      this.charSet = charSet;
+      this.transferEncoding = transferEncoding;
+    }
+
+    /**
+     * @return the name
+     */
+    public String getName() {
+      return name;
+    }
+
+    /**
+     * @param name the name to set
+     */
+    public void setName(String name) {
+      this.name = name;
+    }
+
+    /**
+     * @return the data
+     */
+    public InputStream getData() {
+      return data;
+    }
+
+    /**
+     * @param data the data to set
+     */
+    public void setData(InputStream data) {
+      this.data = data;
+    }
+
+    /**
+     * @return the contentType
+     */
+    public String getContentType() {
+      return contentType;
+    }
+
+    /**
+     * @param contentType the contentType to set
+     */
+    public void setContentType(String contentType) {
+      this.contentType = contentType;
+    }
+
+    /**
+     * @return the charSet
+     */
+    public String getCharSet() {
+      return charSet;
+    }
+
+    /**
+     * @param charSet the charSet to set
+     */
+    public void setCharSet(String charSet) {
+      this.charSet = charSet;
+    }
+
+    /**
+     * @return the transferEncoding
+     */
+    public String getTransferEncoding() {
+      return transferEncoding;
+    }
+
+    /**
+     * @param transferEncoding the transferEncoding to set
+     */
+    public void setTransferEncoding(String transferEncoding) {
+      this.transferEncoding = transferEncoding;
+    }
+
+    
+    
+  }
 }
\ No newline at end of file