Modifier and Type	Class and Description
private static class	WebSocketEngine.WebSocketApplicationReg

Modifier and Type	Field and Description
private final HashMap<WebSocketApplication, String>	applicationMap
private final List<WebSocketApplication>	applications
private final HashMap<String, List<WebSocketApplication>>	contextApplications
public static final int	DEFAULT_TIMEOUT
public static final Version	DEFAULT_VERSION
private static final String[]	EMPTY_STRING_ARRAY
private static final WebSocketEngine	engine
private final HashMap<String, WebSocketApplication>	fullPathToApplication
pack-priv static final Logger	logger
private Mapper	mapper
private final HttpResponsePacket.Builder	unsupportedVersionsResponseBuilder

Access	Constructor and Description
private	WebSocketEngine()

Method Summary

Modifier and Type	Method and Description
public WebSocketApplication	getApplication(HttpRequestPacket request)
private WebSocketEngine.WebSocketApplicationReg	getApplication(final HttpRequestPacket request, final Mapper glassfishMapper)
private static String	getContextPath(String mapping)
public static WebSocketEngine	getEngine()
private void	handleUnsupportedVersion(final FilterChainContext ctx, final HttpRequestPacket request)
public static ProtocolHandler	loadHandler(MimeHeaders headers)
public synchronized void	register(final String the context path (per servlet rules) contextPath, final String url pattern (per servlet rules) urlPattern, final WebSocketApplication the WebSocket application. app) Register a WebSocketApplication to a specific context path and url pattern.
public synchronized void	register(WebSocketApplication app) Deprecated Use `register(String, String, WebSocketApplication)`
public synchronized void	unregister(WebSocketApplication app)
public synchronized void	unregisterAll() Un-registers all `WebSocketApplication` instances with the `WebSocketEngine`.
public boolean	upgrade(FilterChainContext ctx, HttpContent requestContent)
public boolean	upgrade(FilterChainContext ctx, HttpContent requestContent, Mapper mapper)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

applicationMap	back to summary
private final HashMap<WebSocketApplication, String> applicationMap

applications	back to summary
private final List<WebSocketApplication> applications

contextApplications	back to summary
private final HashMap<String, List<WebSocketApplication>> contextApplications

DEFAULT_TIMEOUT	back to summary
public static final int DEFAULT_TIMEOUT

DEFAULT_VERSION	back to summary
public static final Version DEFAULT_VERSION

EMPTY_STRING_ARRAY	back to summary
private static final String[] EMPTY_STRING_ARRAY

engine	back to summary
private static final WebSocketEngine engine

fullPathToApplication	back to summary
private final HashMap<String, WebSocketApplication> fullPathToApplication

logger	back to summary
pack-priv static final Logger logger

mapper	back to summary
private Mapper mapper

unsupportedVersionsResponseBuilder	back to summary
private final HttpResponsePacket.Builder unsupportedVersionsResponseBuilder

Constructor Detail

WebSocketEngine	back to summary
private WebSocketEngine()

Method Detail

getApplication	back to summary
public WebSocketApplication getApplication(HttpRequestPacket request)

getApplication	back to summary
private WebSocketEngine.WebSocketApplicationReg getApplication(final HttpRequestPacket request, final Mapper glassfishMapper)

getContextPath	back to summary
private static String getContextPath(String mapping)

getEngine	back to summary
public static WebSocketEngine getEngine()

handleUnsupportedVersion	back to summary
private void handleUnsupportedVersion(final FilterChainContext ctx, final HttpRequestPacket request) throws IOException

loadHandler	back to summary
public static ProtocolHandler loadHandler(MimeHeaders headers)

register	back to summary
public synchronized void register(final String contextPath, final String urlPattern, final WebSocketApplication app) Register a WebSocketApplication to a specific context path and url pattern. If you wish to associate this application with the root context, use an empty string for the contextPath argument. Examples: // WS application will be invoked: // ws://localhost:8080/echo // WS application will not be invoked: // ws://localhost:8080/foo/echo // ws://localhost:8080/echo/some/path register("", "/echo", webSocketApplication); // WS application will be invoked: // ws://localhost:8080/echo // ws://localhost:8080/echo/some/path // WS application will not be invoked: // ws://localhost:8080/foo/echo register("", "/echo/*", webSocketApplication); // WS application will be invoked: // ws://localhost:8080/context/echo // WS application will not be invoked: // ws://localhost:8080/echo // ws://localhost:8080/context/some/path register("/context", "/echo", webSocketApplication); Parameters contextPath:String the context path (per servlet rules) urlPattern:String url pattern (per servlet rules) app:WebSocketApplication the WebSocket application.

back to summary

public synchronized void register(final String contextPath, final String urlPattern, final WebSocketApplication app)

Register a WebSocketApplication to a specific context path and url pattern. If you wish to associate this application with the root context, use an empty string for the contextPath argument.

Examples:
// WS application will be invoked:
// ws://localhost:8080/echo
// WS application will not be invoked:
// ws://localhost:8080/foo/echo
// ws://localhost:8080/echo/some/path
register("", "/echo", webSocketApplication);

// WS application will be invoked:
// ws://localhost:8080/echo
// ws://localhost:8080/echo/some/path
// WS application will not be invoked:
// ws://localhost:8080/foo/echo
register("", "/echo/*", webSocketApplication);

// WS application will be invoked:
// ws://localhost:8080/context/echo

// WS application will not be invoked:
// ws://localhost:8080/echo
// ws://localhost:8080/context/some/path
register("/context", "/echo", webSocketApplication);

Parameters

contextPath:String: the context path (per servlet rules)
urlPattern:String: url pattern (per servlet rules)
app:WebSocketApplication: the WebSocket application.

register	back to summary
public synchronized void register(WebSocketApplication app) Deprecated Use `register(String, String, WebSocketApplication)` Annotations @Deprecated

unregister	back to summary
public synchronized void unregister(WebSocketApplication app)

unregisterAll	back to summary
public synchronized void unregisterAll() Un-registers all `WebSocketApplication` instances with the `WebSocketEngine`.

upgrade	back to summary
public boolean upgrade(FilterChainContext ctx, HttpContent requestContent) throws IOException

upgrade	back to summary
public boolean upgrade(FilterChainContext ctx, HttpContent requestContent, Mapper mapper) throws IOException

org.glassfish.grizzly.websockets back to summary

private Class WebSocketEngine.WebSocketApplicationReg

Class Inheritance

extends Object

java.lang.Object
org.glassfish.grizzly.websockets.WebSocketEngine.WebSocketApplicationReg

Field Summary

Modifier and Type	Field and Description
private final WebSocketApplication	app
private final WebSocketMappingData	mappingData

Constructor Summary

Access	Constructor and Description
public	WebSocketApplicationReg(final WebSocketApplication app, final WebSocketMappingData mappingData)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

app	back to summary
private final WebSocketApplication app

mappingData	back to summary
private final WebSocketMappingData mappingData

Constructor Detail

WebSocketApplicationReg	back to summary
public WebSocketApplicationReg(final WebSocketApplication app, final WebSocketMappingData mappingData)

public Class WebSocketEngine

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class WebSocketEngine.WebSocketApplicationReg

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail