net.sf.jrtps.udds.security

Interface Transformer

All Known Implementing Classes:

CipherTransformer, CompositeTransformer, MACTransformer

public interface Transformer

Interface used to encode / decode an array of bytes.

Author:

mcr70

Method Summary

Modifier and Type	Method and Description
RTPSByteBuffer	decode(Key key, SecurePayload payload) Decodes a given SecurePayload
SecurePayload	encode(Key key, RTPSByteBuffer bb) Encodes RTPSByteBuffer into SecurePayload.
String	getName() Gets the name of this transformer.
int	getTransformationKind() Gets the transformation kind used by this transformer.

Method Detail

getTransformationKind

int getTransformationKind()

Gets the transformation kind used by this transformer. Kind of the transformation is transferred to remote entity, so that remote entity can associate a correct Transformer to decode incoming message

Returns:

transformationKind

getName

String getName()

Gets the name of this transformer. Name of the transformer may be used in configuration file.

Returns:

Name of the transformer

encode

SecurePayload encode(Key key,
                     RTPSByteBuffer bb)
              throws SecurityException

Encodes RTPSByteBuffer into SecurePayload.

Parameters:

key - Key

bb - RTPSByteBuffer RTPSByteBuffer to encode. Position should be placed at the end of buffer.

Returns:

SecurePayload

Throws:

SecurityException - on SecurityException

decode

RTPSByteBuffer decode(Key key,
                      SecurePayload payload)
               throws SecurityException

Decodes a given SecurePayload

Parameters:

key - Key

payload - Payload to decode

Returns:

RTPSByteBuffer

Throws:

SecurityException - on SecurityException