net.java.otr4j

Interface OtrEngineHost

public interface OtrEngineHost

This interface should be implemented by the host application. It is required for otr4j to work properly.

Author:

George Politis

Method Summary

Modifier and Type	Method and Description
void	askForSecret(SessionID sessionID, InstanceTag receiverTag, String question)
void	finishedSessionMessage(SessionID sessionID, String msgText)
String	getFallbackMessage(SessionID sessionID)
FragmenterInstructions	getFragmenterInstructions(SessionID sessionID) Get instructions for the necessary fragmentation operations.
byte[]	getLocalFingerprintRaw(SessionID sessionID)
KeyPair	getLocalKeyPair(SessionID sessionID)
String	getReplyForUnreadableMessage(SessionID sessionID)
OtrPolicy	getSessionPolicy(SessionID sessionID)
void	injectMessage(SessionID sessionID, String msg)
void	messageFromAnotherInstanceReceived(SessionID sessionID)
void	multipleInstancesDetected(SessionID sessionID)
void	requireEncryptedMessage(SessionID sessionID, String msgText)
void	showError(SessionID sessionID, String error)
void	smpAborted(SessionID sessionID)
void	smpError(SessionID sessionID, int tlvType, boolean cheated)
void	unencryptedMessageReceived(SessionID sessionID, String msg)
void	unreadableMessageReceived(SessionID sessionID)
void	unverify(SessionID sessionID, String fingerprint)
void	verify(SessionID sessionID, String fingerprint, boolean approved)

Method Detail

injectMessage

void injectMessage(SessionID sessionID,
                   String msg)
            throws OtrException

Throws:

OtrException

unreadableMessageReceived

void unreadableMessageReceived(SessionID sessionID)
                        throws OtrException

Throws:

OtrException

unencryptedMessageReceived

void unencryptedMessageReceived(SessionID sessionID,
                                String msg)
                         throws OtrException

Throws:

OtrException

showError

void showError(SessionID sessionID,
               String error)
        throws OtrException

Throws:

OtrException

smpError

void smpError(SessionID sessionID,
              int tlvType,
              boolean cheated)
       throws OtrException

Throws:

OtrException

smpAborted

void smpAborted(SessionID sessionID)
         throws OtrException

Throws:

OtrException

finishedSessionMessage

void finishedSessionMessage(SessionID sessionID,
                            String msgText)
                     throws OtrException

Throws:

OtrException

requireEncryptedMessage

void requireEncryptedMessage(SessionID sessionID,
                             String msgText)
                      throws OtrException

Throws:

OtrException

getSessionPolicy

OtrPolicy getSessionPolicy(SessionID sessionID)

getFragmenterInstructions

FragmenterInstructions getFragmenterInstructions(SessionID sessionID)

Get instructions for the necessary fragmentation operations. If no fragmentation is necessary, return null to set the default fragmentation instructions which are to use an unlimited number of messages of unlimited size each. Hence fragmentation is not necessary or applied.

Parameters:

sessionID - the session ID of the session

Returns:

return fragmentation instructions or null for defaults (i.e. no fragmentation)

getLocalKeyPair

KeyPair getLocalKeyPair(SessionID sessionID)
                 throws OtrException

Throws:

OtrException

getLocalFingerprintRaw

byte[] getLocalFingerprintRaw(SessionID sessionID)

askForSecret

void askForSecret(SessionID sessionID,
                  InstanceTag receiverTag,
                  String question)

verify

void verify(SessionID sessionID,
            String fingerprint,
            boolean approved)

unverify

void unverify(SessionID sessionID,
              String fingerprint)

getReplyForUnreadableMessage

String getReplyForUnreadableMessage(SessionID sessionID)

getFallbackMessage

String getFallbackMessage(SessionID sessionID)

messageFromAnotherInstanceReceived

void messageFromAnotherInstanceReceived(SessionID sessionID)

multipleInstancesDetected

void multipleInstancesDetected(SessionID sessionID)