org.ow2.infra.utils.git

Class GitlabIssueManager

java.lang.Object

org.ow2.infra.utils.git.GitlabIssueManager

public class GitlabIssueManager
extends Object

Manage Gitlab issues.

Author:

Pierre-Yves Gibello - OW2

Field Summary

Fields

Modifier and Type	Field and Description
static String	ISSUE_CLOSED
static String	ISSUE_OPENED
static String	ISSUE_REOPENED

Constructor Summary

Constructors

Constructor and Description
GitlabIssueManager()

Method Summary

Modifier and Type	Method and Description
static boolean	commentIssue(Properties gitlabConfig, int iid, String body) Comment an issue (adding notes)
static boolean	commentIssue(String gitlabUrl, String privateToken, Object projectIdOrPath, int iid, String comment) Comment an issue (adding notes)
static org.gitlab4j.api.models.Issue	createIssue(Properties gitlabConfig, String title, String description) Create a Gitlab issue for a given project
static org.gitlab4j.api.models.Issue	createIssue(String gitlabUrl, String privateToken, Object projectIdOrPath, String title, String description) Create a Gitlab issue for a given project
static void	deleteIssue(Properties gitlabConfig, int iid) Delete an issue for a given project
static void	deleteIssue(String gitlabUrl, String privateToken, Object projectIdOrPath, int iid) Delete an issue for a given project
static org.gitlab4j.api.models.Issue	getIssue(Properties gitlabConfig, int iid)
static org.gitlab4j.api.models.Issue	getIssue(String gitlabUrl, String privateToken, Object projectIdOrPath, int iid)
static boolean	isExceptionLikely(org.gitlab4j.api.models.Issue issue) Decide whether an issue is likely to contain an exception stack (or not)
static List<org.gitlab4j.api.models.Issue>	listIssues(Properties gitlabConfig, String state) List gitlab issues for a given project
static List<org.gitlab4j.api.models.Issue>	listIssues(String gitlabUrl, String privateToken, Object projectIdOrPath, String state) List gitlab issues for a given project
static List<org.gitlab4j.api.models.Issue>	listIssues(String gitlabUrl, String user, String password, Object projectIdOrPath, String state) List gitlab issues for a given project
static org.gitlab4j.api.models.Issue	updateIssue(Properties gitlabConfig, int iid, String title, String description) Update a Gitlab issue for a given project
static org.gitlab4j.api.models.Issue	updateIssue(String gitlabUrl, String privateToken, Object projectIdOrPath, int iid, String title, String description) Update a Gitlab issue for a given project

Methods inherited from class java.lang.Object

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

Field Detail

ISSUE_OPENED

public static final String ISSUE_OPENED

See Also:

Constant Field Values

ISSUE_CLOSED

public static final String ISSUE_CLOSED

See Also:

Constant Field Values

ISSUE_REOPENED

public static final String ISSUE_REOPENED

See Also:

Constant Field Values

Constructor Detail

GitlabIssueManager

public GitlabIssueManager()

Method Detail

listIssues

public static List<org.gitlab4j.api.models.Issue> listIssues(String gitlabUrl,
                                                             String privateToken,
                                                             Object projectIdOrPath,
                                                             String state)
                                                      throws IOException

List gitlab issues for a given project

Parameters:

gitlabUrl - Gitlab server URL

privateToken - Gitlab private token for authentication

projectIdOrPath - Gitlab project ID or path

state - Gitlab issue state (one of OPENED, CLOSED, REOPENED)

Returns:

The list of gitlabs issues that meet the criteria

Throws:

IOException

listIssues

public static List<org.gitlab4j.api.models.Issue> listIssues(String gitlabUrl,
                                                             String user,
                                                             String password,
                                                             Object projectIdOrPath,
                                                             String state)
                                                      throws IOException

List gitlab issues for a given project

Parameters:

gitlabUrl - Gitlab server URL

user - Gitlab user for authentication

password - Gitlab password for authentication

projectIdOrPath - Gitlab project ID or path

state - Gitlab issue state (one of OPENED, CLOSED, REOPENED)

Returns:

The list of gitlabs issues that meet the criteria

Throws:

IOException

listIssues

public static List<org.gitlab4j.api.models.Issue> listIssues(Properties gitlabConfig,
                                                             String state)
                                                      throws IOException

List gitlab issues for a given project

Parameters:

properties - Gitlab config with gitlab.url, gitlab.token and gitlab.project expected

state - Gitlab issue state (one of OPENED, CLOSED, REOPENED)

Returns:

