org.hobbit.controller.gitlab

Class GitlabControllerImpl

java.lang.Object

org.hobbit.controller.gitlab.GitlabControllerImpl

All Implemented Interfaces:

GitlabController

public class GitlabControllerImpl
extends Object
implements GitlabController

Created by Timofey Ermilov on 17/10/2016.

Field Summary

Fields

Modifier and Type	Field and Description
private org.gitlab.api.GitlabAPI	api
private static String	BENCHMARK_CONFIG_FILENAME
private static String	GITLAB_DEFAULT_GUEST_TOKEN
private static String	GITLAB_TOKEN
static String	GITLAB_TOKEN_KEY
private static String	GITLAB_URL
static String	GITLAB_URL_KEY
protected static int	GITLAB_VISIBILITY_PRIVATE_ID
protected static int	GITLAB_VISIBILITY_PROTECTED_ID
protected static int	GITLAB_VISIBILITY_PUBLIC_ID
private static org.slf4j.Logger	LOGGER
private static int	MAX_PARSING_ERRORS
private static int	MAX_SIZE_OF_PROJECT_VISIBILITY_CHACHE
private Set<String>	parsingErrors
private List<Project>	projects
private boolean	projectsFetched
private Set<String>	projectUris
private List<Runnable>	readyRunnable
private int	repeatInterval
private Deque<String>	sortedParsingErrors
private static String	SYSTEM_CONFIG_FILENAME
private Timer	timer
private static int	VISIBILITY_CACHE_ELEMENT_LIFETIME_IN_SECS
private com.google.common.cache.LoadingCache<String,Set<String>>	visibleProjectsCache

Constructor Summary

Constructors

Constructor and Description
GitlabControllerImpl()
GitlabControllerImpl(boolean startFetchingProjects, boolean useCache)
GitlabControllerImpl(String token, boolean startFetchingProjects, boolean useCache)

Method Summary

Modifier and Type	Method and Description
List<Project>	getAllProjects()
org.apache.jena.rdf.model.Model	getCheckedModel(byte[] modelData, String modelType, String projectName)
protected Set<String>	getProjectsOfUser(String mail) If the Gitlab API is used with an admin account, this method returns the names of the projects that are visible for this user.
protected List<org.gitlab.api.models.GitlabProject>	getProjectsVisibleForUser(org.gitlab.api.models.GitlabUser user)
List<Project>	getProjectsVisibleForUser(String mail)
protected org.gitlab.api.models.GitlabUser	getUserByMail(String mail) Tries to find the GitlabUser with the given mail address.
Project	gitlabToProject(org.gitlab.api.models.GitlabProject project)
protected void	handleErrorMsg(String message, Exception e, boolean logMsgIfAlreadyKnown) Method for handling errors occurring when crawling gitlab (mainly parsing errors).
protected static Stream<org.apache.commons.lang3.tuple.Pair<String,Project>>	listUris(Project p) Collects the URIs of benchmarks and systems defined within the given project element and streams them as pairs of the benchmark and system URIs as keys and the given project object as value.
static void	main(String[] args)
void	runAfterFirstFetch(Runnable r)
void	startFetchingProjects()
void	stopFetchingProjects()

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

GITLAB_URL_KEY

public static final String GITLAB_URL_KEY

See Also:

Constant Field Values

GITLAB_TOKEN_KEY

public static final String GITLAB_TOKEN_KEY

See Also:

Constant Field Values

GITLAB_URL

private static final String GITLAB_URL

GITLAB_TOKEN

private static final String GITLAB_TOKEN

GITLAB_DEFAULT_GUEST_TOKEN

private static final String GITLAB_DEFAULT_GUEST_TOKEN

See Also:

Constant Field Values

SYSTEM_CONFIG_FILENAME

private static final String SYSTEM_CONFIG_FILENAME

See Also:

Constant Field Values

BENCHMARK_CONFIG_FILENAME

private static final String BENCHMARK_CONFIG_FILENAME

See Also:

Constant Field Values

MAX_PARSING_ERRORS

private static final int MAX_PARSING_ERRORS

See Also:

Constant Field Values

MAX_SIZE_OF_PROJECT_VISIBILITY_CHACHE

private static final int MAX_SIZE_OF_PROJECT_VISIBILITY_CHACHE

See Also:

Constant Field Values

