com.microsoft.azure.sdk.iot.deps.ws.impl

Class WebSocketUpgrade

java.lang.Object

com.microsoft.azure.sdk.iot.deps.ws.impl.WebSocketUpgrade

public class WebSocketUpgrade
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	RFC_GUID

Constructor Summary

Constructors

Constructor and Description
WebSocketUpgrade(String hostName, String webSocketPath, int webSocketPort, String webSocketProtocol, Map<String,String> additionalHeaders)

Method Summary

Modifier and Type	Method and Description
void	clearAdditionalHeaders() Utility function to clear all additional headers
String	createUpgradeRequest()
void	setAdditionalHeaders(Map<String,String> additionalHeaders) Deprecated. as of Deps version 0.7.1, please use setAdditionalHeadersFinal(Map)
void	setAdditionalHeadersFinal(Map<String,String> additionalHeaders) Add field-value pairs to HTTP header
void	setClientCertAvailable() Set protocol value in protocol header
void	setHost(String host) Deprecated. as of Deps version 0.7.1, please use setHostFinal(String)
void	setHostFinal(String host) Set host value in host header
void	setPath(String path) Deprecated. as of Deps version 0.7.1, please use setPathFinal(String)
void	setPathFinal(String path) Set path value in handshake
void	setPort(int port) Deprecated. as of Deps version 0.7.1, please use setPortFinal(int)
void	setPortFinal(int port) Set port value in host header
void	setProtocol(String protocol) Deprecated. as of Deps version 0.7.1, please use setProtocolFinal(String)
void	setProtocolFinal(String protocol) Set protocol value in protocol header
String	toString()
Boolean	validateUpgradeReply(byte[] responseBytes)

Methods inherited from class java.lang.Object

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

Field Detail

RFC_GUID

public static final String RFC_GUID

See Also:

Constant Field Values

Constructor Detail

WebSocketUpgrade

public WebSocketUpgrade(String hostName,
                        String webSocketPath,
                        int webSocketPort,
                        String webSocketProtocol,
                        Map<String,String> additionalHeaders)

Method Detail

setHost

@Deprecated
public void setHost(String host)

Deprecated. as of Deps version 0.7.1, please use setHostFinal(String)

Set host value in host header

Parameters:

host - The host header field value.

setHostFinal

public final void setHostFinal(String host)

Set host value in host header

Parameters:

host - The host header field value.

setPort

@Deprecated
public void setPort(int port)

Deprecated. as of Deps version 0.7.1, please use setPortFinal(int)

Set port value in host header

Parameters:

port - The port header field value.

setPortFinal

public final void setPortFinal(int port)

Set port value in host header

Parameters:

port - The port header field value.

setPath

@Deprecated
public void setPath(String path)

Deprecated. as of Deps version 0.7.1, please use setPathFinal(String)

Set path value in handshake

Parameters:

path - The path field value.

setPathFinal

public final void setPathFinal(String path)

Set path value in handshake

Parameters:

path - The path field value.

setProtocol

@Deprecated
public void setProtocol(String protocol)

Deprecated. as of Deps version 0.7.1, please use setProtocolFinal(String)

Set protocol value in protocol header

Parameters:

protocol - The protocol header field value.

setProtocolFinal

public final void setProtocolFinal(String protocol)

Set protocol value in protocol header

Parameters:

protocol - The protocol header field value.

setAdditionalHeaders

@Deprecated
public void setAdditionalHeaders(Map<String,String> additionalHeaders)

Deprecated. as of Deps version 0.7.1, please use setAdditionalHeadersFinal(Map)

Add field-value pairs to HTTP header

Parameters:

additionalHeaders - The Map containing the additional headers.

setAdditionalHeadersFinal

public final void setAdditionalHeadersFinal(Map<String,String> additionalHeaders)

Add field-value pairs to HTTP header

Parameters:

additionalHeaders - The Map containing the additional headers.

clearAdditionalHeaders

public void clearAdditionalHeaders()

Utility function to clear all additional headers

setClientCertAvailable

public void setClientCertAvailable()

Set protocol value in protocol header

createUpgradeRequest

public String createUpgradeRequest()

validateUpgradeReply

public Boolean validateUpgradeReply(byte[] responseBytes)

toString

public String toString()

Overrides:

toString in class Object