A

B

bindings - Field in EnvVarProperty

bitbucketEndpoint - Field in BitbucketSCMProvider

bitbucketEndpointContext - Field in BitbucketSCMProvider

bitbucketPassword - Field in BitbucketSCMProvider

bitbucketPort - Field in BitbucketSCMProvider

bitbucketProtocol - Field in BitbucketSCMProvider

BitbucketRequestUtil - Class in pluggable.scm.bitbucket

BitbucketRequestUtil() - Constructor in BitbucketRequestUtil

BitbucketSCMProtocol - Enum in pluggable.scm.bitbucket

Set of named constants representing the supported Gerrit SCM protocols.

BitbucketSCMProtocol(String) - Constructor in BitbucketSCMProtocol

Constructor for class GerritSCMProtocol.

BitbucketSCMProvider - Class in pluggable.scm.bitbucket

This class implements the Bitbucket SCM Provider.

BitbucketSCMProvider(int, BitbucketSCMProtocol, String, String, BitbucketSCMProtocol, int) - Constructor in BitbucketSCMProvider

Constructor for class BitbucketSCMProvider.

BitbucketSCMProviderFactory - Class in pluggable.scm.bitbucket

The Bitbucket SCM factory class is responsible for parsing the providers properties and instantiating a BitbucketSCMProvider.

BitbucketSCMProviderFactory() - Constructor in BitbucketSCMProviderFactory

bitbucketUsername - Field in BitbucketSCMProvider

C

checkDirectoryExists(String) - Method in EnvVarProperty

Return true if the specified path is a directory and exists.

copyDataFromRepositoryInUrlsTxt(String, String, String, String) - Method in GitlabSCMProvider

Clone a repository from GitLab and populate it by pulling the data from the corresponding repository in urls.txt FIXME clone using SSH or in a way in which the access token is not stored in .git/config - fine for now as this is for evaluation purposes

create(Properties) - Method in BitbucketSCMProviderFactory

A factory method which returns an SCM Provider instantiated with the the provided properties.

create(Properties) - Method in GerritSCMProviderFactory

A factory method which return an SCM Provider instantiated with the the provided properties.

create(Properties) - Method in GitlabSCMProviderFactory

A factory method which return an SCM Provider instantiated with the the provided properties.

create(Properties) - Method in SCMProviderFactory

A factory method which return a SCM Provider instantiated according to the provided SCM properties.

createGroup(String, String, String) - Method in GitlabRequestUtil

Calls the makeRequest method with parameters which adjust the HTTP request as to create a GitLab group (namespace for a collection of repositories)

createRepository(URL, String, String, String, String) - Method in BitbucketRequestUtil

createRepositoryInGroup(String, String, int, String) - Method in GitlabRequestUtil

Calls the makeRequest method with parameters which adjust the HTTP request as to create a repository within a GitLab Group (namespace)

createScmRepos(String, String, String, String) - Method in BitbucketSCMProvider

Creates relevant repositories defined by your cartridge in your chosen SCM provider

createScmRepos(String, String, String, String) - Method in GerritSCMProvider

Creates relevant repositories defined by your cartridge in your chosen SCM provider

createScmRepos(String, String, String, String) - Method in GitlabSCMProvider

Gets a list of repositories from urls.txt, validates them and then calls forkRepositoriesFromUrls to fork each repository in GitLab If urls is empty, non readable or does not exist then exit without doing anything

createScmRepos(String, String, String, String) - Method in SCMProvider

Creates the relevant repositories defined by your cartridge in your chosen SCM provider

D

DEBUG - Enum Constant in LogLevel

deleteAndRecreateRepository(String, List, int) - Method in GitlabSCMProvider

Deletes a GitLab repository and recreates it

deleteRepoById(String, int, String) - Method in GitlabRequestUtil

Calls the makeRequest method with parameters which adjust the HTTP request as to delete a repository with a given id

E

EMPTY_FIELD_EXCEPTION_MESSAGE - Property in GitlabSCMConstants

EnvVarProperty - Class in pluggable.configuration

A singleton class representing a EnvVarProperty object.

EnvVarProperty() - Constructor in EnvVarProperty

Private constructor for class EnvVarProperty as it's a singleton.

envVarProperty - Field in Logger

ERROR - Enum Constant in LogLevel

executeCommand(String) - Method in ExecuteShellCommand

Execute arbitary shell commands.

ExecuteShellCommand - Class in pluggable.scm.helpers

Helper class to convert string input into executable bash commands.

ExecuteShellCommand() - Constructor in ExecuteShellCommand

extractRepoNameFromUrl(String) - Method in GitlabSCMProvider

