Package org.eclipse.steady.backend

Class BackendConnector

java.lang.Object

org.eclipse.steady.backend.BackendConnector

public class BackendConnector
extends Object

To be used for interacting with the RESTful backend API.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BackendConnector()	Constructor for BackendConnector.

Method Summary

Modifier and Type	Method	Description
void	batchUpload(GoalContext _ctx)	Loads all upload requests form the upload folder and sends them to the backend (as long as they do not have a payload, or the payload does not exceed the maximum length CoreConfiguration.UPLOAD_MAX_SIZE).
void	cleanApp(GoalContext _goal_context, Application _app, boolean _clean_history)	cleanApp.
void	cleanCache()	cleanCache.
void	cleanSpace(GoalContext _goal_context, Space _space)	cleanSpace.
int	countLibraryConstructs(String _ja)	countLibraryConstructs.
Space	createSpace(GoalContext _goal_context, Space _space)	createSpace.
void	deletePatchEvalResults(String _bugId, AffectedVersionSource _source)	deletePatchEvalResults.
void	deleteSpace(GoalContext _goal_context, Space _space)	deleteSpace.
boolean	doesArtifactExist(String _g, String _a, String _v, Boolean _sources, String packaging)	doesArtifactExist.
Artifact[]	getAllArtifactsGroupArtifact(String _g, String _a)	getAllArtifactsGroupArtifact.
Map<String,Set<ConstructId>>	getAppBugs(GoalContext _ctx, Application _app)	Retrieves the change lists of all bugs relevant for the given application from the backend.
Map<String,Set<ConstructId>>	getAppBugs(GoalContext _ctx, Application _app, String _filter)	Retrieves the change lists of the given bug(s) from the backend.
Set<ConstructId>	getAppConstructIds(GoalContext _ctx, Application _app)	getAppConstructIds.
Set<Dependency>	getAppDependencies(GoalContext _ctx, Application _app)	Returns all Dependencys of the given Application including their reachable ConstructIds.
Set<Dependency>	getAppDeps(GoalContext _ctx, Application _app)	getAppDeps.
Set<ConstructId>	getAppTraces(GoalContext _ctx, Application _app)	Returns all ConstructIds that have been previously traced for the given Application.
Set<VulnerableDependency>	getAppVulnDeps(GoalContext _ctx, Application _app, boolean _include_historical, boolean _include_affected, boolean _include_affected_unconfirmed)	getAppVulnDeps.
Artifact	getArtifact(String _g, String _a, String _v)	getArtifact.
ConstructId[]	getArtifactBugConstructsIntersection(String _qString, List<ConstructId> c, String packaging, ProgrammingLanguage lang)	getArtifactBugConstructsIntersection.
ConstructId[]	getArtifactConstructs(String _g, String _a, String _v)	getArtifactConstructs.
String	getAstDiff(GoalContext _g, String _json)	getAstDiff.
String	getAstForQnameInLib(GoalContext _gc, String _qname, Boolean _sources, ProgrammingLanguage _lang)	getAstForQnameInLib.
Bug	getBug(GoalContext _g, String _bugId)	getBug.
AffectedLibrary[]	getBugAffectedLibraries(String _bugId, String _group, String _artifact, String _version, AffectedVersionSource _source)	getBugAffectedLibrary for a GAV.
AffectedLibrary[]	getBugAffectedLibraries(GoalContext _g, String _bugId, String _source, Boolean _onlyWellKnown)	getBugAffectedLibraries.
Library[]	getBugLibraries(String _bugId)	getBugLibraries.
String	getBugsForLib(String _digest)	getBugsForLib.
String	getBugsList(ProgrammingLanguage _l)	getBugsList.
String	getClassLibraryIds(String _className)	getClassLibraryIds.
String	getCVE(String _bugId)	get CVE description
static BackendConnector	getInstance()	Getter for the field instance.
String	getJarConstructs(String qString)	getJarConstructs.
HttpResponse	getJarForLib(String _g, String _a, String _v, Boolean _s, String _d)	getJarForLib.
String	getLibrary(String _sha1)	getLibrary.
String	getSourcesForQnameInLib(String qString)	getSourcesForQnameInLib.
VulnerableDependency[]	getVulnDeps(Boolean unconfirmedOnly)	getVulnDeps.
boolean	isAppExisting(GoalContext _goal_context, Application _app)	isAppExisting.
boolean	isBugExisting(String _bug)	isBugExisting.
boolean	isSpaceExisting(GoalContext _goal_context, Space _space)	Returns true if the given Space exists in the backend, false otherwise.
void	modifySpace(GoalContext _goal_context, Space _space)	modifySpace.
void	purgeAppVersions(GoalContext _goal_context, Application _app, int _keep)	purgeAppVersions.
void	uploadApp(GoalContext _goal_context, Application _app)	uploadApp.
void	uploadBugAffectedLibraries(GoalContext _g, String _bugId, String _json, AffectedVersionSource _source)	uploadPatchEvalResults.
void	uploadChangeList(String _bug, String _json)	uploadChangeList.
void	uploadCheckVersionResults(String _bugId, String _json)	uploadCheckVersionResults.
boolean	uploadGoalExecution(GoalContext _ctx, AbstractGoal _gexe, boolean _before)	Returns true if the upload succeeded or the upload cannot be performed (because the application does not exist), false otherwise.
void	uploadLibrary(GoalContext _ctx, Library _lib)	uploadLibrary.
void	uploadLibraryFile(String _sha1, Path _file)	uploadLibraryFile.
void	uploadPaths(GoalContext _ctx, Application _app, String _json)	uploadPaths.
boolean	uploadReachableConstructs(GoalContext _goal_context, Application _app, String _lib_digest, String _json)	uploadReachableConstructs.
boolean	uploadTouchPoints(GoalContext _goal_context, Application _app, String _lib_digest, String _json)	uploadTouchPoints.
void	uploadTraces(GoalContext _ctx, Application _app, String _json)	uploadTraces.