The list of gitlabs issues that meet the criteria

Throws:

IOException

getIssue

public static org.gitlab4j.api.models.Issue getIssue(String gitlabUrl,
                                                     String privateToken,
                                                     Object projectIdOrPath,
                                                     int iid)
                                              throws IOException

Parameters:

gitlabUrl - Gitlab server URL

privateToken - Gitlab private token for authentication

projectIdOrPath - Gitlab project ID or path

iid - Issue ID

Returns:

The requested issue, null if not found

Throws:

IOException

getIssue

public static org.gitlab4j.api.models.Issue getIssue(Properties gitlabConfig,
                                                     int iid)
                                              throws IOException

Parameters:

properties - Gitlab config with gitlab.url, gitlab.token and gitlab.project expected

iid - Issue ID

Returns:

The requested issue, null if not found

Throws:

IOException

commentIssue

public static boolean commentIssue(String gitlabUrl,
                                   String privateToken,
                                   Object projectIdOrPath,
                                   int iid,
                                   String comment)
                            throws IOException

Comment an issue (adding notes)

Parameters:

gitlabUrl - Gitlab server URL

privateToken - Gitlab private token for authentication

projectIdOrPath - Gitlab project ID or path

iid - Issue ID

body - Comment body (text)

Returns:

true if success, false otherwise

Throws:

IOException

commentIssue

public static boolean commentIssue(Properties gitlabConfig,
                                   int iid,
                                   String body)
                            throws IOException

Comment an issue (adding notes)

Parameters:

properties - Gitlab config with gitlab.url, gitlab.token and gitlab.project expected

iid - Issue ID

body - Comment body (text)

Returns:

true if success, false otherwise

Throws:

IOException

createIssue

public static org.gitlab4j.api.models.Issue createIssue(String gitlabUrl,
                                                        String privateToken,
                                                        Object projectIdOrPath,
                                                        String title,
                                                        String description)
                                                 throws IOException

Create a Gitlab issue for a given project

Parameters:

gitlabUrl - Gitlab server URL

privateToken - Gitlab private token for authentication

projectIdOrPath - Gitlab project ID or path

title - Issue title

description - Issue content

Returns:

The issue created

Throws:

IOException

createIssue

public static org.gitlab4j.api.models.Issue createIssue(Properties gitlabConfig,
                                                        String title,
                                                        String description)
                                                 throws IOException

Create a Gitlab issue for a given project

Parameters:

gitlabConfig - Gitlab config with gitlab.url, gitlab.token and gitlab.project expected

title - Issue title

description - Issue content

Returns:

The issue created

Throws:

IOException

updateIssue

public static org.gitlab4j.api.models.Issue updateIssue(String gitlabUrl,
                                                        String privateToken,
                                                        Object projectIdOrPath,
                                                        int iid,
                                                        String title,
                                                        String description)
                                                 throws IOException

Update a Gitlab issue for a given project

Parameters:

gitlabUrl - Gitlab server URL

privateToken - Gitlab private token for authentication

projectIdOrPath - Gitlab project ID or path

iid - ID of issue to update

title - Issue title

description - Issue content

Returns:

The issue updated

Throws:

IOException

updateIssue

public static org.gitlab4j.api.models.Issue updateIssue(Properties gitlabConfig,
                                                        int iid,
                                                        String title,
                                                        String description)
                                                 throws IOException

Update a Gitlab issue for a given project

Parameters:

gitlabConfig - Gitlab config with gitlab.url, gitlab.token and gitlab.project expected

iid - ID of issue to update

title - Issue title

description - Issue content

Returns:

The issue updated

Throws:

IOException

deleteIssue

public static void deleteIssue(String gitlabUrl,
                               String privateToken,
                               Object projectIdOrPath,
                               int iid)
                        throws IOException

Delete an issue for a given project

Parameters:

gitlabUrl - Gitlab server URL

privateToken - Gitlab private token for authentication

projectIdOrPath - Gitlab project ID or path

iid - Issue ID

Throws:

IOException

deleteIssue

public static void deleteIssue(Properties gitlabConfig,
                               int iid)
                        throws IOException

Delete an issue for a given project

Parameters:

gitlabConfig - Gitlab config with gitlab.url, gitlab.token and gitlab.project expected

iid - Issue ID

Throws:

IOException

isExceptionLikely

public static boolean isExceptionLikely(org.gitlab4j.api.models.Issue issue)

Decide whether an issue is likely to contain an exception stack (or not)

Parameters:

issue - The issue to check

Returns:

true if likely, false if not