Extracts the repository name from an HTTP git repository url e.g for https://github.com/Accenture/adop-cartridge-java-environment-template.git return adop-cartridge-java-environment-template Gerrit repository names will not be extracted from Gerrit urls unless a substring /gerrit/, http(s)/gerrit or .gerrit. exists

F

findClasses(File, String) - Method in SCMProviderHandler

Return a collection of all classes in a directory and specified package by recursively searching.

findScmProvider(String, List<Class>) - Method in SCMProviderHandler

Return a SCMProvider with the specified provider type.

forkRepositoriesFromUrls(List<String>, String, String, String) - Method in GitlabSCMProvider

Given a list of public repositories from urls.txt, this method forks each of them into a GitLab group (common GitLab repository namespace e.g /namespace/repo1, /namespace/repo2) If the group does not already exist then it will be created.

G

gerritEndpoint - Field in GerritSCMProvider

gerritPermissions - Field in GerritSCMProvider

gerritPermissionsWithReview - Field in GerritSCMProvider

gerritPort - Field in GerritSCMProvider

GerritSCMProtocol - Enum in pluggable.scm.gerrit

Set of named constants representing the supported Gerrit SCM protocols.

GerritSCMProtocol(String) - Constructor in GerritSCMProtocol

Constructor for class GerritSCMProtocol.

GerritSCMProvider - Class in pluggable.scm.gerrit

This class implements the Gerrit SCM Provider.

GerritSCMProvider(String, int, GerritSCMProtocol, String, String, String, String, String, int, String, String) - Constructor in GerritSCMProvider

Constructor for class GerritSCMProvider.

GerritSCMProviderFactory - Class in pluggable.scm.gerrit

The Gerrit SCM factory class is responsible for parsing the providers properties and instantiating a GerritSCMProvider.

GerritSCMProviderFactory() - Constructor in GerritSCMProviderFactory

gerritUser - Field in GerritSCMProvider

get(String, String, String, String, Closure) - Method in BitbucketSCMProvider

Return SCM section.

get(String, String, String, String, Closure) - Method in GerritSCMProvider

Return SCM section.

get(String, String, String, String, Closure) - Method in GitlabSCMProvider

Return SCM section closuer for Jenkins DSL

get(String) - Method in PropertiesSCMProviderDataStore

Return properties object for the specified SCM provider id.

get(String, String, String, String, Closure) - Method in SCMProvider

Return a closure representation of SCM section.

get(String) - Method in SCMProviderDataStore

Return properties object for the specified SCM provider id.

getAll() - Method in PropertiesSCMProviderDataStore

Return a string representation, in an array of all the available SCM providers.

getAll() - Method in SCMProviderDataStore

Return a string representation, in a collection of all the available SCM providers.

getAllRepositoriesInGroup(String, String, String) - Method in GitlabRequestUtil

Calls the makeRequest method with parameters which adjust the HTTP request as to return all the repositories that exist within a given group (namespace)

getFileProperties(String) - Method in PropertyUtils

Get Properties from a file.

getGroupInfo(String, String, String) - Method in GitlabRequestUtil

Calls the makeRequest method with parameters which adjust the HTTP request as to get all the information about a given group.

getInstance() - Method in EnvVarProperty

A singleton method for the EnvVarProperty object.

getLogger() - Method in EnvVarProperty

Return STDOUT logger.

getMultibranch(String, String, String, Closure) - Method in BitbucketSCMProvider

Return a closure representation of the SCM section for multibranch pipelines.

getMultibranch(String, String, String, Closure) - Method in GerritSCMProvider

Return a closure representation of the SCM section for multibranch pipelines.

getMultibranch(String, String, String, Closure) - Method in GitlabSCMProvider

Return a closure representation of the SCM section for multibranch pipelines (Jenkins DSL).

getMultibranch(String, String, String, Closure) - Method in SCMProvider

Return a closure representation of the SCM section for multibranch pipelines.

getPackageName(String) - Method in SCMProviderHandler

Utility method which converts file path name to a package name.

getPluggablePath() - Method in EnvVarProperty

Return a string representation of the SCM provider's pluggable search path.

getProjectRepositorys(URL, String, String, String) - Method in BitbucketRequestUtil

getPropertiesPath() - Method in EnvVarProperty

Return a string representation of the SCM provider's properties file search path.

getProperty(String) - Method in EnvVarProperty

Return a string representation of the specified property.

getRepoId(List, String) - Method in GitlabSCMProvider

Given a list of repository objects parsed from JSON it looks for a repository with a particular name and if it finds it, it extracts its id

getScmGerritProfile() - Method in GerritSCMProvider

Returns a String representation of the Gerrit server profile name.