Methods inherited from class java.lang.Object

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

Constructor Detail

BackendConnector

protected BackendConnector()

Constructor for BackendConnector.

Method Detail

getInstance

public static BackendConnector getInstance()

Getter for the field instance.

Returns:

a BackendConnector object.

cleanCache

public void cleanCache()

cleanCache.

isSpaceExisting

public boolean isSpaceExisting(GoalContext _goal_context,
                               Space _space)
                        throws BackendConnectionException

Returns true if the given Space exists in the backend, false otherwise. If the client is CoreConfiguration.ConnectType.OFFLINE, the check is skipped and true is returned.

Parameters:

_goal_context - a GoalContext object.

_space - a Space object.

Returns:

a boolean.

Throws:

BackendConnectionException

createSpace

public Space createSpace(GoalContext _goal_context,
                         Space _space)
                  throws BackendConnectionException

createSpace.

Parameters:

_goal_context - a GoalContext object.

_space - a Space object.

Returns:

a Space object.

Throws:

BackendConnectionException - if any.

modifySpace

public void modifySpace(GoalContext _goal_context,
                        Space _space)
                 throws BackendConnectionException

modifySpace.

Parameters:

_goal_context - a GoalContext object.

_space - a Space object.

Throws:

BackendConnectionException - if any.

cleanSpace

public void cleanSpace(GoalContext _goal_context,
                       Space _space)
                throws BackendConnectionException

cleanSpace.

Parameters:

_goal_context - a GoalContext object.

_space - a Space object.

Throws:

BackendConnectionException - if any.

deleteSpace

public void deleteSpace(GoalContext _goal_context,
                        Space _space)
                 throws BackendConnectionException

deleteSpace.

Parameters:

_goal_context - a GoalContext object.

_space - a Space object.

Throws:

BackendConnectionException - if any.

isAppExisting

public boolean isAppExisting(GoalContext _goal_context,
                             Application _app)
                      throws BackendConnectionException

isAppExisting.

Parameters:

_goal_context - a GoalContext object.

_app - a Application object.

Returns:

a boolean.

Throws:

BackendConnectionException - if any.

cleanApp

public void cleanApp(GoalContext _goal_context,
                     Application _app,
                     boolean _clean_history)
              throws BackendConnectionException

cleanApp.

Parameters:

_goal_context - TODO

_app - a Application object.

_clean_history - a boolean.

Throws:

BackendConnectionException

purgeAppVersions

public void purgeAppVersions(GoalContext _goal_context,
                             Application _app,
                             int _keep)
                      throws BackendConnectionException

purgeAppVersions.

Parameters:

_goal_context - TODO

_app - a Application object.

_keep - a int.

Throws:

BackendConnectionException - if any.

uploadApp

public void uploadApp(GoalContext _goal_context,
                      Application _app)
               throws BackendConnectionException

uploadApp.

Parameters:

_goal_context - a GoalContext object.

_app - a Application object.

Throws:

BackendConnectionException - if any.

uploadReachableConstructs

public boolean uploadReachableConstructs(GoalContext _goal_context,
                                         Application _app,
                                         String _lib_digest,
                                         String _json)
                                  throws BackendConnectionException

uploadReachableConstructs.

Parameters:

_goal_context - a GoalContext object.

_app - a Application object.

_lib_digest - a String object.

_json - a String object.

Returns:

a boolean.

Throws:

BackendConnectionException - if any.

uploadTouchPoints

public boolean uploadTouchPoints(GoalContext _goal_context,
                                 Application _app,
                                 String _lib_digest,
                                 String _json)
                          throws BackendConnectionException

uploadTouchPoints.

Parameters:

_goal_context - a GoalContext object.

_app - a Application object.

_lib_digest - a String object.

_json - a String object.

Returns:

a boolean.

Throws:

BackendConnectionException - if any.

getAppConstructIds

public Set<ConstructId> getAppConstructIds(GoalContext _ctx,
                                           Application _app)
                                    throws BackendConnectionException

getAppConstructIds.

Parameters:

_ctx - a GoalContext object.

_app - a Application object.

Returns:

a Set object.

Throws:

BackendConnectionException - if any.

getAppBugs

public Map<String,Set<ConstructId>> getAppBugs(GoalContext _ctx,
                                                     Application _app)
                                              throws BackendConnectionException

Retrieves the change lists of all bugs relevant for the given application from the backend.

Parameters:

_app - a Application object.

_ctx - a GoalContext object.

Returns:

a Map object.

Throws:

BackendConnectionException

getAppBugs

public Map<String,Set<ConstructId>> getAppBugs(GoalContext _ctx,
                                                     Application _app,
                                                     String _filter)
                                              throws BackendConnectionException

Retrieves the change lists of the given bug(s) from the backend. Note that only bugs relevant for the given application are included.

Parameters:

_app - a Application object.

_filter - Comma-separated list of bug identifiers

_ctx - a GoalContext object.

Returns:

a Map object.

Throws:

BackendConnectionException

getAppDeps

public Set<Dependency> getAppDeps(GoalContext _ctx,
                                  Application _app)
                           throws BackendConnectionException

getAppDeps.

Parameters:

_ctx - a GoalContext object.

_app - a Application object.

Returns:

a Set object.

Throws:

BackendConnectionException - if any.

getAppVulnDeps

public Set<VulnerableDependency> getAppVulnDeps(GoalContext _ctx,
                                                Application _app,
                                                boolean _include_historical,
                                                boolean _include_affected,
                                                boolean _include_affected_unconfirmed)
                                         throws BackendConnectionException

getAppVulnDeps.

Parameters:

_ctx - a GoalContext object.

_app - a Application object.

_include_historical - a boolean.

_include_affected - a boolean.

_include_affected_unconfirmed - a boolean.

Returns:

a Set object.

Throws:

BackendConnectionException - if any.

getVulnDeps

public VulnerableDependency[] getVulnDeps(Boolean unconfirmedOnly)
                                   throws BackendConnectionException

getVulnDeps.

Parameters:

unconfirmedOnly - a Boolean object.

Returns:

an array of VulnerableDependency objects.

Throws:

BackendConnectionException - if any.

getAppTraces

public Set<ConstructId> getAppTraces(GoalContext _ctx,
                                     @NotNull
                                     Application _app)
                              throws BackendConnectionException

Returns all ConstructIds that have been previously traced for the given Application.

Parameters:

_ctx - a GoalContext object.

_app - a Application object.

Returns:

a Set object.

Throws:

BackendConnectionException - if any.

getAppDependencies

public Set<Dependency> getAppDependencies(GoalContext _ctx,
                                          @NotNull
                                          Application _app)
                                   throws BackendConnectionException

Returns all Dependencys of the given Application including their reachable ConstructIds.

Parameters:

_ctx - a GoalContext object.

_app - a Application object.

Returns:

a Set object.

Throws:

BackendConnectionException - if any.

getLibrary

public String getLibrary(String _sha1)
                  throws EntityNotFoundInBackendException

getLibrary.

Parameters:

_sha1 - a String object.

Returns:

a String object.

Throws:

EntityNotFoundInBackendException - if any.

countLibraryConstructs

public int countLibraryConstructs(String _ja)
                           throws BackendConnectionException

countLibraryConstructs.

Parameters:

_ja - a String object.

Returns:

a int.

Throws:

BackendConnectionException - if any.

