Added example for custom header

marci4 · marci4 · commit e59362f86a09 · 2018-01-29T19:06:30.000+01:00
Fixes TooTallNate#490
diff --git a/src/main/example/CustomHeaderClientExample.java b/src/main/example/CustomHeaderClientExample.java
@@ -0,0 +1,71 @@
+/*
+ * Copyright (c) 2010-2018 Nathan Rajlich
+ *
+ *  Permission is hereby granted, free of charge, to any person
+ *  obtaining a copy of this software and associated documentation
+ *  files (the "Software"), to deal in the Software without
+ *  restriction, including without limitation the rights to use,
+ *  copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the
+ *  Software is furnished to do so, subject to the following
+ *  conditions:
+ *
+ *  The above copyright notice and this permission notice shall be
+ *  included in all copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ *  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ *  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ *  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ *  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ *  OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+import org.java_websocket.WebSocketImpl;
+
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * This class shows how to add additional http header like "Origin" or "Cookie".
+ *
+ * To see it working, start ServerRejectHandshakeExample and then start this example.
+ */
+public class CustomHeaderClientExample {
+
+	public static void main( String[] args ) throws URISyntaxException, InterruptedException {
+		WebSocketImpl.DEBUG = true;
+		Map<String,String> httpHeaders = new HashMap<String, String>();
+		httpHeaders.put( "Cookie", "test" );
+		ExampleClient c = new ExampleClient( new URI( "ws://localhost:8887" ), httpHeaders);
+		//We expect no successful connection
+		c.connectBlocking();
+		httpHeaders.put( "Cookie", "username=nemo" );
+		c = new ExampleClient( new URI( "ws://localhost:8887" ) , httpHeaders);
+		//Wer expect a successful connection
+		c.connectBlocking();
+		c.closeBlocking();
+		httpHeaders.put( "Access-Control-Allow-Origin", "*" );
+		c = new ExampleClient( new URI( "ws://localhost:8887" ) , httpHeaders);
+		//We expect no successful connection
+		c.connectBlocking();
+		c.closeBlocking();
+		httpHeaders.clear();
+		httpHeaders.put( "Origin", "localhost:8887" );
+		httpHeaders.put( "Cookie", "username=nemo" );
+		c = new ExampleClient( new URI( "ws://localhost:8887" ) , httpHeaders);
+		//We expect a successful connection
+		c.connectBlocking();
+		c.closeBlocking();
+		httpHeaders.clear();
+		httpHeaders.put( "Origin", "localhost" );
+		httpHeaders.put( "cookie", "username=nemo" );
+		c = new ExampleClient( new URI( "ws://localhost:8887" ) , httpHeaders);
+		//We expect no successful connection
+		c.connectBlocking();
+	}
+}
diff --git a/src/main/example/ExampleClient.java b/src/main/example/ExampleClient.java
@@ -25,6 +25,7 @@
 
 import java.net.URI;
 import java.net.URISyntaxException;
+import java.util.Map;
 
 import org.java_websocket.client.WebSocketClient;
 import org.java_websocket.drafts.Draft;
@@ -43,6 +44,10 @@ public ExampleClient( URI serverURI ) {
 		super( serverURI );
 	}
 
