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

Methods

Modifier and Type	Method and Description
boolean	addBuildToBundle(User user, String bundleName, String buildName) Adds a build with the name to the bundle with the given name.
boolean	applyCommand(User user, Issue issue, String command, String comment, User runAs) Apply a command to an issue.
boolean	comment(User user, Issue issue, String comment) Adds a comment to the issue with currently logged in user.
Issue	getIssue(User user, String issueId) Gets an issue by issue id.
List<Project>	getProjects(User user) Gets all projects that the given user can see.
User	getUserByEmail(User user, String email) Get a YouTrack user from the e-mail address.
User	login(String username, String password) Logs in a user.

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

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 boolean comment(User user,
              Issue issue,
              String comment)

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

Parameters:

user - the currently logged in user.

issue - the issue to comment on.

comment - the comment text.

Returns:

if comment was added.

applyCommand

public boolean applyCommand(User user,
                   Issue issue,
                   String command,
                   String comment,
                   User runAs)

Apply a command to an issue.

Parameters:

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.

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

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 boolean addBuildToBundle(User user,
                       String bundleName,
                       String buildName)

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

Parameters:

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)

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.

Returns:

the issue if any.