net.sf.jrtps.udds.security.Transformer Maven / Gradle / Ivy

Go to download
package net.sf.jrtps.udds.security;

import java.security.Key;

import net.sf.jrtps.transport.RTPSByteBuffer;

/**
 * Interface used to encode / decode an array of bytes.
 * 
 * @author mcr70
 */
public interface Transformer {
	/**
	 * 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
	 *  
	 * @return transformationKind
	 */
	int getTransformationKind();
	
	/**
	 * Gets the name of this transformer. Name of the transformer 
	 * may be used in configuration file.
	 *  
	 * @return Name of the transformer
	 */
	String getName();
	
	/**
	 * Encodes RTPSByteBuffer into SecurePayload.
	 * 
	 * @param key Key
	 * @param bb RTPSByteBuffer RTPSByteBuffer to encode. Position should be placed at
	 *        the end of buffer.
	 * @return SecurePayload
	 * @throws SecurityException on SecurityException
	 */
	SecurePayload encode(Key key, RTPSByteBuffer bb) throws SecurityException;
	
	/**
	 * Decodes a given SecurePayload
	 * 
	 * @param key Key
	 * @param payload Payload to decode
	 * @return RTPSByteBuffer
	 * @throws SecurityException on SecurityException
	 */
	RTPSByteBuffer decode(Key key, SecurePayload payload) throws SecurityException;
}