org.glassfish.tyrus.core

Class TyrusExtension

java.lang.Object

org.glassfish.tyrus.core.TyrusExtension

All Implemented Interfaces:

java.io.Serializable, Extension

public class TyrusExtension
extends java.lang.Object
implements Extension, java.io.Serializable

WebSocket Extension implementation.

Author:

Pavel Bucek (pavel.bucek at oracle.com)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TyrusExtension.TyrusParameter WebSocket Parameter implementation.

Nested classes/interfaces inherited from interface javax.websocket.Extension

Extension.Parameter

Constructor Summary

Constructors

Constructor and Description
TyrusExtension(java.lang.String name) Create Extension with specific name.
TyrusExtension(java.lang.String name, java.util.List<Extension.Parameter> parameters) Create Extension with name and parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static java.util.List<Extension>	fromHeaders(java.util.List<java.lang.String> extensionHeaders) Parse Extension from headers (represented as List of strings).
static java.util.List<Extension>	fromString(java.util.List<java.lang.String> s) Parsing of one Extension.
java.lang.String	getName() The name of the extension.
java.util.List<Extension.Parameter>	getParameters() The extension parameters for this extension in the order they appear in the http headers.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TyrusExtension

public TyrusExtension(java.lang.String name)

Create Extension with specific name.

Parameters:

name - extension name.

Throws:

java.lang.IllegalArgumentException - when name is null or empty string.

TyrusExtension

public TyrusExtension(java.lang.String name,
                      java.util.List<Extension.Parameter> parameters)

Create Extension with name and parameters.

Parameters:

name - extension name.

parameters - extension parameters.

Method Detail

getName

public java.lang.String getName()

Description copied from interface: Extension

The name of the extension.

Specified by:

getName in interface Extension

Returns:

the name of the extension.

getParameters

public java.util.List<Extension.Parameter> getParameters()

Description copied from interface: Extension

The extension parameters for this extension in the order they appear in the http headers.

Specified by:

getParameters in interface Extension

Returns:

The read-only Map of extension parameters belonging to this extension.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

fromString

public static java.util.List<Extension> fromString(java.util.List<java.lang.String> s)

Parsing of one Extension.

Parameters:

s - List of String containing Extensions.

Returns:

List of extensions represented as TyrusExtension.

fromHeaders

public static java.util.List<Extension> fromHeaders(java.util.List<java.lang.String> extensionHeaders)

Parse Extension from headers (represented as List of strings).

Parameters:

extensionHeaders - Http Extension headers.

Returns:

list of parsed Extensions.