com.taskadapter.redmineapi.internal

Class Transport

java.lang.Object

com.taskadapter.redmineapi.internal.Transport

public final class Transport
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Transport.ResultsWrapper<T>

Constructor Summary

Constructors

Constructor and Description
Transport(URIConfigurator configurator, org.apache.http.client.HttpClient client)

Method Summary

Modifier and Type	Method and Description
<T> T	addChildEntry(java.lang.Class<?> parentClass, java.lang.String parentId, T object, org.apache.http.NameValuePair... params) Performs an "add child object" request.
<T> T	addObject(T object, org.apache.http.NameValuePair... params) Performs an "add object" request.
void	addUserToGroup(int userId, int groupId)
void	addWatcherToIssue(int watcherId, int issueId)
<T> void	deleteChildId(java.lang.Class<?> parentClass, java.lang.String parentId, T object, java.lang.Integer value) Performs "delete child Id" request.
<T extends Identifiable> void	deleteObject(java.lang.Class<T> classs, java.lang.String id) Deletes an object.
<R> R	download(java.lang.String uri, ContentHandler<BasicHttpResponse,R> handler) Downloads redmine content.
<T> java.util.List<T>	getChildEntries(java.lang.Class<?> parentClass, int parentId, java.lang.Class<T> classs)
<T> java.util.List<T>	getChildEntries(java.lang.Class<?> parentClass, java.lang.String parentKey, java.lang.Class<T> classs) Delivers a list of a child entries.
<T> T	getChildEntry(java.lang.Class<?> parentClass, java.lang.String parentId, java.lang.Class<T> classs, java.lang.String childId, org.apache.http.NameValuePair... params) Delivers a single child entry by its identifier.
User	getCurrentUser(org.apache.http.NameValuePair... params)
<T> T	getObject(java.lang.Class<T> classs, java.lang.Integer key, org.apache.http.NameValuePair... args)
<T> T	getObject(java.lang.Class<T> classs, java.lang.String key, org.apache.http.NameValuePair... args)
<T> java.util.List<T>	getObjectsList(java.lang.Class<T> objectClass, java.util.Collection<? extends org.apache.http.NameValuePair> params) Returns all objects found using the provided parameters.
<T> java.util.List<T>	getObjectsList(java.lang.Class<T> objectClass, org.apache.http.NameValuePair... params)
<T> Transport.ResultsWrapper<T>	getObjectsListNoPaging(java.lang.Class<T> objectClass, java.util.Collection<? extends org.apache.http.NameValuePair> params) Returns an object list.
void	setCredentials(java.lang.String login, java.lang.String password)
void	setLogin(java.lang.String login)
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.
void	setPassword(java.lang.String password)
<T extends Identifiable> void	updateObject(T obj, org.apache.http.NameValuePair... params)
java.lang.String	upload(java.io.InputStream content) UPloads content on a server.

Methods inherited from class java.lang.Object

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

Constructor Detail

Transport

public Transport(URIConfigurator configurator,
                 org.apache.http.client.HttpClient client)

Method Detail

getCurrentUser

public User getCurrentUser(org.apache.http.NameValuePair... params)
                    throws RedmineException

Throws:

RedmineException

addObject

public <T> T addObject(T object,
                       org.apache.http.NameValuePair... params)
                throws RedmineException

Performs an "add object" request.

Parameters:

object - object to use.

params - name params.

Returns:

object to use.

Throws:

RedmineException - if something goes wrong.

addChildEntry

public <T> T addChildEntry(java.lang.Class<?> parentClass,
                           java.lang.String parentId,
                           T object,
                           org.apache.http.NameValuePair... params)
                    throws RedmineException

Performs an "add child object" request.

Parameters:

parentClass - parent object id.

object - object to use.

params - name params.

Returns:

object to use.

Throws:

RedmineException - if something goes wrong.

updateObject

public <T extends Identifiable> void updateObject(T obj,
                                                  org.apache.http.NameValuePair... params)
                                           throws RedmineException

Throws:

RedmineException

deleteChildId

public <T> void deleteChildId(java.lang.Class<?> parentClass,
                              java.lang.String parentId,
                              T object,
                              java.lang.Integer value)
                       throws RedmineException

Performs "delete child Id" request.

Parameters:

parentClass - parent object id.

object - object to use.

value - child object id.

Throws:

RedmineException - if something goes wrong.

