net.sharksystem.messenger

Interface SharkMessage

All Known Implementing Classes:

InMemoSharkMessage

public interface SharkMessage

A SharkMessage is an end-to-end message. It is a message created by a sender and send to one or more recipients. Receiver and sender information are to be read as End-to-End (E2E) information.

Please do not be confused with definition it the SharkMessageChannel. It allows defining a set of trusted messenger peer which are allowed to transfer, to route message. That is a direct point-to-point communication.

See Also:

SharkMessengerChannel

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANONYMOUS
static java.lang.String	ANY_RECEIVER
static int	ENCRYPTED_MASK
static int	SIGNED_MASK

Method Summary

Modifier and Type	Method and Description
boolean	couldBeDecrypted() Can this message be decrypted?
boolean	encrypted() Not part of the transferred message - just a flag that indicates if this message is encrypted.
java.util.List<ASAPHop>	getASAPHopsList() A message can be received directly from a sender or it was routed.
byte[]	getContent() Content - can be encrypted and signed
java.sql.Timestamp	getCreationTime() Creation date is produced when an object is serialized.
java.util.Set<java.lang.CharSequence>	getRecipients() Recipients are always visible - the only recipient is in the unencrypted head if message is encrypted - maybe we change this in a later version.
java.lang.CharSequence	getSender() Sender - can be encrypted and signed
boolean	isLaterThan(SharkMessage message) Compare two message what creation date is earlier.
boolean	verified() Not part of the transferred message - just a flag that indicates if this message could now be verified.

Field Detail

ANY_RECEIVER

static final java.lang.String ANY_RECEIVER

See Also:

Constant Field Values

ANONYMOUS

static final java.lang.String ANONYMOUS

See Also:

Constant Field Values

SIGNED_MASK

static final int SIGNED_MASK

See Also:

Constant Field Values

ENCRYPTED_MASK

static final int ENCRYPTED_MASK

See Also:

Constant Field Values

Method Detail

getContent

byte[] getContent()
           throws ASAPSecurityException

Content - can be encrypted and signed

Returns:

Throws:

ASAPSecurityException - if message could not be encrypted

getSender

java.lang.CharSequence getSender()
                          throws ASAPSecurityException

Sender - can be encrypted and signed

Returns:

Throws:

ASAPSecurityException - if message could not be encrypted

getRecipients

java.util.Set<java.lang.CharSequence> getRecipients()

Recipients are always visible - the only recipient is in the unencrypted head if message is encrypted - maybe we change this in a later version.

Returns:

verified

boolean verified()
          throws ASAPSecurityException

Not part of the transferred message - just a flag that indicates if this message could now be verified. This can change over time, though. A non-verifiable message can be verified if the right certificate arrives. A verifiable message can become non-verifiable due to loss of certificates validity. In short: Result can change state of your local PKI

Returns:

Throws:

ASAPSecurityException - if message could not be encrypted

encrypted

boolean encrypted()

Not part of the transferred message - just a flag that indicates if this message is encrypted. Messages are encrypted with recipients public key. Recipients could decrypt that message as long as their key pair is valid. This message can not be decrypted any longer if recipients key pair changed. Peer who act as intermediates cannot encrypt this message.

Returns:

couldBeDecrypted

boolean couldBeDecrypted()

Can this message be decrypted? It is always true if it was not encrypted in the first place. It is also true if this peer was receiver of this message and key pair has not changed.

Returns:

true - message content can be read. False - encrypted content cannot be decrypted. Encrypted for another receiver.

getCreationTime

java.sql.Timestamp getCreationTime()
                            throws ASAPException,
                                   ASAPSecurityException,
                                   java.io.IOException

Creation date is produced when an object is serialized. It becomes part of the message.

Returns:

Throws:

ASAPException

java.io.IOException

ASAPSecurityException - if message could not be encrypted

isLaterThan

boolean isLaterThan(SharkMessage message)
             throws ASAPException,
                    ASAPSecurityException,
                    java.io.IOException

Compare two message what creation date is earlier. It depends on local clocks. It is a hint not more. Could need a better solution.

Parameters:

message -

Returns:

Throws:

ASAPException

java.io.IOException

ASAPSecurityException - if message could not be encrypted

getASAPHopsList

java.util.List<ASAPHop> getASAPHopsList()

A message can be received directly from a sender or it was routed. This method provides the route. The first entry will always be the sender. A route of length 1 describes a direct message exchange.

A peer that works in stone age mode will only work with direct messages.

No information about quality and safety of intermediary routing steps are provided. That is simply due to a principle lack of reliability of such information.

Returns: