1 files changed, 79 insertions, 0 deletions
diff --git a/id/server/idserverlib/src/main/java/at/gv/egovernment/moa/id/proxy/ConnectionBuilder.java b/id/server/idserverlib/src/main/java/at/gv/egovernment/moa/id/proxy/ConnectionBuilder.java
new file mode 100644
index 000000000..8a8a55442
--- /dev/null
+++ b/id/server/idserverlib/src/main/java/at/gv/egovernment/moa/id/proxy/ConnectionBuilder.java
@@ -0,0 +1,79 @@
+/*
+* Copyright 2003 Federal Chancellery Austria
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*     http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+package at.gv.egovernment.moa.id.proxy;
+
+import java.io.IOException;
+import java.net.HttpURLConnection;
+import java.util.Vector;
+
+import javax.net.ssl.SSLSocketFactory;
+import javax.servlet.http.HttpServletRequest;
+
+/**
+ * Builder for {@link java.net.URLConnection} objects used to forward requests
+ * to the remote online application.
+ * 
+ * @author Paul Ivancsics
+ * @version $Id$
+ */
+
+public interface ConnectionBuilder {
+	
+	/**
+	 * Builds an HttpURLConnection to a {@link java.net.URL} which is derived
+	 * from an {@link HttpServletRequest} URL, by substitution of a 
+     * public URL prefix for the real URL prefix.<br>
+     * The HttpURLConnection has been created by {@link java.net.URL#openConnection}, but
+     * it has not yet been connected to by {@link java.net.URLConnection#connect}.<br>
+     * The field settings of the HttpURLConnection are:
+     * <ul>
+     * <li><code>allowUserInteraction = false</code></li>
+     * <li><code>doInput = true</code></li>
+     * <li><code>doOutput = true</code></li>
+     * <li><code>requestMethod = request.getMethod()</code></li>
+     * <li><code>useCaches = false</code></li>
+     * </ul>
+	 * 
+	 * @param request the incoming request which shall be forwarded
+	 * @param publicURLPrefix the public URL prefix to be substituted by the real URL prefix
+	 * @param realURLPrefix the URL prefix to substitute the public URL prefix
+	 * @param sslSocketFactory factory to be used for creating an SSL socket in case
+	 *         of a URL for scheme <code>"https:"</code>;
+	 * 				 <br>if <code>null</code>, the default SSL socket factory would be used 
+	 * @param parameters parameters to be forwarded
+	 * @return a URLConnection created by {@link java.net.URL#openConnection}, connecting to 
+	 * 					the requested URL with <code>publicURLPrefix</code> substituted by <code>realURLPrefix</code>
+	 * @throws IOException if an I/O exception occurs during opening the connection
+	 * @see java.net.URL#openConnection()
+	 * @see com.sun.net.ssl.HttpsURLConnection#getDefaultSSLSocketFactory()
+	 */
+	public HttpURLConnection buildConnection(
+		HttpServletRequest request,
+		String publicURLPrefix,
+		String realURLPrefix,
+		SSLSocketFactory sslSocketFactory,
+		Vector parameters) throws IOException;
+
+ 	
+    /**
+     * Disconnects the HttpURLConnection if necessary.
+     * The implementation of the Connectionbuilder decides wether 
+     * if this should be happen or not.
+     *
+     * @param con the HttpURLConnection which is normaly to be closed
+     */
+	public void disconnect(HttpURLConnection con);
+}