Package com.astrolabsoftware.FinkBrowser.Januser

Class FinkGremlinRecipies

java.lang.Object

com.Lomikel.Januser.GremlinRecipies

com.astrolabsoftware.FinkBrowser.Januser.FinkGremlinRecipies

public class FinkGremlinRecipies
extends GremlinRecipies

FinkGremlinRecipies provides various recipies to handle and modify Gremlin Graphs for Fink.

Author:

J.Hrivnac

Field Summary

Fields

Modifier and Type	Field	Description
private FinkHBaseClient	_fhclient
private String	_fhclientUrl
private String	_now
private static String	FINK_ANOMALY_WS
private static String	FINK_LATESTS_WS
private static String	FINK_OBJECTS_WS
private static org.apache.logging.log4j.Logger	log	Logging .

Constructor Summary

Constructors

Constructor	Description
FinkGremlinRecipies(ModifyingGremlinClient client)	Create and attach to ModifyingGremlinClient.
FinkGremlinRecipies(GraphTraversalSource g)	Create and attach to GraphTraversalSource.

Method Summary

Modifier and Type	Method	Description
void	classifySource(Classifier classifier, String objectId)	Classify source.
void	classifySource(Classifier classifier, String objectId, String hbaseUrl)	Classify source.
void	classifySources(Classifier[] classifiers, Set<String> oids, String hbaseUrl)	Classify source .
void	cleanSoI(Classifier classifier, String cls)	Clean tree under SoI.
FinkHBaseClient	fhclient()	Get existing FinkHBaseClient.
FinkHBaseClient	fhclient(String hbaseUrl)	Create a new FinkHBaseClient.
void	fillSoI(Classifier[] classifiers, String filter, String hbaseUrl, int nLimit, int timeLimit, String[] clss)	Fill graph with SoI.
void	generateCorrelations(Classifier... classifiers)	Generate overlaps Edges between SoI.
String	hbaseUrl()	Give HBase url.
void	processSoI(Classifier[] classifiers, String filter, String hbaseUrl, int nLimit, int timeLimit, String[] clss)	Execute full chain of new sources correlations analyses.
void	registerSoI(Classifier classifier, String cls, String objectId, double weight, String instancesS, String weightsS)	Register source in SoI.
void	registerSoI(Classifier classifier, String cls, String objectId, double weight, List<String> instances, List<Double> weights)	Register source in SoI.

Methods inherited from class com.Lomikel.Januser.GremlinRecipies

addEdge, addEdge, addEdge, allV, attachDataLink, checkEdge, client, commit, created, createMetaSchema, drop, g, getEdge, getOrCreate, getOrCreate, gimme, graph

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_fhclient

private FinkHBaseClient _fhclient

_fhclientUrl

private String _fhclientUrl

_now

private String _now

FINK_OBJECTS_WS

private static String FINK_OBJECTS_WS

FINK_LATESTS_WS

private static String FINK_LATESTS_WS

FINK_ANOMALY_WS

private static String FINK_ANOMALY_WS

log

private static org.apache.logging.log4j.Logger log

Logging .

Constructor Details

FinkGremlinRecipies

public FinkGremlinRecipies(GraphTraversalSource g)

Create and attach to GraphTraversalSource.

Parameters:

g - The attached GraphTraversalSource.

FinkGremlinRecipies

public FinkGremlinRecipies(ModifyingGremlinClient client)

Create and attach to ModifyingGremlinClient.

Parameters:

client - The attached ModifyingGremlinClient.

Method Details

processSoI

public void processSoI(Classifier[] classifiers,
 String filter,
 String hbaseUrl,
 int nLimit,
 int timeLimit,
 String[] clss)
                throws LomikelException

Execute full chain of new sources correlations analyses.

Parameters:

classifiers - The Classifiers to be used. They can contain the Classifier flavor after = symbol.

filter - The HBase evaluation formula to be applied. Ignored if clss are specified.

hbaseUrl - The url of HBase with alerts as ip:port:table:schema.

nLimit - The maximal number of alerts getting from HBase or Fink Portal. 0 means no limit.

timeLimit - How far into the past the search should search (in minutes).