VISIBILITY_CACHE_ELEMENT_LIFETIME_IN_SECS

private static final int VISIBILITY_CACHE_ELEMENT_LIFETIME_IN_SECS

See Also:

Constant Field Values

GITLAB_VISIBILITY_PUBLIC_ID

protected static final int GITLAB_VISIBILITY_PUBLIC_ID

See Also:

Constant Field Values

GITLAB_VISIBILITY_PROTECTED_ID

protected static final int GITLAB_VISIBILITY_PROTECTED_ID

See Also:

Constant Field Values

GITLAB_VISIBILITY_PRIVATE_ID

protected static final int GITLAB_VISIBILITY_PRIVATE_ID

See Also:

Constant Field Values

api

private org.gitlab.api.GitlabAPI api

timer

private Timer timer

repeatInterval

private int repeatInterval

projectsFetched

private boolean projectsFetched

readyRunnable

private List<Runnable> readyRunnable

projects

private List<Project> projects

projectUris

private Set<String> projectUris

parsingErrors

private Set<String> parsingErrors

sortedParsingErrors

private Deque<String> sortedParsingErrors

visibleProjectsCache

private com.google.common.cache.LoadingCache<String,Set<String>> visibleProjectsCache

Constructor Detail

GitlabControllerImpl

public GitlabControllerImpl()

GitlabControllerImpl

public GitlabControllerImpl(boolean startFetchingProjects,
                            boolean useCache)

GitlabControllerImpl

public GitlabControllerImpl(String token,
                            boolean startFetchingProjects,
                            boolean useCache)

Method Detail

runAfterFirstFetch

public void runAfterFirstFetch(Runnable r)

startFetchingProjects

public void startFetchingProjects()

listUris

protected static Stream<org.apache.commons.lang3.tuple.Pair<String,Project>> listUris(Project p)

Collects the URIs of benchmarks and systems defined within the given project element and streams them as pairs of the benchmark and system URIs as keys and the given project object as value.

Parameters:

p - the project from which the benchmark and system URIs should be read

Returns:

a stream of pairs of found URIs and the given project object

stopFetchingProjects

public void stopFetchingProjects()

Specified by:

stopFetchingProjects in interface GitlabController

getAllProjects

public List<Project> getAllProjects()

Specified by:

getAllProjects in interface GitlabController

gitlabToProject

public Project gitlabToProject(org.gitlab.api.models.GitlabProject project)

Specified by:

gitlabToProject in interface GitlabController

main

public static void main(String[] args)
                 throws InterruptedException,
                        IOException

Throws:

InterruptedException

IOException

getCheckedModel

public org.apache.jena.rdf.model.Model getCheckedModel(byte[] modelData,
                                                       String modelType,
                                                       String projectName)

Specified by:

getCheckedModel in interface GitlabController

handleErrorMsg

protected void handleErrorMsg(String message,
                              Exception e,
                              boolean logMsgIfAlreadyKnown)

Method for handling errors occurring when crawling gitlab (mainly parsing errors). Since the class is crawling Gitlab regularly, logging errors every time is not necessary.

Parameters:

message - the error message that should be logged

e - the exception that should be logged (only if the error hasn't been logged before). Can be null.

logMsgIfAlreadyKnown - if true the message will be logged even if it has been logged before. If the flag is set to false redundant messages will be ignored.

getProjectsOfUser

protected Set<String> getProjectsOfUser(String mail)
                                 throws IOException

If the Gitlab API is used with an admin account, this method returns the names of the projects that are visible for this user. Otherwise, it returns all project names that are known.

Parameters:

mail - the e-mail address of the user for which the project names should be retrieved

Returns:

a set of project names (including the namespace)

Throws:

IOException - If the Gitlab API throws an IOException

getUserByMail

protected org.gitlab.api.models.GitlabUser getUserByMail(String mail)
                                                  throws IOException

Tries to find the GitlabUser with the given mail address.

Parameters:

mail - the mail address of the user

Returns:

the GitlabUser object for the user or null if it could not be found.

Throws:

IOException - If the Gitlab API throws an IOException

getProjectsVisibleForUser

public List<Project> getProjectsVisibleForUser(String mail)

getProjectsVisibleForUser

protected List<org.gitlab.api.models.GitlabProject> getProjectsVisibleForUser(org.gitlab.api.models.GitlabUser user)
                                                                       throws IOException

Throws:

IOException