Package org.apache.nifi.gitlab

Class GitLabRepositoryClient

java.lang.Object

org.apache.nifi.gitlab.GitLabRepositoryClient

All Implemented Interfaces:

GitRepositoryClient

public class GitLabRepositoryClient
extends Object
implements GitRepositoryClient

Implementation of GitRepositoryClient for GitLab.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GitLabRepositoryClient.Builder
private static interface	GitLabRepositoryClient.GitLabRequest<T>	Functional interface for making a request to GitLab which may throw GitLabApiException.
private static final record	GitLabRepositoryClient.TokenInfo	Holder for information about the permissions of the provided token.

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	canRead
private final boolean	canWrite
private final String	clientId
private final int	connectTimeout
private static final int	DEFAULT_ITEMS_PER_PAGE
private static final String	DIRECTORY_MODE
private final org.gitlab4j.api.GitLabApi	gitLab
private static final org.slf4j.Logger	LOGGER
private final com.fasterxml.jackson.databind.ObjectMapper	objectMapper
private static final String	PERSONAL_ACCESS_TOKENS_SELF_PATH
private static final String	PRIVATE_TOKEN_HEADER
private final String	projectPath
private static final String	READ_API_SCOPE
private final int	readTimeout
private final String	repoName
private final String	repoNamespace
private final String	repoPath
private static final GitLabRepositoryClient.TokenInfo	UNKNOWN_TOKEN
private static final String	WRITE_API_SCOPE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	GitLabRepositoryClient(GitLabRepositoryClient.Builder builder)

Method Summary

Modifier and Type	Method	Description
static GitLabRepositoryClient.Builder	builder()
void	close()
private HttpURLConnection	createConnection(String subPath)
String	createContent(GitCreateContentRequest request)
private GitLabRepositoryClient.TokenInfo	createTokenInfo(PersonalAccessToken personalAccessToken)
InputStream	deleteContent(String filePath, String commitMessage, String branch)
private <T> T	execute(GitLabRepositoryClient.GitLabRequest<T> action)
Set<String>	getBranches()
List<GitCommit>	getCommits(String path, String branch)
InputStream	getContentFromBranch(String path, String branch)
InputStream	getContentFromCommit(String path, String commitSha)
Optional<String>	getContentSha(String path, String branch)
Set<String>	getFileNames(String directory, String branch)
private Optional<PersonalAccessToken>	getPersonalAccessToken()
private Optional<org.gitlab4j.api.models.Project>	getProject()
String	getRepoName()
String	getRepoNamespace()
private String	getResolvedPath(String path)
private GitLabRepositoryClient.TokenInfo	getTokenInfo()
Set<String>	getTopLevelDirectoryNames(String branch)
private boolean	hasMinimumAccessLevel(org.gitlab4j.api.models.Project project, org.gitlab4j.api.models.AccessLevel accessLevel)
boolean	hasReadPermission()
boolean	hasWritePermission()
private boolean	isDirectory(org.gitlab4j.api.models.TreeItem item)
private boolean	isFile(org.gitlab4j.api.models.TreeItem item)
private PersonalAccessToken	retrievePersonalAccessToken()
private GitCommit	toGitCommit(org.gitlab4j.api.models.Commit commit)

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

PERSONAL_ACCESS_TOKENS_SELF_PATH

private static final String PERSONAL_ACCESS_TOKENS_SELF_PATH

See Also:

• Constant Field Values

PRIVATE_TOKEN_HEADER

private static final String PRIVATE_TOKEN_HEADER

See Also:

• Constant Field Values

READ_API_SCOPE

private static final String READ_API_SCOPE

See Also:

• Constant Field Values

WRITE_API_SCOPE

private static final String WRITE_API_SCOPE

See Also:

• Constant Field Values

DIRECTORY_MODE

private static final String DIRECTORY_MODE

See Also:

• Constant Field Values

DEFAULT_ITEMS_PER_PAGE

private static final int DEFAULT_ITEMS_PER_PAGE

See Also:

• Constant Field Values

UNKNOWN_TOKEN

private static final GitLabRepositoryClient.TokenInfo UNKNOWN_TOKEN

objectMapper

private final com.fasterxml.jackson.databind.ObjectMapper objectMapper

clientId

private final String clientId

repoNamespace

private final String repoNamespace

repoName

private final String repoName

repoPath

private final String repoPath

projectPath

private final String projectPath

connectTimeout

private final int connectTimeout

readTimeout

private final int readTimeout

gitLab

private final org.gitlab4j.api.GitLabApi gitLab

canRead

private final boolean canRead

canWrite

private final boolean canWrite

Constructor Details

GitLabRepositoryClient

private GitLabRepositoryClient(GitLabRepositoryClient.Builder builder)
                        throws org.apache.nifi.registry.flow.FlowRegistryException

