Top Description Inners Fields Constructors Methods
org.eclipse.jetty.websocket.core

public Class ExtensionConfig

extends Object
Class Inheritance
Imports
java.util.ArrayList, .Collections, .Enumeration, .HashMap, .Iterator, .List, .Map, .Set, java.util.stream.Collectors, org.eclipse.jetty.http.QuotedCSV, org.eclipse.jetty.util.Index, .StringUtil
Represents an Extension Configuration, as seen during the connection Handshake process.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
ExtensionConfig.ParamParser

Field Summary

Modifier and TypeField and Description
private static final Index<ExtensionConfig>
CACHE

private final String
name

private final Map<String, String>
parameters

Constructor Summary

AccessConstructor and Description
public
ExtensionConfig(ExtensionConfig
the extension config to copy
copy)

Copy constructor

public
ExtensionConfig(String name, Map<String, String> parameters)

public
ExtensionConfig(String parameterizedName)

Method Summary

Modifier and TypeMethod and Description
public List<Map.Entry<String, String>>
getInternalParameters()

public String
getName()

public final int
getParameter(String key, int defValue)

public final String
getParameter(String key, String defValue)

public final String
getParameterizedName()

public final String
getParameterizedNameWithoutInternalParams()

public final Set<String>
getParameterKeys()

public final Map<String, String>

Returns:

the parameter map
getParameters()

Return parameters found in request URI.

public boolean
isInternalExtension()

public static ExtensionConfig

Returns:

the ExtensionConfig
parse(String
the parameterized name
parameterizedName)

Parse a single parameterized name.

public static List<ExtensionConfig>

Returns:

the list of extension configs
parseEnum(Enumeration<String>
the raw header values enum
valuesEnum)

Parse enumeration of Sec-WebSocket-Extensions header values into a ExtensionConfig list

public static List<ExtensionConfig>

Returns:

the list of extension configs
parseList(String...
the raw header values
rawSecWebSocketExtensions)

Parse 1 or more raw Sec-WebSocket-Extensions header values into a ExtensionConfig list

public static void
quoteIfNeeded(StringBuilder buf, String str)

public void
removeInternalParameters()

public final void
setParameter(String key)

public final void
setParameter(String key, int value)

public final void
setParameter(String key, String value)

public static String

Returns:

the header value (null if no configs present)
toHeaderValue(List<ExtensionConfig>
the list of extension configs
configs)

Convert a list of ExtensionConfig to a header value

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

CACHEback to summary
private static final Index<ExtensionConfig> CACHE
nameback to summary
private final String name
parametersback to summary
private final Map<String, String> parameters

Constructor Detail

ExtensionConfigback to summary
public ExtensionConfig(ExtensionConfig copy)

Copy constructor

Parameters
copy:ExtensionConfig

the extension config to copy

ExtensionConfigback to summary
public ExtensionConfig(String name, Map<String, String> parameters)
ExtensionConfigback to summary
public ExtensionConfig(String parameterizedName)

Method Detail

getInternalParametersback to summary
public List<Map.Entry<String, String>> getInternalParameters()
getNameback to summary
public String getName()
getParameterback to summary
public final int getParameter(String key, int defValue)
getParameterback to summary
public final String getParameter(String key, String defValue)
getParameterizedNameback to summary
public final String getParameterizedName()
getParameterizedNameWithoutInternalParamsback to summary
public final String getParameterizedNameWithoutInternalParams()
getParameterKeysback to summary
public final Set<String> getParameterKeys()
getParametersback to summary
public final Map<String, String> getParameters()

Return parameters found in request URI.

Returns:Map<String, String>

the parameter map

isInternalExtensionback to summary
public boolean isInternalExtension()
parseback to summary
public static ExtensionConfig parse(String parameterizedName)

Parse a single parameterized name.

Parameters
parameterizedName:String

the parameterized name

Returns:ExtensionConfig

the ExtensionConfig

parseEnumback to summary
public static List<ExtensionConfig> parseEnum(Enumeration<String> valuesEnum)