+	public ExampleClient( URI serverUri, Map<String, String> httpHeaders ) {
+		super(serverUri, httpHeaders);
+	}
+
 	@Override
 	public void onOpen( ServerHandshake handshakedata ) {
 		send("Hello, it is me. Mario :)");
diff --git a/src/main/example/ServerRejectHandshakeExample.java b/src/main/example/ServerRejectHandshakeExample.java
@@ -62,6 +62,12 @@ public ServerHandshakeBuilder onWebsocketHandshakeReceivedAsServer( WebSocket co
 		if (!request.getFieldValue( "Cookie" ).equals( "username=nemo" )) {
 			throw new InvalidDataException( CloseFrame.POLICY_VALIDATION, "Not accepted!");
 		}
+		//If there is a Origin Field, it has to be localhost:8887
+		if (request.hasFieldValue( "Origin" )) {
+			if (!request.getFieldValue( "Origin" ).equals( "localhost:8887" )) {
+				throw new InvalidDataException( CloseFrame.POLICY_VALIDATION, "Not accepted!");
+			}
+		}
 		return builder;
 	}
 
diff --git a/src/main/java/org/java_websocket/client/WebSocketClient.java b/src/main/java/org/java_websocket/client/WebSocketClient.java
@@ -67,24 +67,54 @@ public abstract class WebSocketClient extends AbstractWebSocket implements Runna
 	 */
 	protected URI uri = null;
 
+	/**
+	 * The underlying engine
+	 */
 	private WebSocketImpl engine = null;
 
+	/**
+	 * The socket for this WebSocketClient
+	 */
 	private Socket socket = null;
 
+	/**
+	 * The used OutputStream
+	 */
 	private OutputStream ostream;
 
+	/**
+	 * The used proxy, if any
+	 */
 	private Proxy proxy = Proxy.NO_PROXY;
 
+	/**
+	 * The thread to write outgoing message
+	 */
 	private Thread writeThread;
 
+	/**
+	 * The draft to use
+	 */
 	private Draft draft;
 
+	/**
+	 * The additional headers to use
+	 */
 	private Map<String,String> headers;
 
+	/**
+	 * The latch for connectBlocking()
+	 */
 	private CountDownLatch connectLatch = new CountDownLatch( 1 );
 
+	/**
+	 * The latch for closeBlocking()
+	 */
 	private CountDownLatch closeLatch = new CountDownLatch( 1 );
 
+	/**
+	 * The socket timeout value to be used in milliseconds.
+	 */
 	private int connectTimeout = 0;
 
 	/**
@@ -109,6 +139,31 @@ public WebSocketClient( URI serverUri , Draft protocolDraft ) {
 		this( serverUri, protocolDraft, null, 0 );
 	}
 
+	/**
+	 * Constructs a WebSocketClient instance and sets it to the connect to the
+	 * specified URI. The channel does not attampt to connect automatically. The connection
+	 * will be established once you call <var>connect</var>.
+	 * @param serverUri the server URI to connect to
+	 * @param httpHeaders Additional HTTP-Headers
+	 * @since 1.3.8
+	 */
+	public WebSocketClient( URI serverUri, Map<String,String> httpHeaders) {
+		this(serverUri, new Draft_6455(), httpHeaders);
+	}
+
+	/**
+	 * Constructs a WebSocketClient instance and sets it to the connect to the
+	 * specified URI. The channel does not attampt to connect automatically. The connection
+	 * will be established once you call <var>connect</var>.
+	 * @param serverUri the server URI to connect to
+	 * @param protocolDraft The draft which should be used for this connection
+	 * @param httpHeaders Additional HTTP-Headers
+	 * @since 1.3.8
+	 */
+	public WebSocketClient( URI serverUri , Draft protocolDraft , Map<String,String> httpHeaders) {
+		this(serverUri, protocolDraft, httpHeaders, 0);
+	}
+
 	/**
 	 * Constructs a WebSocketClient instance and sets it to the connect to the
 	 * specified URI. The channel does not attampt to connect automatically. The connection
@@ -180,7 +235,6 @@ public boolean reconnectBlocking() throws InterruptedException {
 
 	/**
 	 * Reset everything relevant to allow a reconnect
-	 *
 	 * @since 1.3.8
 	 */
 	private void reset() {

Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,12 @@ public ServerHandshakeBuilder onWebsocketHandshakeReceivedAsServer( WebSocket co`
`62`	`62`	`if (!request.getFieldValue( "Cookie" ).equals( "username=nemo" )) {`
`63`	`63`	`throw new InvalidDataException( CloseFrame.POLICY_VALIDATION, "Not accepted!");`
`64`	`64`	`}`
	`65`	`+ //If there is a Origin Field, it has to be localhost:8887`
	`66`	`+ if (request.hasFieldValue( "Origin" )) {`
	`67`	`+ if (!request.getFieldValue( "Origin" ).equals( "localhost:8887" )) {`
	`68`	`+ throw new InvalidDataException( CloseFrame.POLICY_VALIDATION, "Not accepted!");`
	`69`	`+ }`
	`70`	`+ }`
`65`	`71`	`return builder;`
`66`	`72`	`}`
`67`	`73`