bayou.websocket

Class WebSocketRequest

java.lang.Object

bayou.websocket.WebSocketRequest

public class WebSocketRequest
extends Object

WebSocket handshake request.

A handshake request contains data like host, port, resource name. See RFC6455 §4.1.

A WebSocket request is embedded in an HTTP request, therefore a WebSocketRequest is associated with an HttpRequest.

Constructor Summary

Constructors

Constructor and Description
WebSocketRequest(String uri) Create a WebSocketRequest from a WebSocket URI.
WebSocketRequest(boolean secure, String hostPort, String resourceName, String origin, String... subprotocols) Create a WebSocketRequest.
WebSocketRequest(HttpRequest httpRequest) Created a WebSocketRequest based on an HttpRequest.

Method Summary

Instance Methods
InetAddress	ip() The IP address of the client.
String	hostPort() The host[:port] of the server.
String	resourceName() The resource name.
boolean	secure() Whether the connection is secure.
List<String>	subprotocols() The subprotocols.
String	origin() The origin.
HttpRequest	httpRequest() The HTTP request associated with this WebSocket handshake request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebSocketRequest

public WebSocketRequest(String uri)

Create a WebSocketRequest from a WebSocket URI.

The created WebSocketRequest will have the same origin, and no subprotocols.

Example Usage:

     new WebSocketRequest("ws://localhost:8080");
     new WebSocketRequest("wss://example.com/chat");
 

WebSocketRequest

public WebSocketRequest(boolean secure,
                        String hostPort,
                        String resourceName,
                        String origin,
                        String... subprotocols)

Create a WebSocketRequest.

Example usage:

     new WebSocketRequest(false, "localhost:8080", "/", null);
     new WebSocketRequest(true, "example.com", "/chat", "https://example.com");
 

WebSocketRequest

public WebSocketRequest(HttpRequest httpRequest)
                 throws IllegalArgumentException

Created a WebSocketRequest based on an HttpRequest.

The HttpRequest must form a valid WebSocket handshake request.

Throws:

IllegalArgumentException - if the http request is not a valid WebSocket handshake request

Method Detail

ip

public InetAddress ip()

The IP address of the client.

hostPort

public String hostPort()

The host[:port] of the server. See HttpRequest.host().

Example values: "localhost:8080", "example.com".

resourceName

public String resourceName()

The resource name.

Example values: "/", "/chat".

secure

public boolean secure()

Whether the connection is secure.

subprotocols

public List<String> subprotocols()

The subprotocols.

origin

public String origin()

The origin.

Example values: null, "http://localhost:8080", "https://example.com".

httpRequest

public HttpRequest httpRequest()

The HTTP request associated with this WebSocket handshake request.