votorola.a.diff.harvest

Class MessageContext

java.lang.Object

MessageContext

@ThreadSafe
public final class MessageContext
extends Object

Data structure for message-contexts as long as the Url is unknown and the message is therefore only known (including diff-urls) to determine harvesting UpdateKicks. If you already know the url of the posting on the web-archive and all the other data, then you can pass a Message object to HarvestCache to store it directly without web harvesting. Look at the documentation of HarvestCache to get an overview over the caching process.

See Also:

Message, HarvestCache

Method Summary

Methods

Modifier and Type	Method and Description
String	archiveUrl() The base-url which acts as a system wide identifier for archives.
static MessageContext	create(String sender, String archiveUrl, List<String> diffUrls, Date sentDate) Create a context.
List<String>	diffUrls() Diff-urls detected in this message.
boolean	equals(Object o) Compares all constructor variables.
int	hashCode() Obey equals contract.
String	sender() Sender of the message as known to the medium.
Date	sentDate() Date the message has been sent due to the archive information.
String	toString() Prints all constructor variables separated by ":".

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static MessageContext create(String sender,
                    String archiveUrl,
                    List<String> diffUrls,
                    Date sentDate)

Create a context.

Parameters:

sender - , may not be null

archiveUrl - , may not be null

diffUrls - , may not be null, set through HarvestCache.findDiffUrls(String)

sentDate - , may not be null

sender

public String sender()

Sender of the message as known to the medium. This is later resolved through HarvestCache.store(Message, Authenticator) by a Authenticator to mailish-usernames of Votorola.

Returns:

sender

archiveUrl

public String archiveUrl()

The base-url which acts as a system wide identifier for archives.

Returns:

base-url

diffUrls

public List<String> diffUrls()

Diff-urls detected in this message. This can be done through HarvestCache.findDiffUrls(String)

Returns:

diff-urls

sentDate

public Date sentDate()

Date the message has been sent due to the archive information. This information is crucial for proper archive access, both through harvesting and later for browsing.

Returns:

sent-date

equals

public boolean equals(Object o)

Compares all constructor variables.

Overrides:

equals in class Object

Returns:

whether the contexts equal each other

hashCode

public int hashCode()

Obey equals contract.

Overrides:

hashCode in class Object

toString

public String toString()

Prints all constructor variables separated by ":". This format is not guaranteed.

Overrides:

toString in class Object