com.mulesoft.connectors.ws.api.client

Class WebSocketRequestBuilder

java.lang.Object

com.mulesoft.connectors.ws.api.client.WebSocketRequestBuilder

public class WebSocketRequestBuilder
extends Object

Specifies how to create an HTTP request which will initiate a WebSocket connection.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected org.mule.runtime.api.util.MultiMap<String,String>	headers HTTP headers the message should include.

Constructor Summary

Constructors

Constructor and Description
WebSocketRequestBuilder()

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.api.util.MultiMap<String,String>	getHeaders()
org.mule.runtime.api.util.MultiMap<String,String>	getQueryParams()
Map<String,String>	getUriParams()
String	replaceUriParams(String path)
void	setHeaders(org.mule.runtime.api.util.MultiMap<String,String> headers)
void	setQueryParams(org.mule.runtime.api.util.MultiMap<String,String> queryParams)
void	setUriParams(Map<String,String> uriParams)
org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder	toRequestBuilder(WebSocketClientSettings settings)

Methods inherited from class java.lang.Object

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

Field Detail

headers

@Parameter
 @Optional
 @Content(primary=true)
protected org.mule.runtime.api.util.MultiMap<String,String> headers

HTTP headers the message should include.

Constructor Detail

WebSocketRequestBuilder

public WebSocketRequestBuilder()

Method Detail

setHeaders

public void setHeaders(org.mule.runtime.api.util.MultiMap<String,String> headers)

setUriParams

public void setUriParams(Map<String,String> uriParams)

setQueryParams

public void setQueryParams(org.mule.runtime.api.util.MultiMap<String,String> queryParams)

replaceUriParams

public String replaceUriParams(String path)

getHeaders

public org.mule.runtime.api.util.MultiMap<String,String> getHeaders()

getQueryParams

public org.mule.runtime.api.util.MultiMap<String,String> getQueryParams()

getUriParams

public Map<String,String> getUriParams()

toRequestBuilder

public org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder toRequestBuilder(WebSocketClientSettings settings)