com.taskadapter.redmineapi

Class RedmineManager

java.lang.Object

com.taskadapter.redmineapi.RedmineManager

public class RedmineManager
extends java.lang.Object

Wrapper to hold all manager classes.

Once you obtained an instance of RedmineManager, you can get references to all other xManagers:

 RedmineManager redmineManager = RedmineManagerFactory.createWithUserAuth(redmineURI, login, password);
 redmineManager.getIssueManager();
 redmineManager.getUserManager();
 ...etc...
 

See Also:

RedmineManagerFactory, IssueManager, UserManager, AttachmentManager, ProjectManager

Method Summary

Modifier and Type	Method and Description
AttachmentManager	getAttachmentManager()
CustomFieldManager	getCustomFieldManager()
IssueManager	getIssueManager()
MembershipManager	getMembershipManager()
ProjectManager	getProjectManager()
TimeEntryManager	getTimeEntryManager()
UserManager	getUserManager()
WikiManager	getWikiManager()
void	setObjectsPerPage(int pageSize) This number of objects (tasks, projects, users) will be requested from Redmine server in 1 request.
void	setOnBehalfOfUser(java.lang.String loginName) This works only when the main authentication has led to Redmine Admin level user.

Methods inherited from class java.lang.Object

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

Method Detail

getWikiManager

public WikiManager getWikiManager()

getIssueManager

public IssueManager getIssueManager()

getAttachmentManager

public AttachmentManager getAttachmentManager()

getUserManager

public UserManager getUserManager()

getProjectManager

public ProjectManager getProjectManager()

getMembershipManager

public MembershipManager getMembershipManager()

getCustomFieldManager

public CustomFieldManager getCustomFieldManager()

getTimeEntryManager

public TimeEntryManager getTimeEntryManager()

setObjectsPerPage

public void setObjectsPerPage(int pageSize)

This number of objects (tasks, projects, users) will be requested from Redmine server in 1 request. Note that if you set objects per page to be, say, 10, and you have 20 objects on the server, then issueManager.getIssues() will still return ALL 20 objects at once even though the library will perform 2 requests to the server (to load 10 objects each time).

setOnBehalfOfUser

public void setOnBehalfOfUser(java.lang.String loginName)

This works only when the main authentication has led to Redmine Admin level user. The given user name will be sent to the server in "X-Redmine-Switch-User" HTTP Header to indicate that the action (create issue, delete issue, etc) must be done on behalf of the given user name.

Parameters:

loginName - Redmine user login name to provide to the server

See Also:

Redmine issue 11755