uploadLibrary

public void uploadLibrary(GoalContext _ctx,
                          Library _lib)
                   throws BackendConnectionException

uploadLibrary.

Parameters:

_ctx - a GoalContext object.

_lib - a Library object.

Throws:

BackendConnectionException - if any.

uploadLibraryFile

public void uploadLibraryFile(String _sha1,
                              Path _file)
                       throws BackendConnectionException

uploadLibraryFile.

Parameters:

_sha1 - a String object.

_file - a Path object.

Throws:

BackendConnectionException - if any.

uploadGoalExecution

public boolean uploadGoalExecution(GoalContext _ctx,
                                   AbstractGoal _gexe,
                                   boolean _before)
                            throws BackendConnectionException

Returns true if the upload succeeded or the upload cannot be performed (because the application does not exist), false otherwise.

Parameters:

_ctx - a GoalContext object.

_gexe - a AbstractGoal object.

_before - a boolean.

Returns:

a boolean.

Throws:

BackendConnectionException

uploadTraces

public void uploadTraces(GoalContext _ctx,
                         Application _app,
                         String _json)
                  throws BackendConnectionException

uploadTraces.

Parameters:

_ctx - a GoalContext object.

_app - a Application object.

_json - a String object.

Throws:

BackendConnectionException - if any.

uploadPaths

public void uploadPaths(GoalContext _ctx,
                        Application _app,
                        String _json)
                 throws BackendConnectionException

uploadPaths.

Parameters:

_ctx - a GoalContext object.

_app - a Application object.

_json - a String object.

Throws:

BackendConnectionException - if any.

isBugExisting

public boolean isBugExisting(String _bug)
                      throws BackendConnectionException

isBugExisting.

Parameters:

_bug - a String object.

Returns:

a boolean.

Throws:

BackendConnectionException - if any.

uploadChangeList

public void uploadChangeList(String _bug,
                             String _json)
                      throws BackendConnectionException

uploadChangeList.

Parameters:

_bug - a String object.

_json - a String object.

Throws:

BackendConnectionException - if any.

uploadCheckVersionResults

public void uploadCheckVersionResults(String _bugId,
                                      String _json)
                               throws BackendConnectionException

uploadCheckVersionResults.

Parameters:

_bugId - a String object.

_json - a String object.

Throws:

BackendConnectionException - if any.

getBugAffectedLibraries

public AffectedLibrary[] getBugAffectedLibraries(GoalContext _g,
                                                 String _bugId,
                                                 String _source,
                                                 Boolean _onlyWellKnown)
                                          throws BackendConnectionException

getBugAffectedLibraries.

Parameters:

_bugId - a String object.

_source - a String object.

_g - a GoalContext object

_onlyWellKnown - a Boolean object

Returns:

an array of AffectedLibrary objects.

Throws:

BackendConnectionException - if any.

deletePatchEvalResults

public void deletePatchEvalResults(String _bugId,
                                   AffectedVersionSource _source)
                            throws BackendConnectionException

deletePatchEvalResults.

Parameters:

_bugId - a String object.

_source - a String object.

Throws:

BackendConnectionException - if any.

uploadBugAffectedLibraries

public void uploadBugAffectedLibraries(GoalContext _g,
                                       String _bugId,
                                       String _json,
                                       AffectedVersionSource _source)
                                throws BackendConnectionException

uploadPatchEvalResults.

Parameters:

_bugId - a String object.

_json - a String object.

_source - a AffectedVersionSource object.

_g - a GoalContext object

Throws:

BackendConnectionException - if any.

batchUpload

public void batchUpload(GoalContext _ctx)

Loads all upload requests form the upload folder and sends them to the backend (as long as they do not have a payload, or the payload does not exceed the maximum length CoreConfiguration.UPLOAD_MAX_SIZE).

Parameters:

_ctx - a GoalContext object.

getBug

public Bug getBug(GoalContext _g,
                  String _bugId)
           throws BackendConnectionException

getBug.

Parameters:

_bugId - a String object.

_g - a GoalContext object

Returns:

a Bug object.

Throws:

BackendConnectionException

getClassLibraryIds

public String getClassLibraryIds(String _className)

getClassLibraryIds.

Parameters:

_className - a String object.

Returns:

a String object.

getAstForQnameInLib

public String getAstForQnameInLib(GoalContext _gc,
                                  String _qname,
                                  Boolean _sources,
                                  ProgrammingLanguage _lang)

getAstForQnameInLib.

Parameters:

