org.jenkinsci.plugins.youtrack.youtrackapi

Class YouTrackServer

java.lang.Object

org.jenkinsci.plugins.youtrack.youtrackapi.YouTrackServer

public class YouTrackServer
extends Object

This class contains methods for communication with a YouTrack server using the REST API for version 4 of YouTrack.

Constructor Summary

Constructors

Constructor and Description
YouTrackServer(String serverUrl) Constructs a server.

Method Summary

Modifier and Type	Method and Description
Command	addBuildToBundle(String siteName, User user, String bundleName, String buildName) Adds a build with the name to the bundle with the given name.
Command	applyCommand(String siteName, User user, Issue issue, String command, String comment, String group, User runAs, boolean notify) Apply a command to an issue.
Command	comment(String siteName, User user, Issue issue, String comment, String group, boolean silent) Adds a comment to the issue with currently logged in user.
Command	createIssue(String siteName, User user, String project, String title, String description, String command, File attachment)
String	getBuildBundleNameForField(User user, String projectId, String fieldName)
List<BuildBundle>	getBuildBundles(User user)
List<Field>	getFields(User user)
List<Group>	getGroups(User user)
Issue	getIssue(User user, String issueId, String stateField) Gets an issue by issue id.
List<Project>	getProjects(User user) Gets all projects that the given user can see.
StateBundle	getStateBundleForField(User user, String fieldName)
StateBundle	getStateBundleWithName(User user, String stateBundleName) Gets a state bundle for the given name filled with the state values/
User	getUserByEmail(User user, String email) Get a YouTrack user from the e-mail address.
String[]	getVersion()
User	login(String username, String password) Logs in a user.
List<Issue>	search(User user, String searchQuery)
List<Suggestion>	searchSuggestions(User user, String current)

Methods inherited from class java.lang.Object

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

Constructor Detail

YouTrackServer

public YouTrackServer(String serverUrl)

Constructs a server.

Parameters:

serverUrl - the url of the server.

Method Detail

createIssue

public Command createIssue(String siteName,
                           User user,
                           String project,
                           String title,
                           String description,
                           String command,
                           File attachment)

getGroups

public List<Group> getGroups(User user)

getStateBundleWithName

public StateBundle getStateBundleWithName(User user,
                                          String stateBundleName)

Gets a state bundle for the given name filled with the state values/

Parameters:

user - the user

stateBundleName - the name of the state bundle.

Returns:

the state bundle.

getStateBundleForField

public StateBundle getStateBundleForField(User user,
                                          String fieldName)

getBuildBundleNameForField

public String getBuildBundleNameForField(User user,
                                         String projectId,
                                         String fieldName)

getFields

public List<Field> getFields(User user)

getProjects

public List<Project> getProjects(User user)

Gets all projects that the given user can see. The user shall be one obtained from login(String, String), i.e. it should contains the cookie strings for the users login session.

Parameters:

user - the user to get projects for.

Returns:

the list of projects the user can see.

comment

public Command comment(String siteName,
                       User user,
                       Issue issue,
                       String comment,
                       String group,
                       boolean silent)

Adds a comment to the issue with currently logged in user.

Parameters:

siteName - name of site configuration to comment on.

user - the currently logged in user.

issue - the issue to comment on.

comment - the comment text.

group - the group the comment should be visible to.

silent - prevents watchers from being notified.

Returns:

if comment was added.

applyCommand

public Command applyCommand(String siteName,
                            User user,
                            Issue issue,
                            String command,
                            String comment,
                            String group,
                            User runAs,
                            boolean notify)

Apply a command to an issue.

Parameters:

siteName - name of site.

user - the user used to apply the command, shall be one with cookies set.

issue - the issue to apply the command to.

command - the command to apply.

comment - comment with the command, null is allowed.

group - the visibility group for the command.

runAs - user to apply the command as, null is allowed.

notify - notifies watchers.

Returns:

the command.

getUserByEmail

public User getUserByEmail(User user,
                           String email)

Get a YouTrack user from the e-mail address.

Parameters:

user - the user to get.

email - the email to get.

Returns:

the user, null if none found.

login

public User login(String username,
                  String password)

Logs in a user. The result is the user object with cookies set, which should be used on all subsequent requests.

Parameters:

username - the username of the user.

password - the password of the user.

Returns:

user, null if fails to login

addBuildToBundle

public Command addBuildToBundle(String siteName,
                                User user,
                                String bundleName,
                                String buildName)

Adds a build with the name to the bundle with the given name.

Parameters:

siteName - the name of the site to add bundle to.

user - the logged in user.

bundleName - the name of the bundle to add a build to.

buildName - the name of the build to add.

getIssue

public Issue getIssue(User user,
                      String issueId,
                      String stateField)

Gets an issue by issue id.

Currently the only value retrieved is the State field.

Parameters:

user - the user session.

issueId - the id of the issue.

stateField - the state field.

Returns:

the issue if any.

getVersion

public String[] getVersion()

getBuildBundles

public List<BuildBundle> getBuildBundles(User user)

search

public List<Issue> search(User user,
                          String searchQuery)

searchSuggestions

public List<Suggestion> searchSuggestions(User user,
                                          String current)