getScmProvider(String, def) - Method in SCMProviderHandler

Return an implementation of SCM provider for the provided unique SCM provider id.

getScmUrl() - Method in BitbucketSCMProvider

Return Bitbucket SCM URL.

getScmUrl() - Method in GerritSCMProvider

Return Gerrit SCM URL.

getScmUrl() - Method in GitlabSCMProvider

Method which returns GitLab repository clone urls for http/https/ssh

getSshPrivateKeyPath() - Method in EnvVarProperty

Return a string representation of the cartridge loaders SCM_SSH_KEY path.

gitlabContext - Field in GitlabSCMProvider

gitlabEndpoint - Field in GitlabSCMProvider

gitlabPort - Field in GitlabSCMProvider

GitlabRequestUtil - Class in pluggable.scm.gitlab

GitlabRequestUtil() - Constructor in GitlabRequestUtil

GitlabSCMConstants - Class in pluggable.scm.gitlab

GitlabSCMConstants() - Constructor in GitlabSCMConstants

GitlabSCMProtocol - Enum in pluggable.scm.gitlab

Enumeration of the protocols supported by GitLab

GitlabSCMProtocol(String) - Constructor in GitlabSCMProtocol

Constructor for class GitlabSCMProtocol

gitlabSCMProtocol - Field in GitlabSCMProvider

GitlabSCMProvider - Class in pluggable.scm.gitlab

Concrete implementation of SCMProvider interface for Gitlab

GitlabSCMProvider(int, GitlabSCMProtocol, String, String, GitlabSCMProtocol, String, int, String) - Constructor in GitlabSCMProvider

Constructor for class GitlabSCMProvider.

GitlabSCMProviderFactory - Class in pluggable.scm.gitlab

GitlabSCMProviderFactory() - Constructor in GitlabSCMProviderFactory

groupExists(String, String, String) - Method in GitlabRequestUtil

Calls the makeRequest method with parameters which adjust the HTTP request as to check if a group already exists

H

hasProperty(String) - Method in EnvVarProperty

Return true if the env var property exists, else false if bindings is null or the property does not exist.

HTTP - Enum Constant in BitbucketSCMProtocol

HTTP - Enum Constant in GerritSCMProtocol

HTTP - Enum Constant in GitlabSCMProtocol

HTTPS - Enum Constant in BitbucketSCMProtocol

HTTPS - Enum Constant in GerritSCMProtocol

HTTPS - Enum Constant in GitlabSCMProtocol

I

info(String) - Method in Logger

Print to the stdout logger with a INFO presecence.

INFO - Enum Constant in LogLevel

internalEndpoint - Field in GitlabSCMProvider

INVALID_PORT_EXCEPTION_MESSAGE - Property in GitlabSCMConstants

INVALID_PROTOCOL_IN_URLS_FILE_EXCEPTION_MESSAGE - Property in GitlabSCMConstants

isGerritUrl(String) - Method in GitlabSCMProvider

Checks whether or not a clone repository url is for Gerrit.

isProjectAvailable(URL, String, String, String) - Method in BitbucketRequestUtil

isProtocolSupported(BitbucketSCMProtocol) - Method in BitbucketSCMProtocol

J

K

L

lock - Field in EnvVarProperty

log(LogLevel, String) - Method in Logger

Print to the stdout logger with the specified log level and message.

Logger - Class in pluggable.scm.helpers

A helper class for logging.

Logger() - Constructor in Logger

LogLevel - Enum in pluggable.scm.helpers

Set of named constants representing the supported log levels.

LogLevel(String) - Constructor in LogLevel

Constructor for class LogLevel.

logLvl - Field in LogLevel

M

makeRequest(String, String, String) - Method in GitlabRequestUtil

Performs an HTTP request with a Private-Token header and returns the response if the request returned a 2.x.x response code and throws an exception otherwise

N

NULL_FIELD_EXCEPTION_MESSAGE - Property in GitlabSCMConstants

O

P

processRepositories(List, List, int, String, String, String) - Method in GitlabSCMProvider

Given a list of repositories from urls.txt and a list of repositories which exist under a group, this method forks each repository in urls.txt to GitLab if it does not exist.

propertiesFilePath - Field in PropertiesSCMProviderDataStore

PropertiesSCMProviderDataStore - Class in pluggable.scm

A properties store-based implementation of the SCMProviderDataStore.

PropertiesSCMProviderDataStore() - Constructor in PropertiesSCMProviderDataStore

PropertyUtils - Class in pluggable.scm.helpers

A helper class which contain helpful methods.

PropertyUtils() - Constructor in PropertyUtils

protocol - Field in BitbucketSCMProtocol