_gc - TODO

_qname - a String object.

_sources - a Boolean object.

_lang - a ProgrammingLanguage object.

Returns:

a String object.

getSourcesForQnameInLib

public String getSourcesForQnameInLib(String qString)

getSourcesForQnameInLib.

Parameters:

qString - a String object.

Returns:

a String object.

getArtifactBugConstructsIntersection

public ConstructId[] getArtifactBugConstructsIntersection(String _qString,
                                                          List<ConstructId> c,
                                                          String packaging,
                                                          ProgrammingLanguage lang)
                                                   throws BackendConnectionException

getArtifactBugConstructsIntersection.

Parameters:

_qString - a String object.

c - a List object.

packaging - a String object.

lang - a ProgrammingLanguage object.

Returns:

an array of ConstructId objects.

Throws:

BackendConnectionException - if any.

getJarConstructs

public String getJarConstructs(String qString)

getJarConstructs.

Parameters:

qString - a String object.

Returns:

a String object.

getAstDiff

public String getAstDiff(GoalContext _g,
                         String _json)

getAstDiff.

Parameters:

_json - a String object.

_g - a GoalContext object

Returns:

a String object.

getBugLibraries

public Library[] getBugLibraries(String _bugId)
                          throws BackendConnectionException

getBugLibraries.

Parameters:

_bugId - a String object.

Returns:

an array of Library objects.

Throws:

BackendConnectionException - if any.

getAllArtifactsGroupArtifact

public Artifact[] getAllArtifactsGroupArtifact(String _g,
                                               String _a)
                                        throws BackendConnectionException

getAllArtifactsGroupArtifact.

Parameters:

_g - a String object.

_a - a String object.

Returns:

an array of Artifact objects.

Throws:

BackendConnectionException - if any.

getArtifact

public Artifact getArtifact(String _g,
                            String _a,
                            String _v)
                     throws BackendConnectionException

getArtifact.

Parameters:

_g - a String object.

_a - a String object.

_v - a String object.

Returns:

a Artifact object.

Throws:

BackendConnectionException - if any.

getArtifactConstructs

public ConstructId[] getArtifactConstructs(String _g,
                                           String _a,
                                           String _v)
                                    throws BackendConnectionException

getArtifactConstructs.

Parameters:

_g - a String object.

_a - a String object.

_v - a String object.

Returns:

an array of ConstructId objects.

Throws:

BackendConnectionException - if any.

doesArtifactExist

public boolean doesArtifactExist(String _g,
                                 String _a,
                                 String _v,
                                 Boolean _sources,
                                 String packaging)
                          throws InterruptedException,
                                 BackendConnectionException

doesArtifactExist.

Parameters:

_g - a String object.

_a - a String object.

_v - a String object.

_sources - a Boolean object.

packaging - a String object.

Returns:

a boolean.

Throws:

InterruptedException - if any.

BackendConnectionException - if any.

getBugsList

public String getBugsList(ProgrammingLanguage _l)
                   throws BackendConnectionException

getBugsList.

Parameters:

_l - a ProgrammingLanguage object.

Returns:

a String object.

Throws:

BackendConnectionException - if any.

getJarForLib

public HttpResponse getJarForLib(String _g,
                                 String _a,
                                 String _v,
                                 Boolean _s,
                                 String _d)
                          throws BackendConnectionException

getJarForLib.

Parameters:

_g - a String object.

_a - a String object.

_v - a String object.

_s - a Boolean object.

_d - a String object.

Returns:

a HttpResponse object.

Throws:

BackendConnectionException - if any.

getBugsForLib

public String getBugsForLib(String _digest)
                     throws BackendConnectionException

getBugsForLib.

Parameters:

_digest - a String object.

Returns:

a String object.

Throws:

BackendConnectionException - if any.

getBugAffectedLibraries

public AffectedLibrary[] getBugAffectedLibraries(String _bugId,
                                                 String _group,
                                                 String _artifact,
                                                 String _version,
                                                 AffectedVersionSource _source)
                                          throws BackendConnectionException

getBugAffectedLibrary for a GAV. and source

Parameters:

_bugId - a String object.

_group - a String object.

_artifact - a String object.

_version - a String object.

_source - a String object.

Returns:

AffectedLibrary object.

Throws:

BackendConnectionException - if any.

getCVE

public String getCVE(String _bugId)
              throws BackendConnectionException

get CVE description

Parameters:

_bugId - a String object

Returns:

String

Throws:

BackendConnectionException