clss - An array of classes taken from FPC, if contains Anomaly, get anomalies from FPC, if null, analyse sources from HBase database.

Throws:

LomikelException - If anything fails.

fillSoI

public void fillSoI(Classifier[] classifiers,
 String filter,
 String hbaseUrl,
 int nLimit,
 int timeLimit,
 String[] clss)
             throws LomikelException

Fill graph with SoI.

Parameters:

classifiers - The Classifiers to be used.

filter - The HBase evaluation formula to be applied. Ignored if clss are specified.

hbaseUrl - The url of HBase with alerts as ip:port:table:schema.

nLimit - The maximal number of alerts getting from HBase or Fink Portal. 0 means no limit.

timeLimit - How far into the past the search should search (in minutes).

clss - An array of classes taken from FPC, if contains Anomaly, get anomalies from FPC, if null, analyse sources from HBase database.

Throws:

LomikelException - If anything fails.

classifySources

public void classifySources(Classifier[] classifiers,
 Set<String> oids,
 String hbaseUrl)
                     throws LomikelException

Classify source .

Parameters:

classifiers - The Classifiers to be used.

oids - The Set of objectIds of source to be added.

hbaseUrl - The url of HBase with alerts as ip:port:table:schema.

Throws:

LomikelException - If anything fails.

classifySource

public void classifySource(Classifier classifier,
 String objectId,
 String hbaseUrl)
                    throws LomikelException

Classify source.

Parameters:

classifier - The Classifier to be used.

objectId - The objectId of source to be added.

hbaseUrl - The url of HBase with alerts as ip:port:table:schema.

Throws:

LomikelException - If anything fails.

classifySource

public void classifySource(Classifier classifier,
 String objectId)
                    throws LomikelException

Classify source.

Parameters:

classifier - The Classifier to be used.

objectId - The objectId of source to be added.

Throws:

LomikelException - If anything fails.

registerSoI

public void registerSoI(Classifier classifier,
 String cls,
 String objectId,
 double weight,
 String instancesS,
 String weightsS)

Register source in SoI.

Parameters:

classifier - The Classifier to be used.

cls - The type (class) of SoI Vertex. It will be created if not yet exists.

objectId - The objectId of the new Source Vertex. It will be created if not yet exists.

weight - The weight of the connection. Usualy the number of Alerts of this type.

instanceS - The jd of related Alerts as strings separated by comma. Potential square brackets are removed. May be null or empty.

registerSoI

public void registerSoI(Classifier classifier,
 String cls,
 String objectId,
 double weight,
 List<String> instances,
 List<Double> weights)

Register source in SoI.

Parameters:

classifier - The Classifier to be used.

cls - The type (class) of SoI Vertex. It will be created if not yet exists.

objectId - The objectId of the new Source Vertex. It will be created if not yet exists.

weight - The total weight of the connection. Usualy the number of Alerts of this type.

instances - The jd of related Alerts.

weights - The weights of related Alerts.

cleanSoI

public void cleanSoI(Classifier classifier,
 String cls)
              throws LomikelException

Clean tree under SoI. Drop alerts. Alerts are dropped even if they have other Edges.

Parameters:

classifier - The Classifier to be used.

cls - The type (class) of SoI.

Throws:

LomikelException - If anything goes wrong.

generateCorrelations

public void generateCorrelations(Classifier... classifiers)

Generate overlaps Edges between SoI. Possibly between two Classifiers.

Parameters:

classifier - The Classifiers to be used.

fhclient

public FinkHBaseClient fhclient(String hbaseUrl)
                         throws LomikelException

Create a new FinkHBaseClient. Singleton when url unchanged.

Parameters:

hbaseUrl - The HBase url as ip:port:table[:schema].

Returns:

The corresponding FinkHBaseClient, created and initialised if needed.

Throws:

LomikelException - If cannot be created.

fhclient

public FinkHBaseClient fhclient()
                         throws LomikelException

Get existing FinkHBaseClient.

Returns:

The corresponding FinkHBaseClient.

Throws:

LomikelException - If not yet created.

hbaseUrl

public String hbaseUrl()

Give HBase url.

Returns:

The HBase url as ip:port:table[:schema].