org.wso2.transport.http.netty.contract.websocket

Class WebSocketClientConnectorConfig

java.lang.Object

org.wso2.transport.http.netty.contract.config.SslConfiguration

org.wso2.transport.http.netty.contract.websocket.WebSocketClientConnectorConfig

public class WebSocketClientConnectorConfig
extends SslConfiguration

Configuration for WebSocket client connector.

Constructor Summary

Constructors

Constructor and Description
WebSocketClientConnectorConfig(String remoteAddress)

Method Summary

Modifier and Type	Method and Description
void	addHeader(String key, String value) Add single headers.
void	addHeaders(Map<String,String> headers) Add multiple headers.
boolean	containsHeader(String key) Check whether a header is contained or not.
io.netty.handler.codec.http.HttpHeaders	getHeaders() Get all the headers.
int	getIdleTimeoutInMillis() Get idle timeout for WebSocket connection.
int	getMaxFrameSize()
String	getRemoteAddress() Get the remote address.
String	getSubProtocolsStr() Get sub protocols as a comma separated values string.
boolean	isAutoRead()
boolean	isWebSocketCompressionEnabled()
void	setAutoRead(boolean autoRead)
void	setIdleTimeoutInMillis(int idleTimeoutInSeconds) Set the idle timeout for WebSocket connection.
void	setMaxFrameSize(int maxFrameSize)
void	setSubProtocols(String[] subProtocols) Add sub protocols.
void	setWebSocketCompressionEnabled(boolean webSocketCompressionEnabled)

Methods inherited from class org.wso2.transport.http.netty.contract.config.SslConfiguration

disableSsl, getCertPass, getClientSSLConfig, getKeyStoreFile, getKeyStorePass, getListenerSSLConfig, getParameters, getScheme, getStrictTransportSecurityHeader, setCacheSize, setCacheValidityPeriod, setCertPass, setClientCertificates, setClientKeyFile, setClientKeyPassword, setClientTrustCertificates, setHostNameVerificationEnabled, setKeyStoreFile, setKeyStorePass, setOcspStaplingEnabled, setParameters, setScheme, setServerCertificates, setServerKeyFile, setServerKeyPassword, setServerTrustCertificates, setSslHandshakeTimeOut, setSSLProtocol, setSslSessionTimeOut, setStrictTransportSecurityHeader, setTLSStoreType, setTrustStoreFile, setTrustStorePass, setTrustStoreType, setValidateCertEnabled, setVerifyClient, useJavaDefaults

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketClientConnectorConfig

public WebSocketClientConnectorConfig(String remoteAddress)

Method Detail

getSubProtocolsStr

public String getSubProtocolsStr()

Get sub protocols as a comma separated values string.

Returns:

a string of comma separated values of sub protocols.

setSubProtocols

public void setSubProtocols(String[] subProtocols)

Add sub protocols.

Parameters:

subProtocols - a array of sub protocols.

isAutoRead

public boolean isAutoRead()

setAutoRead

public void setAutoRead(boolean autoRead)

getRemoteAddress

public String getRemoteAddress()

Get the remote address.

Returns:

the remote address.

addHeaders

public void addHeaders(Map<String,String> headers)

Add multiple headers.

Parameters:

headers - Headers map.

addHeader

public void addHeader(String key,
                      String value)

Add single headers.

Parameters:

key - Key of the header.

value - Value of the header.

getHeaders

public io.netty.handler.codec.http.HttpHeaders getHeaders()

Get all the headers.

Returns:

all the headers as a map.

containsHeader

public boolean containsHeader(String key)

Check whether a header is contained or not.

Parameters:

key - key of the header.

Returns:

true of the header is present.

getIdleTimeoutInMillis

public int getIdleTimeoutInMillis()

Get idle timeout for WebSocket connection.

Returns:

the idle timeout in millis seconds.

setIdleTimeoutInMillis

public void setIdleTimeoutInMillis(int idleTimeoutInSeconds)

Set the idle timeout for WebSocket connection.

Parameters:

idleTimeoutInSeconds - the idle timeout in milli seconds.

getMaxFrameSize

public int getMaxFrameSize()

setMaxFrameSize

public void setMaxFrameSize(int maxFrameSize)

isWebSocketCompressionEnabled

public boolean isWebSocketCompressionEnabled()

setWebSocketCompressionEnabled

public void setWebSocketCompressionEnabled(boolean webSocketCompressionEnabled)