org.eclipse.scada.protocol.ngp.common.mc.handshake

Class StreamCompressionHandshake

java.lang.Object

org.eclipse.scada.protocol.ngp.common.mc.handshake.AbstractHandshake

org.eclipse.scada.protocol.ngp.common.mc.handshake.StreamCompressionHandshake

All Implemented Interfaces:

Handshake

public class StreamCompressionHandshake
extends AbstractHandshake

Constructor Summary

Constructors

Constructor and Description
StreamCompressionHandshake(Integer maxStreamCompressionLevel)

Method Summary

Modifier and Type	Method and Description
void	apply(HandshakeContext handshakeContext, Map<String,String> acceptedProperties) Activate the results from the previous handshake run.
void	handshake(HandshakeContext handshakeContext, Map<String,String> helloProperties, Map<String,String> acceptedProperties) Called by the server and actually performing the handshake based on the helloProperties from the client
protected Integer	performHandshake(Map<String,String> helloProperties, Map<String,String> acceptedProperties)
void	postApply(HandshakeContext context, Map<String,String> acceptedProperties) A second apply run performed directly after the run to Handshake.apply(HandshakeContext, Map)
void	request(HandshakeContext handshakeContext, Map<String,String> helloProperties) Called by the client, putting together all properties for the HelloMessage
void	sessionStarted(HandshakeContext context, Map<String,String> acceptedProperties) Called on the server and client when the session got started.

Methods inherited from class org.eclipse.scada.protocol.ngp.common.mc.handshake.AbstractHandshake

getBoolean, getInteger

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamCompressionHandshake

public StreamCompressionHandshake(Integer maxStreamCompressionLevel)

Method Detail

request

public void request(HandshakeContext handshakeContext,
                    Map<String,String> helloProperties)

Description copied from interface: Handshake

Called by the client, putting together all properties for the HelloMessage

Parameters:

handshakeContext - the handshake context

helloProperties - the properties to fill

handshake

public void handshake(HandshakeContext handshakeContext,
                      Map<String,String> helloProperties,
                      Map<String,String> acceptedProperties)
               throws Exception

Description copied from interface: Handshake

Called by the server and actually performing the handshake based on the helloProperties from the client

The server needs to evaluate what the client requested and puts the result into the acceptedProperties. No action will be done right now. The result in the acceptedProperties will also be sent to the client.

Parameters:

handshakeContext - the handshake context

helloProperties - the properties from the client

acceptedProperties - the properties to fill with the result of the handshake

Throws:

Exception - if anything goes wrong

performHandshake

protected Integer performHandshake(Map<String,String> helloProperties,
                                   Map<String,String> acceptedProperties)

apply

public void apply(HandshakeContext handshakeContext,
                  Map<String,String> acceptedProperties)
           throws Exception

Description copied from interface: Handshake

Activate the results from the previous handshake run. This is called on the server directly and on the client when the AcceptMessage was received.

In this phase all handshake modules should apply the changes needed. They may also change the sessions filter chain to change the way it communicates.

This method will be called before the ACCEPT/START packet is sent. This means that on the server side filters that change the encoding must be deactivated for the first packet. On the client side the first packet must already be encoded.

Parameters:

handshakeContext - the handshake context

acceptedProperties - the accepted properties from the servers handshake run

Throws:

Exception - if anything goes wrong

postApply

public void postApply(HandshakeContext context,
                      Map<String,String> acceptedProperties)
               throws Exception

Description copied from interface: Handshake

A second apply run performed directly after the run to Handshake.apply(HandshakeContext, Map)

This second apply run has the possibility to perform stuff which needs to be done after all changes to the filter change have been performed. So messages sent in this phase will already be encoded correctly.

Parameters:

context - the handshake context

acceptedProperties - the accepted properties from the servers handshake run

Throws:

Exception - if anything goes wrong

sessionStarted

public void sessionStarted(HandshakeContext context,
                           Map<String,String> acceptedProperties)
                    throws Exception

Description copied from interface: Handshake

Called on the server and client when the session got started.

For the server this may either be directly after the handshake run or later when the StartMessage has been received. This depends on the fact weather the client supports the session start command.

For the client this is after the session has been accepted

Parameters:

context - the handshake context

acceptedProperties - the accepted properties from the servers handshake run

Throws:

Exception - if anything goes wrong