Package org.apache.tomcat.websocket

Class TransformationFactory

java.lang.Object

org.apache.tomcat.websocket.TransformationFactory

public class TransformationFactory
extends java.lang.Object

Factory for managing WebSocket transformation builders.

Method Summary

Modifier and Type	Method	Description
Transformation	create(java.lang.String name, java.util.List<java.util.List<Extension.Parameter>> preferences, boolean isServer)	Creates a transformation for the given extension.
java.util.Set<java.lang.String>	getInstalledExtensionNames()	Returns the names of all registered extensions.
java.util.Set<Extension>	getInstalledExtensions()	Returns all registered extensions.
static TransformationFactory	getInstance()	Returns the singleton TransformationFactory instance.
void	registerExtension(java.lang.String name, TransformationBuilder builder)	Registers a transformation builder for the given extension name.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static TransformationFactory getInstance()

Returns the singleton TransformationFactory instance.

Returns:

the factory instance

create

public Transformation create(java.lang.String name,
                             java.util.List<java.util.List<Extension.Parameter>> preferences,
                             boolean isServer)

Creates a transformation for the given extension.

Parameters:

name - the extension name

preferences - the negotiated parameters

isServer - true if creating for the server side

Returns:

the transformation, or null if not found

registerExtension

public void registerExtension(java.lang.String name,
                              TransformationBuilder builder)

Registers a transformation builder for the given extension name.

Parameters:

name - the extension name

builder - the transformation builder

getInstalledExtensionNames

public java.util.Set<java.lang.String> getInstalledExtensionNames()

Returns the names of all registered extensions.

Returns:

the set of extension names

getInstalledExtensions

public java.util.Set<Extension> getInstalledExtensions()

Returns all registered extensions.

Returns:

the set of extensions