mark.core

Interface ServerInterface<T extends Subject>

Type Parameters:

T - The type of data that this server is dealing with (can be a link between between a local computer and a server on the internet, or a person, etc.).

public interface ServerInterface<T extends Subject>

Interface defining all methods provided by the server. These are implemented by the client and server packages.

Author:

Thibault Debatty

Method Summary

Modifier and Type	Method and Description
void	addEvidence(Evidence evidence)
org.bson.types.ObjectId	addFile(byte[] bytes, String filename)
void	addRawData(RawData<T> data) Add raw data to the datastore and eventually trigger analysis.
RawData[]	findData(org.bson.Document query) Search for data with a custom filter (don't forget to mention a label, for example).
Evidence<T>[]	findEvidence(String label) Find evidence of given label, for all subjects.
Evidence<T>[]	findEvidence(String label, T subject)
Evidence<T>	findEvidenceById(String id) Get a single evidence by id.
byte[]	findFile(org.bson.types.ObjectId file_id)
Evidence<T>[]	findLastEvidences(String label, T subject) Find the evidences according to a pattern (that start with provided pattern), and if multiple evidences are found with same label, return the most recent one.
RawData<T>[]	findRawData(String type, T subject)
URL	getURL()
String	test()
void	testString(String data)

Method Detail

test

String test()
     throws Throwable

Returns:

@throws java.lang.Throwable if request fails

Throws:

Throwable

testString

void testString(String data)
         throws Throwable

Parameters:

data -

Throws:

Throwable - if request fails

addRawData

void addRawData(RawData<T> data)
         throws Throwable

Add raw data to the datastore and eventually trigger analysis.

Parameters:

data -

Throws:

Throwable - if request fails

addEvidence

void addEvidence(Evidence evidence)
          throws Throwable

Parameters:

evidence -

Throws:

Throwable - if request fails

addFile

org.bson.types.ObjectId addFile(byte[] bytes,
                                String filename)
                         throws Throwable

Parameters:

bytes -

filename -

Returns:

ObjectId in mongodb of the added file.

Throws:

Throwable - if request fails

findFile

byte[] findFile(org.bson.types.ObjectId file_id)
         throws Throwable

Parameters:

file_id -

Returns:

byte[].

Throws:

Throwable - if request fails.

findRawData

RawData<T>[] findRawData(String type,
                         T subject)
                  throws Throwable

Parameters:

type -

subject -

Returns:

Throws:

Throwable - if request fails

findEvidence

Evidence<T>[] findEvidence(String label,
                           T subject)
                    throws Throwable

Parameters:

label -

subject -

Returns:

Throws:

Throwable - if request fails

findEvidence

Evidence<T>[] findEvidence(String label)
                    throws Throwable

Find evidence of given label, for all subjects. Useful for displaying ranked list of subjects.

Parameters:

label -

Returns:

Throws:

Throwable - if request fails

findEvidenceById

Evidence<T> findEvidenceById(String id)
                      throws Throwable

Get a single evidence by id.

Parameters:

id -

Returns:

Throws:

Throwable - if request fails

getURL

URL getURL()

Returns:

findLastEvidences

Evidence<T>[] findLastEvidences(String label,
                                T subject)
                         throws Throwable

Find the evidences according to a pattern (that start with provided pattern), and if multiple evidences are found with same label, return the most recent one.

Parameters:

label -

subject -

Returns:

Throws:

Throwable - if an error occured

findData

RawData[] findData(org.bson.Document query)
            throws Throwable

Search for data with a custom filter (don't forget to mention a label, for example).

Parameters:

query -

Returns:

Throws:

Throwable - if an error occured