Parse enumeration of Sec-WebSocket-Extensions header values into a ExtensionConfig list

Parameters
valuesEnum:Enumeration<String>

the raw header values enum

Returns:List<ExtensionConfig>

the list of extension configs

parseListback to summary
public static List<ExtensionConfig> parseList(String... rawSecWebSocketExtensions)

Parse 1 or more raw Sec-WebSocket-Extensions header values into a ExtensionConfig list

Parameters
rawSecWebSocketExtensions:String[]

the raw header values

Returns:List<ExtensionConfig>

the list of extension configs

quoteIfNeededback to summary
public static void quoteIfNeeded(StringBuilder buf, String str)
removeInternalParametersback to summary
public void removeInternalParameters()
setParameterback to summary
public final void setParameter(String key)
setParameterback to summary
public final void setParameter(String key, int value)
setParameterback to summary
public final void setParameter(String key, String value)
toHeaderValueback to summary
public static String toHeaderValue(List<ExtensionConfig> configs)

Convert a list of ExtensionConfig to a header value

Parameters
configs:List<ExtensionConfig>

the list of extension configs

Returns:String

the header value (null if no configs present)

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
org.eclipse.jetty.websocket.core back to summary

private Class ExtensionConfig.ParamParser

extends QuotedCSV
Class Inheritance

Field Summary

Modifier and TypeField and Description
private String
name

private final String
parameterizedName

private final Map<String, String>
params

Inherited from org.eclipse.jetty.http.QuotedCSV:
_values

Constructor Summary

AccessConstructor and Description
public
ParamParser(String parameterizedName)

Method Summary

Modifier and TypeMethod and Description
public String
getName()

public Map<String, String>
getParams()

public void
parse()

protected void
parsedParam(StringBuffer
Containing the trimmed value and all parameters, which may be mutated
buffer, int
The length of the value
valueLength, int
The index of the start of the parameter just parsed
paramNameIdx, int
The index of the start of the parameter value just parsed, or -1
paramValueIdx)

Overrides org.eclipse.jetty.http.QuotedCSVParser.parsedParam.

Called when a parameter has been parsed

protected void
parsedValue(StringBuffer
Containing the trimmed value, which may be mutated
buffer)

Overrides org.eclipse.jetty.http.QuotedCSVParser.parsedValue.

Called when a value has been parsed (prior to any parameters)

Inherited from org.eclipse.jetty.http.QuotedCSV:
getValuesisEmptyiteratorjoinjoinjoinparsedValueAndParamssizetoString

Field Detail

nameback to summary
private String name
parameterizedNameback to summary
private final String parameterizedName
paramsback to summary
private final Map<String, String> params

Constructor Detail

ParamParserback to summary
public ParamParser(String parameterizedName)

Method Detail

getNameback to summary
public String getName()
getParamsback to summary
public Map<String, String> getParams()
parseback to summary
public void parse()
parsedParamback to summary
protected void parsedParam(StringBuffer buffer, int valueLength, int paramNameIdx, int paramValueIdx)

Overrides org.eclipse.jetty.http.QuotedCSVParser.parsedParam.

Doc from org.eclipse.jetty.http.QuotedCSVParser.parsedParam.

Called when a parameter has been parsed

Parameters
buffer:StringBuffer

Containing the trimmed value and all parameters, which may be mutated

valueLength:int

The length of the value

paramNameIdx:int

The index of the start of the parameter just parsed

paramValueIdx:int

The index of the start of the parameter value just parsed, or -1

Annotations
@Override
parsedValueback to summary
protected void parsedValue(StringBuffer buffer)

Overrides org.eclipse.jetty.http.QuotedCSVParser.parsedValue.

Doc from org.eclipse.jetty.http.QuotedCSVParser.parsedValue.

Called when a value has been parsed (prior to any parameters)

Parameters
buffer:StringBuffer

Containing the trimmed value, which may be mutated

Annotations
@Override