net.java.sip.communicator.service.protocol
Interface OperationSetInstantMessageTransform

All Superinterfaces:

OperationSet

All Known Implementing Classes:

OperationSetInstantMessageTransformImpl

public interface OperationSetInstantMessageTransform
extends OperationSet

The Instant Message Transform operation set allows, when \ supported to insert message transform layers that could change incoming messages before they are delivered to the user and outgoing ones before they reach the protocol stack and get sent. One use case of this operation set is support of upper layer encryption mechanisms like OTR. Other cases may include hyperlink presentation, support for wiki words etc.

Important Notice: As of May 5 2009, this operation set is still a work in progress and may change significantly in the following months. Any work based on this interface is therefore likely to require frequent updates to keep compatibility.

Author:

Emil Ivov

Method Summary

void	addTransformLayer(int priority, TransformLayer transformLayer) Adds transformLayer to the layers currrently used for message transformation in this provider and assigns the specified priotity to it.
void	addTransformLayer(TransformLayer transformLayer) Adds a transformation layer to this protocol provider using a default priority value.
boolean	containsLayer(TransformLayer layer) Determines whether layer is currently registered with this provider.
void	removeTransformLayer(TransformLayer transformLayer) Removes transformLayer from the list of currently registered transform layers so that it won't be notified for further message events.

Method Detail

addTransformLayer

void addTransformLayer(TransformLayer transformLayer)

Adds a transformation layer to this protocol provider using a default priority value.

Parameters:

transformLayer - the TransformLayer that we'd like to add to our protocol provider.

addTransformLayer

void addTransformLayer(int priority,
                       TransformLayer transformLayer)

Adds transformLayer to the layers currrently used for message transformation in this provider and assigns the specified priotity to it.

Parameters:

priority - the priority/order index that we'd like to insert transportLayer at.

transformLayer - the layer we are registering

removeTransformLayer

void removeTransformLayer(TransformLayer transformLayer)

Removes transformLayer from the list of currently registered transform layers so that it won't be notified for further message events.

Parameters:

transformLayer - the layer we are trying to remove.

containsLayer

boolean containsLayer(TransformLayer layer)

Determines whether layer is currently registered with this provider.

Parameters:

layer - the layer for which we'd like to know whether it is currently registered with this provider.

Returns:

true if layer is currently registered with this provider and false otherwise.