Package org.jgroups.protocols

Class SERIALIZE

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.protocols.SERIALIZE

All Implemented Interfaces:

Lifecycle

public class SERIALIZE
extends Protocol

Serializes the entire message (including payload, headers, flags and destination and src) into the payload of another message that's then sent. Deserializes the payload of an incoming message into a new message that's sent up the stack.
To be used with ASYM_ENCRYPT or SYM_ENCRYPT when the entire message (including the headers) needs to be encrypted. Can be used as a replacement for the deprecated attribute encrypt_entire_message in the above encryption protocols.
See https://issues.redhat.com/browse/JGRP-2273 for details.

Since:

4.0.12

Author:

Bela Ban

Field Summary

Fields

Modifier and Type	Field	Description
protected static short	GMS_ID
protected MessageFactory	mf

Fields inherited from class org.jgroups.stack.Protocol

after_creation_hook, down_prot, ergonomics, id, local_addr, log, policies, stack, stats, up_prot

Constructor Summary

Constructors

Constructor	Description
SERIALIZE()

Method Summary

Modifier and Type	Method	Description
protected Message	deserialize(Address sender, byte[] buf, int offset, int length)
java.lang.Object	down(Message msg)	A message is sent down the stack.
void	init()	Called after a protocol has been created and before the protocol is started.
java.lang.Object	up(Message msg)	A single message was received.
void	up(MessageBatch batch)	Sends up a multiple messages in a MessageBatch.

Methods inherited from class org.jgroups.stack.Protocol

accept, addPolicy, addr, addr, afterCreationHook, destroy, down, down, enableStats, getAddress, getComponents, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getLog, getName, getPolicies, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, isErgonomics, level, parse, policies, providedDownServices, providedUpServices, removePolicy, requiredDownServices, requiredUpServices, resetStatistics, resetStats, setAddress, setDownProtocol, setErgonomics, setId, setLevel, setPolicies, setProtocolStack, setSocketFactory, setUpProtocol, setValue, start, statsEnabled, stop, toString, up

Methods inherited from class java.lang.Object

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

Field Detail

GMS_ID

protected static final short GMS_ID

mf

protected MessageFactory mf

Constructor Detail

SERIALIZE

public SERIALIZE()

Method Detail

init

public void init()
          throws java.lang.Exception

Description copied from class: Protocol

Called after a protocol has been created and before the protocol is started. Attributes are already set. Other protocols are not yet connected and events cannot yet be sent.

Specified by:

init in interface Lifecycle

Overrides:

init in class Protocol

Throws:

java.lang.Exception - Thrown if protocol cannot be initialized successfully. This will cause the ProtocolStack to fail, so the the channel constructor will throw an exception

down

public java.lang.Object down(Message msg)

Description copied from class: Protocol

A message is sent down the stack. Protocols may examine the message and do something (e.g. add a header) with it, before passing it down.

Overrides:

down in class Protocol

up

public java.lang.Object up(Message msg)

Description copied from class: Protocol

A single message was received. Protocols may examine the message and do something (e.g. add a header) with it before passing it up.

Overrides:

up in class Protocol

up

public void up(MessageBatch batch)

Description copied from class: Protocol

Sends up a multiple messages in a MessageBatch. The sender of the batch is always the same, and so is the destination (null == multicast messages). Messages in a batch can be OOB messages, regular messages, or mixed messages, although the transport itself will create initial MessageBatches that contain only either OOB or regular messages.

The default processing below sends messages up the stack individually, based on a matching criteria (calling Protocol.accept(Message)), and - if true - calls Protocol.up(org.jgroups.Event) for that message and removes the message. If the batch is not empty, it is passed up, or else it is dropped.

Subclasses should check if there are any messages destined for them (e.g. using MessageBatch.iterator(Predicate)), then possibly remove and process them and finally pass the batch up to the next protocol. Protocols can also modify messages in place, e.g. ENCRYPT could decrypt all encrypted messages in the batch, not remove them, and pass the batch up when done.

Overrides:

up in class Protocol

Parameters:

batch - The message batch

deserialize

protected Message deserialize(Address sender,
                              byte[] buf,
                              int offset,
                              int length)
                       throws java.lang.Exception

Throws:

java.lang.Exception