org.snf4j.websocket.handshake

Class Handshaker

java.lang.Object

org.snf4j.websocket.handshake.Handshaker

All Implemented Interfaces:

IHandshaker

public class Handshaker
extends Object
implements IHandshaker

Default handshaker responsible for processing of the Web Socket handshake phase.

Author:

SNF4J.ORG

Constructor Summary

Constructors

Constructor and Description
Handshaker(IWebSocketSessionConfig config, boolean clientMode) Constructs the handshaker.

Method Summary

Modifier and Type	Method and Description
String	getClosingReason() Returns a detailed reason why the handshake phase could not finished successfully.
IExtension	getExtension(String name) Returns the negotiated extension identified by the specified name.
String[]	getExtensionNames() Returns the names of all extensions that have been negotiated
IExtension[]	getExtensions() Returns all extensions that have been negotiated
String	getSubProtocol() Return the negotiated sub-protocol.
URI	getUri() The URI identifying the Web Socket connection for both the client and server sessions.
HandshakeFrame	handshake() Initiates the handshake phase by Web Socket clients.
HandshakeFrame	handshake(HandshakeFrame frame) Processes the handshake frame received from a Web Socket client.
boolean	hasExtensions() Tells is any extension has been negotiated
boolean	isClientMode() Tells the mode (server/client) this handshaker is operating
boolean	isClosing() Tells if this handshake is closing without successfully finishing the handshake phase.
boolean	isFinished() Tells if this handshake has successfully finished the handshake phase.
void	setSession(ISession session) Sets the session object this handshaker is associated with.
void	updateExtensionDecoders(ICodecPipeline pipeline) Called to updated the pipeline decoders based on the negotiated extensions
void	updateExtensionEncoders(ICodecPipeline pipeline) Called to updated the pipeline encoders based on the negotiated extensions

Methods inherited from class java.lang.Object

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

Constructor Detail

Handshaker

public Handshaker(IWebSocketSessionConfig config,
                  boolean clientMode)

Constructs the handshaker.

Parameters:

config - the Web Socket configuration of the session this handshaker should be associated with

clientMode - the mode in witch this handshaker should operate

Method Detail

setSession

public void setSession(ISession session)

Description copied from interface: IHandshaker

Sets the session object this handshaker is associated with.

Specified by:

setSession in interface IHandshaker

Parameters:

session - the session object

isClientMode

public boolean isClientMode()

Description copied from interface: IHandshaker

Tells the mode (server/client) this handshaker is operating

Specified by:

isClientMode in interface IHandshaker

Returns:

true if this handshaker is operating in the client mode

isFinished

public boolean isFinished()

Description copied from interface: IHandshaker

Tells if this handshake has successfully finished the handshake phase.

Specified by:

isFinished in interface IHandshaker

Returns:

true if the handshake phase has been successfully finished

isClosing

public boolean isClosing()

Description copied from interface: IHandshaker

Tells if this handshake is closing without successfully finishing the handshake phase.

Specified by:

isClosing in interface IHandshaker

Returns:

true if this handshaker is closing

getSubProtocol

public String getSubProtocol()

Description copied from interface: IHandshaker

Return the negotiated sub-protocol.

Specified by:

getSubProtocol in interface IHandshaker

Returns:

the negotiated sub-protocol or null if no sub-protocol has been negotiated.

hasExtensions

public boolean hasExtensions()

Description copied from interface: IHandshaker

Tells is any extension has been negotiated

Specified by:

hasExtensions in interface IHandshaker

Returns:

true if at least one extension has been negotiated

getExtension

public IExtension getExtension(String name)

Description copied from interface: IHandshaker

Returns the negotiated extension identified by the specified name.

Specified by:

getExtension in interface IHandshaker

Parameters:

name - the name of the extension to return

Returns:

the extension or null if no extension with specified name has been negotiated

getExtensions

public IExtension[] getExtensions()

Description copied from interface: IHandshaker

Returns all extensions that have been negotiated

Specified by:

getExtensions in interface IHandshaker

Returns:

an array of the extensions

getExtensionNames

public String[] getExtensionNames()

Description copied from interface: IHandshaker

Returns the names of all extensions that have been negotiated

Specified by:

getExtensionNames in interface IHandshaker

Returns:

an array of the names

updateExtensionEncoders

public void updateExtensionEncoders(ICodecPipeline pipeline)

Description copied from interface: IHandshaker

Called to updated the pipeline encoders based on the negotiated extensions

Specified by:

updateExtensionEncoders in interface IHandshaker

Parameters:

pipeline - the pipeline to be updated

updateExtensionDecoders

public void updateExtensionDecoders(ICodecPipeline pipeline)

Description copied from interface: IHandshaker

Called to updated the pipeline decoders based on the negotiated extensions

Specified by:

updateExtensionDecoders in interface IHandshaker

Parameters:

pipeline - the pipeline to be updated

getUri

public URI getUri()

Description copied from interface: IHandshaker

The URI identifying the Web Socket connection for both the client and server sessions.

Specified by:

getUri in interface IHandshaker

Returns:

the URI identifying the connection

getClosingReason

public String getClosingReason()

Description copied from interface: IHandshaker

Returns a detailed reason why the handshake phase could not finished successfully.

Specified by:

getClosingReason in interface IHandshaker

Returns:

the detail reason

handshake

public HandshakeFrame handshake()

Description copied from interface: IHandshaker

Initiates the handshake phase by Web Socket clients.

Specified by:

handshake in interface IHandshaker

Returns:

the handshake frame to be send to the Web Socket server.

handshake

public HandshakeFrame handshake(HandshakeFrame frame)
                         throws InvalidHandshakeException

Description copied from interface: IHandshaker

Processes the handshake frame received from a Web Socket client.

Specified by:

handshake in interface IHandshaker

Parameters:

frame - the received handshake frame

Returns:

the handshake frame to be send to the Web Socket client.

Throws:

InvalidHandshakeException