com.neovisionaries.ws.client

Class WebSocketExtension

java.lang.Object

com.neovisionaries.ws.client.WebSocketExtension

public class WebSocketExtension
extends Object

A class to hold the name and the parameters of a WebSocket extension.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PERMESSAGE_DEFLATE The name of <code>permessage-deflate</code> extension that is defined in <a href="https://tools.ietf.org/html/rfc7692#section-7" >7. The "permessage-deflate" Extension</a> in <a href= "https://tools.ietf.org/html/rfc7692">RFC 7692</a>.

Constructor Summary

Constructors

Constructor and Description
WebSocketExtension(String name) Constructor with an extension name.
WebSocketExtension(WebSocketExtension source) Copy constructor.

Method Summary

Modifier and Type	Method and Description
boolean	containsParameter(String key) Check if the parameter identified by the key is contained.
String	getName() Get the extension name.
String	getParameter(String key) Get the value of the specified parameter.
Map<String,String>	getParameters() Get the parameters.
static WebSocketExtension	parse(String string) Parse a string as a WebSocketExtension.
WebSocketExtension	setParameter(String key, String value) Set a value to the specified parameter.
String	toString() Stringify this object into the format "websockets-javase[; {key}[={value}]]*".

Methods inherited from class java.lang.Object

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

Field Detail

PERMESSAGE_DEFLATE

public static final String PERMESSAGE_DEFLATE

The name of <code>permessage-deflate</code> extension that is defined in <a href="https://tools.ietf.org/html/rfc7692#section-7" >7. The "permessage-deflate" Extension</a> in <a href= "https://tools.ietf.org/html/rfc7692">RFC 7692</a>.

Since:

1.17

See Also:

Constant Field Values

Constructor Detail

WebSocketExtension

public WebSocketExtension(String name)

Constructor with an extension name.

Parameters:

name - The extension name.

Throws:

IllegalArgumentException - The given name is not a valid token.

WebSocketExtension

public WebSocketExtension(WebSocketExtension source)

Copy constructor.

Parameters:

source - A source extension. Must not be null.

Throws:

IllegalArgumentException - The given argument is null.

Since:

1.6

Method Detail

getName

public String getName()

Get the extension name.

Returns:

The extension name.

getParameters

public Map<String,String> getParameters()

Get the parameters.

Returns:

The parameters.

containsParameter

public boolean containsParameter(String key)

Check if the parameter identified by the key is contained.

Parameters:

key - The name of the parameter.

Returns:

true if the parameter is contained.

getParameter

public String getParameter(String key)

Get the value of the specified parameter.

Parameters:

key - The name of the parameter.

Returns:

The value of the parameter. null may be returned.

setParameter

public WebSocketExtension setParameter(String key,
                                       String value)

Set a value to the specified parameter.

Parameters:

key - The name of the parameter.

value - The value of the parameter. If not null, it must be a valid token. Note that <a href="http://tools.ietf.org/html/rfc6455" >RFC 6455</a> says "<i>When using the quoted-string syntax variant, the value after quoted-string unescaping MUST conform to the 'token' ABNF.</i>"

Returns:

this object.

Throws:

IllegalArgumentException - <ul> <li>The key is not a valid token. <li>The value is not null and it is not a valid token. </ul>

toString

public String toString()

Stringify this object into the format "websockets-javase[; {key}[={value}]]*".

Overrides:

toString in class Object

parse

public static WebSocketExtension parse(String string)

Parse a string as a WebSocketExtension. The input string should comply with the format described in <a href= "https://tools.ietf.org/html/rfc6455#section-9.1">9.1. Negotiating Extensions</a> in <a href="https://tools.ietf.org/html/rfc6455" >RFC 6455</a>.

Parameters:

string - A string that represents a WebSocket extension.

Returns:

A new WebSocketExtension instance that represents the given string. If the input string does not comply with RFC 6455, null is returned.