deleteObject

public <T extends Identifiable> void deleteObject(java.lang.Class<T> classs,
                                                  java.lang.String id)
                                           throws RedmineException

Deletes an object.

Parameters:

classs - object class.

id - object id.

Throws:

RedmineException - if something goes wrong.

getObject

public <T> T getObject(java.lang.Class<T> classs,
                       java.lang.String key,
                       org.apache.http.NameValuePair... args)
                throws RedmineException

Parameters:

classs - target class

key - item key

args - extra arguments.

Throws:

RedmineAuthenticationException - invalid or no API access key is used with the server, which requires authorization. Check the constructor arguments.

NotFoundException - the object with the given key is not found

RedmineException

download

public <R> R download(java.lang.String uri,
                      ContentHandler<BasicHttpResponse,R> handler)
               throws RedmineException

Downloads redmine content.

Parameters:

uri - target uri.

handler - content handler.

Returns:

handler result.

Throws:

RedmineException - if something goes wrong.

upload

public java.lang.String upload(java.io.InputStream content)
                        throws RedmineException

UPloads content on a server.

Parameters:

content - content stream.

Returns:

uploaded item token.

Throws:

RedmineException - if something goes wrong.

getObject

public <T> T getObject(java.lang.Class<T> classs,
                       java.lang.Integer key,
                       org.apache.http.NameValuePair... args)
                throws RedmineException

Parameters:

classs - target class

key - item key

args - extra arguments.

Throws:

RedmineAuthenticationException - invalid or no API access key is used with the server, which requires authorization. Check the constructor arguments.

NotFoundException - the object with the given key is not found

RedmineException

getObjectsList

public <T> java.util.List<T> getObjectsList(java.lang.Class<T> objectClass,
                                            org.apache.http.NameValuePair... params)
                                     throws RedmineException

Throws:

RedmineException

getObjectsList

public <T> java.util.List<T> getObjectsList(java.lang.Class<T> objectClass,
                                            java.util.Collection<? extends org.apache.http.NameValuePair> params)
                                     throws RedmineException

Returns all objects found using the provided parameters. This method IGNORES "limit" and "offset" parameters and handles paging AUTOMATICALLY for you. Please use getObjectsListNoPaging() method if you want to control paging yourself with "limit" and "offset" parameters.

Returns:

objects list, never NULL

Throws:

RedmineException

See Also:

getObjectsListNoPaging(Class, Collection)

getObjectsListNoPaging

public <T> Transport.ResultsWrapper<T> getObjectsListNoPaging(java.lang.Class<T> objectClass,
                                                              java.util.Collection<? extends org.apache.http.NameValuePair> params)
                                                       throws RedmineException

Returns an object list. Provide your own "limit" and "offset" parameters if you need those, otherwise this method will return the first page of some default size only (this default is controlled by your Redmine configuration).

Returns:

objects list, never NULL

Throws:

RedmineException

getChildEntries

public <T> java.util.List<T> getChildEntries(java.lang.Class<?> parentClass,
                                             int parentId,
                                             java.lang.Class<T> classs)
                                      throws RedmineException

Throws:

RedmineException

getChildEntries

public <T> java.util.List<T> getChildEntries(java.lang.Class<?> parentClass,
                                             java.lang.String parentKey,
                                             java.lang.Class<T> classs)
                                      throws RedmineException

Delivers a list of a child entries.

Parameters:

classs - target class.

Throws:

RedmineException

getChildEntry

public <T> T getChildEntry(java.lang.Class<?> parentClass,
                           java.lang.String parentId,
                           java.lang.Class<T> classs,
                           java.lang.String childId,
                           org.apache.http.NameValuePair... params)
                    throws RedmineException

Delivers a single child entry by its identifier.

Throws:

RedmineException

setObjectsPerPage

public void setObjectsPerPage(int pageSize)

This number of objects (tasks, projects, users) will be requested from Redmine server in 1 request.

addUserToGroup

public void addUserToGroup(int userId,
                           int groupId)
                    throws RedmineException

Throws:

RedmineException

addWatcherToIssue

public void addWatcherToIssue(int watcherId,
                              int issueId)
                       throws RedmineException

Throws:

RedmineException

setCredentials

public void setCredentials(java.lang.String login,
                           java.lang.String password)

setPassword

public void setPassword(java.lang.String password)

setLogin

public void setLogin(java.lang.String login)

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