Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

net.java.otr4j
Interface OtrEngine

Package class diagram package OtrEngine
All Known Implementing Classes:
OtrEngineImpl
public interface OtrEngine

Method Summary
 void addOtrEngineListener(OtrEngineListener l)
           
 void endSession(SessionID sessionID)
          Ends the Off-the-Record session, if exists.
 PublicKey getRemotePublicKey(SessionID sessionID)
           
 SessionStatus getSessionStatus(SessionID sessionID)
           
 void refreshSession(SessionID sessionID)
          Stops/Starts the Off-the-Record session.
 void removeOtrEngineListener(OtrEngineListener l)
           
 void startSession(SessionID sessionID)
          Starts an Off-the-Record session, if there is no active one.
 String transformReceiving(SessionID sessionID, String content)
           
 String transformSending(SessionID sessionID, String content)
           
 

Method Detail

transformReceiving

String transformReceiving(SessionID sessionID,
                          String content)
                          throws OtrException
Parameters:
sessionID - The session identifier.
content - The message content to be transformed.
Returns:
The transformed message content.
Throws:
OtrException

transformSending

String transformSending(SessionID sessionID,
                        String content)
                        throws OtrException
Parameters:
sessionID - The session identifier.
content - The message content to be transformed.
Returns:
The transformed message content.
Throws:
OtrException

startSession

void startSession(SessionID sessionID)
                  throws OtrException
Starts an Off-the-Record session, if there is no active one.

Parameters:
sessionID - The session identifier.
Throws:
OtrException

endSession

void endSession(SessionID sessionID)
                throws OtrException
Ends the Off-the-Record session, if exists.

Parameters:
sessionID - The session identifier.
Throws:
OtrException

refreshSession

void refreshSession(SessionID sessionID)
                    throws OtrException
Stops/Starts the Off-the-Record session.

Parameters:
sessionID - The session identifier.
Throws:
OtrException

getSessionStatus

SessionStatus getSessionStatus(SessionID sessionID)
Parameters:
sessionID - The session identifier.
Returns:
The status of an Off-the-Record session.

getRemotePublicKey

PublicKey getRemotePublicKey(SessionID sessionID)
Parameters:
sessionID - The session identifier.
Returns:
The remote public key.

addOtrEngineListener

void addOtrEngineListener(OtrEngineListener l)

removeOtrEngineListener

void removeOtrEngineListener(OtrEngineListener l)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2009 Beem-project.com. All Rights Reserved.