Throws:

org.apache.nifi.registry.flow.FlowRegistryException

Method Details

getRepoNamespace

public String getRepoNamespace()

getRepoName

public String getRepoName()

hasReadPermission

public boolean hasReadPermission()

Specified by:

hasReadPermission in interface GitRepositoryClient

hasWritePermission

public boolean hasWritePermission()

Specified by:

hasWritePermission in interface GitRepositoryClient

getBranches

public Set<String> getBranches()
                        throws org.apache.nifi.registry.flow.FlowRegistryException

Specified by:

getBranches in interface GitRepositoryClient

Throws:

org.apache.nifi.registry.flow.FlowRegistryException

getTopLevelDirectoryNames

public Set<String> getTopLevelDirectoryNames(String branch)
                                      throws org.apache.nifi.registry.flow.FlowRegistryException

Specified by:

getTopLevelDirectoryNames in interface GitRepositoryClient

Throws:

org.apache.nifi.registry.flow.FlowRegistryException

getFileNames

public Set<String> getFileNames(String directory,
 String branch)
                         throws org.apache.nifi.registry.flow.FlowRegistryException

Specified by:

getFileNames in interface GitRepositoryClient

Throws:

org.apache.nifi.registry.flow.FlowRegistryException

getCommits

public List<GitCommit> getCommits(String path,
 String branch)
                           throws org.apache.nifi.registry.flow.FlowRegistryException

Specified by:

getCommits in interface GitRepositoryClient

Throws:

org.apache.nifi.registry.flow.FlowRegistryException

getContentFromBranch

public InputStream getContentFromBranch(String path,
 String branch)
                                 throws org.apache.nifi.registry.flow.FlowRegistryException

Specified by:

getContentFromBranch in interface GitRepositoryClient

Throws:

org.apache.nifi.registry.flow.FlowRegistryException

getContentFromCommit

public InputStream getContentFromCommit(String path,
 String commitSha)
                                 throws org.apache.nifi.registry.flow.FlowRegistryException

Specified by:

getContentFromCommit in interface GitRepositoryClient

Throws:

org.apache.nifi.registry.flow.FlowRegistryException

getContentSha

public Optional<String> getContentSha(String path,
 String branch)
                               throws org.apache.nifi.registry.flow.FlowRegistryException

Specified by:

getContentSha in interface GitRepositoryClient

Throws:

org.apache.nifi.registry.flow.FlowRegistryException

createContent

public String createContent(GitCreateContentRequest request)
                     throws org.apache.nifi.registry.flow.FlowRegistryException

Specified by:

createContent in interface GitRepositoryClient

Throws:

org.apache.nifi.registry.flow.FlowRegistryException

deleteContent

public InputStream deleteContent(String filePath,
 String commitMessage,
 String branch)
                          throws org.apache.nifi.registry.flow.FlowRegistryException

Specified by:

deleteContent in interface GitRepositoryClient

Throws:

org.apache.nifi.registry.flow.FlowRegistryException

close

public void close()

Specified by:

close in interface GitRepositoryClient

getProject

private Optional<org.gitlab4j.api.models.Project> getProject()
                                                      throws org.apache.nifi.registry.flow.FlowRegistryException

Throws:

org.apache.nifi.registry.flow.FlowRegistryException

hasMinimumAccessLevel

private boolean hasMinimumAccessLevel(org.gitlab4j.api.models.Project project,
 org.gitlab4j.api.models.AccessLevel accessLevel)

getTokenInfo

private GitLabRepositoryClient.TokenInfo getTokenInfo()

createTokenInfo

private GitLabRepositoryClient.TokenInfo createTokenInfo(PersonalAccessToken personalAccessToken)

getPersonalAccessToken

private Optional<PersonalAccessToken> getPersonalAccessToken()

retrievePersonalAccessToken

private PersonalAccessToken retrievePersonalAccessToken()
                                                 throws org.apache.nifi.registry.flow.FlowRegistryException

Throws:

org.apache.nifi.registry.flow.FlowRegistryException

createConnection

private HttpURLConnection createConnection(String subPath)
                                    throws IOException

Throws:

IOException

getResolvedPath

private String getResolvedPath(String path)

isDirectory

private boolean isDirectory(org.gitlab4j.api.models.TreeItem item)

isFile

private boolean isFile(org.gitlab4j.api.models.TreeItem item)

toGitCommit

private GitCommit toGitCommit(org.gitlab4j.api.models.Commit commit)

execute

private <T> T execute(GitLabRepositoryClient.GitLabRequest<T> action)
               throws org.apache.nifi.registry.flow.FlowRegistryException

Throws:

org.apache.nifi.registry.flow.FlowRegistryException

builder

public static GitLabRepositoryClient.Builder builder()