be.cylab.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
DetectionAgentProfile[]	activation() Get the current configuration (activation profiles).
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.
boolean	compareAndSwapInCache(String key, Object new_value, Object old_value) Compare and swap verify if the current stored value in the cache is equals to old_value, or if the value has never been stored in the cache for this key.
Map<String,Object>	executorStatus() Get the status of the executor service (running tasks etc).
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 the evidences with highest score, for given label and for all subjects.
Evidence<T>[]	findEvidence(String label, int page) 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.
Evidence<T>[]	findEvidenceSince(String label, T subject, long time)
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)
Object	getFromCache(String key) get value from cache represented by a map.
URL	getURL()
void	storeInCache(String key, Object value) Store the value in the cache with the key key.
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

findEvidenceSince

Evidence<T>[] findEvidenceSince(String label,
                                T subject,
                                long time)
                         throws Throwable

Parameters:

label -

subject -

time -

Returns:

Throws:

Throwable - if something goes wrong

findEvidence

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

Find the evidences with highest score, for given label and for all subjects. Used to display the most suspicious subjects.

Parameters:

label -

Returns:

Throws:

Throwable - if request fails

findEvidence

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

Find evidence of given label, for all subjects.

Parameters:

label -

page -

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

getFromCache

Object getFromCache(String key)
             throws Throwable

get value from cache represented by a map.

Parameters:

key - to get value.

Returns:

value.

Throws:

Throwable - if an error occured

storeInCache

void storeInCache(String key,
                  Object value)
           throws Throwable

Store the value in the cache with the key key.

Parameters:

key - to store value.

value - to store.

Throws:

Throwable - if any problems happens.

compareAndSwapInCache

boolean compareAndSwapInCache(String key,
                              Object new_value,
                              Object old_value)
                       throws Throwable

Compare and swap verify if the current stored value in the cache is equals to old_value, or if the value has never been stored in the cache for this key. Since multiple agents can get access to the cache, We do this verification to not overwrite new values from other agents.

Parameters:

key - to store new value.

new_value - to be stored.

old_value - to verify current value.

Returns:

true if it's swaped

Throws:

Throwable - if any problems happens.

executorStatus

Map<String,Object> executorStatus()
                           throws Throwable

Get the status of the executor service (running tasks etc).

Returns:

Throws:

Throwable - if something goes wrong

activation

DetectionAgentProfile[] activation()
                            throws Throwable

Get the current configuration (activation profiles).

Returns:

Throws:

Throwable - if something goes wrong