org.nuiton.jredmine.client

Class RedmineClient

java.lang.Object

org.nuiton.jredmine.client.RedmineClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class RedmineClient
extends Object
implements Closeable

A simple redmine client.

Since:

1.5

Author:

tchemit

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	RedmineClient.AbstractRedmineResponseHandler<T>
protected static class	RedmineClient.RedmineArrayResponseHandler<T>
protected static class	RedmineClient.RedmineSimpleResponseHandler<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.http.client.HttpClient	client
protected RedmineClientConfiguration	configuration
protected org.apache.http.conn.HttpClientConnectionManager	connectionManager
protected boolean	open
protected URI	serverURI
protected boolean	showRequest
protected RedmineXpp3Helper	xpp3Helper xpp3 xpp3Helper to transform xml stream to pojo

Constructor Summary

Constructors

Constructor and Description
RedmineClient(RedmineClientConfiguration configuration)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addParams(org.apache.http.client.methods.HttpRequestBase gm, Map<String,String> parameters)
protected void	addParamsAsEntity(org.apache.http.HttpEntityEnclosingRequest gm, Map<String,String> parameters)
void	close()
<T> T	executeRequest(RedmineRequest<T> request) Ask some data from the server
<T> T[]	executeRequests(RedmineRequest<T> request) Ask some data from the server
RedmineClientConfiguration	getConfiguration()
protected <T> String	getRequestUrl(RedmineRequest<T> request)
boolean	isOpen()
void	open()
protected <T> org.apache.http.client.methods.HttpDelete	prepareDeleteRequest(RedmineRequest<T> request)
protected <T> org.apache.http.client.methods.HttpGet	prepareGetRequest(RedmineRequest<T> request)
protected void	prepareMultiPart(org.apache.http.client.methods.HttpEntityEnclosingRequestBase gm, Map<String,File> attachments, Map<String,String> parameters)
protected <T> org.apache.http.client.methods.HttpPost	preparePostRequest(RedmineRequest<T> request)
protected <T> org.apache.http.client.methods.HttpPut	preparePutRequest(RedmineRequest<T> request)
protected <T> org.apache.http.client.methods.HttpRequestBase	prepareRequest(RedmineRequest<T> request)
protected void	releaseConnection()

Methods inherited from class java.lang.Object

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

Field Detail

xpp3Helper

protected final RedmineXpp3Helper xpp3Helper

xpp3 xpp3Helper to transform xml stream to pojo

configuration

protected final RedmineClientConfiguration configuration

client

protected final org.apache.http.client.HttpClient client

serverURI

protected final URI serverURI

connectionManager

protected final org.apache.http.conn.HttpClientConnectionManager connectionManager

showRequest

protected boolean showRequest

open

protected boolean open

Constructor Detail

RedmineClient

public RedmineClient(RedmineClientConfiguration configuration)

Method Detail

isOpen

public boolean isOpen()

open

public void open()
          throws IOException

Throws:

IOException

executeRequest

public <T> T executeRequest(RedmineRequest<T> request)
                 throws IOException

Ask some data from the server

Parameters:

request - request used for asking data

Returns:

the stream of the response

Throws:

IOException - if any pb while do request or receive result

executeRequests

public <T> T[] executeRequests(RedmineRequest<T> request)
                    throws IOException

Ask some data from the server

Parameters:

request - request used for asking data

Returns:

the stream of the response

Throws:

IOException - if any pb while do request or receive result

getConfiguration

public RedmineClientConfiguration getConfiguration()

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

prepareRequest

protected <T> org.apache.http.client.methods.HttpRequestBase prepareRequest(RedmineRequest<T> request)
                                                                 throws IOException

Throws:

IOException

getRequestUrl

protected <T> String getRequestUrl(RedmineRequest<T> request)

prepareGetRequest

protected <T> org.apache.http.client.methods.HttpGet prepareGetRequest(RedmineRequest<T> request)
                                                            throws IOException

Throws:

IOException

prepareDeleteRequest

protected <T> org.apache.http.client.methods.HttpDelete prepareDeleteRequest(RedmineRequest<T> request)
                                                                  throws IOException

Throws:

IOException

preparePostRequest

protected <T> org.apache.http.client.methods.HttpPost preparePostRequest(RedmineRequest<T> request)
                                                              throws IOException

Throws:

IOException

preparePutRequest

protected <T> org.apache.http.client.methods.HttpPut preparePutRequest(RedmineRequest<T> request)
                                                            throws IOException

Throws:

IOException

addParams

protected void addParams(org.apache.http.client.methods.HttpRequestBase gm,
             Map<String,String> parameters)
                  throws IOException

Throws:

IOException

addParamsAsEntity

protected void addParamsAsEntity(org.apache.http.HttpEntityEnclosingRequest gm,
                     Map<String,String> parameters)
                          throws IOException

Throws:

IOException

prepareMultiPart

protected void prepareMultiPart(org.apache.http.client.methods.HttpEntityEnclosingRequestBase gm,
                    Map<String,File> attachments,
                    Map<String,String> parameters)
                         throws IOException

Throws:

IOException

releaseConnection

protected void releaseConnection()