org.glassfish.tyrus.ext.extension.deflate

Class PerMessageDeflateExtension

java.lang.Object

org.glassfish.tyrus.ext.extension.deflate.PerMessageDeflateExtension

All Implemented Interfaces:

javax.websocket.Extension, ExtendedExtension

Direct Known Subclasses:

XWebkitDeflateExtension

public class PerMessageDeflateExtension
extends Object
implements ExtendedExtension

Compression Extensions for WebSocket draft-ietf-hybi-permessage-compression-15

http://tools.ietf.org/html/draft-ietf-hybi-permessage-compression-15

TODO:
 - parameters (window sizes, context takeovers).
 - context (some utility methods to get the typed params - T getParam(Class))
 

Author:

Pavel Bucek (pavel.bucek at oracle.com)

Nested Class Summary

Nested classes/interfaces inherited from interface org.glassfish.tyrus.core.extension.ExtendedExtension

ExtendedExtension.ExtensionContext

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

javax.websocket.Extension.Parameter

Constructor Summary

Constructors

Constructor and Description
PerMessageDeflateExtension()

Method Summary

Modifier and Type	Method and Description
void	destroy(ExtendedExtension.ExtensionContext context) Context lifecycle method.
String	getName()
List<javax.websocket.Extension.Parameter>	getParameters()
List<javax.websocket.Extension.Parameter>	onExtensionNegotiation(ExtendedExtension.ExtensionContext context, List<javax.websocket.Extension.Parameter> requestedParameters) Parameter negotiation.
void	onHandshakeResponse(ExtendedExtension.ExtensionContext context, List<javax.websocket.Extension.Parameter> responseParameters) Called only on the client side when handshake response arrives.
Frame	processIncoming(ExtendedExtension.ExtensionContext context, Frame frame) Process incoming frame.
Frame	processOutgoing(ExtendedExtension.ExtensionContext context, Frame frame) Process outgoing frame.

Methods inherited from class java.lang.Object

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

Constructor Detail

PerMessageDeflateExtension

public PerMessageDeflateExtension()

Method Detail

processIncoming

public Frame processIncoming(ExtendedExtension.ExtensionContext context,
                             Frame frame)

Description copied from interface: ExtendedExtension

Process incoming frame.

Passed frame is unmasked in case it was masked when received (server to client communication).

Specified by:

processIncoming in interface ExtendedExtension

Parameters:

context - per-connection/session context.

frame - websocket frame representation.

Returns:

processed frame. Can be new instance.

processOutgoing

public Frame processOutgoing(ExtendedExtension.ExtensionContext context,
                             Frame frame)

Description copied from interface: ExtendedExtension

Process outgoing frame.

Passed frame is unmasked. Frame payload will be masked when required (server to client communication).

Specified by:

processOutgoing in interface ExtendedExtension

Parameters:

context - per-connection/session context.

frame - websocket frame representation.

Returns:

processed frame. Can be new instance.

onExtensionNegotiation

public List<javax.websocket.Extension.Parameter> onExtensionNegotiation(ExtendedExtension.ExtensionContext context,
                                                                        List<javax.websocket.Extension.Parameter> requestedParameters)

Description copied from interface: ExtendedExtension

Parameter negotiation. Executed before handshake response is sent to the client (server only). Returned list of parameters will be present in handshake response headers.

TODO: Seems like list of all "requested" extensions should be passed (at least all with the same name) - the TODO: extension implementation should be able to choose which version (parameter set) will be used for the TODO: established WebSocket session. (We should also properly describe that this method will be called only once TODO: per extension per websocket session and have the possibility to NOT add this extension to negotiated TODO: extensions).

Specified by:

onExtensionNegotiation in interface ExtendedExtension

Parameters:

context - extension context.

requestedParameters - requested parameters (from handshake request).

Returns:

parameters to be present in handshake response.

onHandshakeResponse

public void onHandshakeResponse(ExtendedExtension.ExtensionContext context,
                                List<javax.websocket.Extension.Parameter> responseParameters)

Description copied from interface: ExtendedExtension

Called only on the client side when handshake response arrives.

Can be used to process extension parameters returned from server side.

Specified by:

onHandshakeResponse in interface ExtendedExtension

Parameters:

context - extension context.

responseParameters - extension parameters returned from the server.

destroy

public void destroy(ExtendedExtension.ExtensionContext context)

Description copied from interface: ExtendedExtension

Context lifecycle method. ExtendedExtension.ExtensionContext won't be used after this method is called.

Specified by:

destroy in interface ExtendedExtension

Parameters:

context - extension context to be destroyed.

getName

public String getName()

Specified by:

getName in interface javax.websocket.Extension

getParameters

public List<javax.websocket.Extension.Parameter> getParameters()

Specified by:

getParameters in interface javax.websocket.Extension