protocol - Field in GerritSCMProtocol

protocol - Field in GitlabSCMProtocol

Q

R

repositoryAlreadyExistsInGroup(List, String) - Method in GitlabSCMProvider

Given a list of repository names and a target repository name, it checks that the list contains the target repository name

returnValue(String) - Method in EnvVarProperty

Returns a string where all environment variable keys pre-pended with "$" are replaced with their literal values

S

SCM_PROVIDER_FILE_EXTENSION - Field in SCMProviderHandler

scmCodeReviewEnabled - Field in GerritSCMProvider

scmContext - Field in GitlabSCMProvider

scmGerritCloneUser - Field in GerritSCMProvider

scmGerritServerProfile - Field in GerritSCMProvider

scmHost - Field in GerritSCMProvider

scmHost - Field in GitlabSCMProvider

scmPort - Field in BitbucketSCMProvider

scmPort - Field in GerritSCMProvider

scmPort - Field in GitlabSCMProvider

scmProtocol - Field in BitbucketSCMProvider

scmProtocol - Field in GerritSCMProvider

scmProtocol - Field in GitlabSCMProvider

SCMProvider - Interface in pluggable.scm

This interfaces defines the specification of an SCMProvider.

SCMProviderDataStore - Interface in pluggable.scm

The SCP provider data store specification.

SCMProviderFactory - Interface in pluggable.scm

The SCM provider factory definition.

SCMProviderHandler - Class in pluggable.scm

The SCMProviderHandler is responsible for dispatching SCM provider requests to the correctSCM provider factory.

SCMProviderHandler() - Constructor in SCMProviderHandler

SCMProviderInfo - Annotation Type in pluggable.scm

Annotation to mark SCM providers.

setPropertiesLocation(String) - Method in PropertiesSCMProviderDataStore

Set the properties file path.

setVariableBindings(def) - Method in EnvVarProperty

A setter method used to inject variables to store.

singleton - Field in EnvVarProperty

SSH - Enum Constant in BitbucketSCMProtocol

SSH - Enum Constant in GerritSCMProtocol

SSH - Enum Constant in GitlabSCMProtocol

T

toString() - Method in BitbucketSCMProtocol

Return a string representation of the SCM protocol.

toString() - Method in GerritSCMProtocol

Return a string representation of the SCM protocol.

toString() - Method in GitlabSCMProtocol

Return a string representation of the SCM protocol.

toString() - Method in LogLevel

Return a string representation of the log level.

trigger(String, String, String) - Method in BitbucketSCMProvider

Return a closure representation of the SCM providers trigger SCM section.

trigger(String, String, String) - Method in GerritSCMProvider

Return a closure representation of the SCM providers trigger SCM section.

trigger(String, String, String) - Method in GitlabSCMProvider

Returns a closure representation of the SCM provider's trigger SCM section for Jenkins DSL.

trigger(String, String, String) - Method in SCMProvider

Return a closure representation of the SCM providers trigger SCM section.

type() - Method in SCMProviderInfo

Return a string representation of the SCM type implemented by the SCM provider.

U

urlEncode(String) - Method in BitbucketSCMProvider

Return a url encoded value

urlsTxtPermissionsAndPropertiesAreOk(File, String) - Method in GitlabSCMProvider

Checks that urls.txt exists, is readable and non empty

V

validate() - Method in GitlabSCMProvider

Validates that all the fields required to create an object out of this class are not null or empty

validateProperties(String, String) - Method in BitbucketSCMProviderFactory

Return valid value.

validateProperties(String, String) - Method in GitlabSCMProviderFactory

Verify that a value is neither null or empty

validateRepo(String) - Method in GitlabSCMProvider

Validates a repository clone URL by checking the protocol against the GitLabSCM protocol enum (SSH is not allowed at the moment)

validateRepos(List<String>) - Method in GitlabSCMProvider

Given a list of repositories, this method validates each of them by calling the validate method

validateResponseToGetGroupRequest(List, String) - Method in GitlabSCMProvider

Validates the response of an HTTP request to search for a group.

valueOf(String) - Method in BitbucketSCMProtocol

Returns the enum constant of this type with the specified name.

valueOf(String) - Method in GerritSCMProtocol

Returns the enum constant of this type with the specified name.

valueOf(String) - Method in GitlabSCMProtocol

Returns the enum constant of this type with the specified name.

valueOf(String) - Method in LogLevel

Returns the enum constant of this type with the specified name.

values() - Method in BitbucketSCMProtocol

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Method in GerritSCMProtocol

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Method in GitlabSCMProtocol

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Method in LogLevel

Returns an array containing the constants of this enum type, in the order they are declared.

W

X

Y

Z

_