com.taskadapter.redmineapi

Class RedmineManagerFactory

java.lang.Object

com.taskadapter.redmineapi.RedmineManagerFactory

public final class RedmineManagerFactory
extends java.lang.Object

Entry point for the API: use this class to communicate with Redmine servers.

Collection of creation methods for the redmine. Method number may grow as grows number of requirements. However, having all creation methods in one place allows us to refactor RemineManager internals without changing this external APIs. Moreover, we can create "named constructor" for redmine instances. This will allow us to have many construction methods with the same signature.

Method Summary

Methods

Modifier and Type	Method and Description
static org.apache.http.impl.conn.PoolingClientConnectionManager	createConnectionManager(int maxConnections, org.apache.http.conn.ssl.SSLSocketFactory sslSocketFactory)
static org.apache.http.impl.conn.PoolingClientConnectionManager	createDefaultConnectionManager() Creates default connection manager.
static TransportConfiguration	createDefaultHttpClientConfig() Creates a default configuration using a default HTTP client.
static TransportConfiguration	createDefaultTransportConfig()
static org.apache.http.impl.conn.PoolingClientConnectionManager	createInsecureConnectionManager() Creates default insecure connection manager.
static TransportConfiguration	createLongTermConfiguration(org.apache.http.conn.ClientConnectionManager connectionManager, int idleTimeout, int evictionCheck) Creates a transport which supports connection eviction.
static TransportConfiguration	createShortTermConfig(org.apache.http.conn.ClientConnectionManager connectionManager) Creates a transport which uses a client connection manager underneath.
static org.apache.http.impl.conn.PoolingClientConnectionManager	createSystemDefaultConnectionManager() Creates system default connection manager.
static RedmineManager	createUnauthenticated(java.lang.String uri) Creates a non-authenticating redmine manager.
static RedmineManager	createUnauthenticated(java.lang.String uri, TransportConfiguration config) Creates a non-authenticating redmine manager.
static RedmineManager	createWithApiKey(java.lang.String uri, java.lang.String apiAccessKey) Creates an instance of RedmineManager class.
static RedmineManager	createWithApiKey(java.lang.String uri, java.lang.String apiAccessKey, TransportConfiguration config) Creates an instance of RedmineManager class.
static RedmineManager	createWithUserAuth(java.lang.String uri, java.lang.String login, java.lang.String password) Creates a new RedmineManager with user-based authentication.
static RedmineManager	createWithUserAuth(java.lang.String uri, java.lang.String login, java.lang.String password, TransportConfiguration config) Creates a new redmine managen with user-based authentication.
static org.apache.http.impl.client.DefaultHttpClient	getNewHttpClient(org.apache.http.conn.ClientConnectionManager connectionManager) Helper method to create an http client from connection manager.

Methods inherited from class java.lang.Object

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

Method Detail

createUnauthenticated

public static RedmineManager createUnauthenticated(java.lang.String uri)

Creates a non-authenticating redmine manager.

Parameters:

uri - redmine manager URI.

createUnauthenticated

public static RedmineManager createUnauthenticated(java.lang.String uri,
                                   TransportConfiguration config)

Creates a non-authenticating redmine manager.

Parameters:

uri - redmine manager URI.

config - transport configuration.

createWithApiKey

public static RedmineManager createWithApiKey(java.lang.String uri,
                              java.lang.String apiAccessKey)

Creates an instance of RedmineManager class. Host and apiAccessKey are not checked at this moment.

Parameters:

uri - complete Redmine server web URI, including protocol and port number. Example: http://demo.redmine.org:8080

apiAccessKey - Redmine API access key. It is shown on "My Account" / "API access key" webpage (check http://redmine_server_url/my/account URL). This parameter is optional (can be set to NULL) for Redmine projects, which are "public".

createWithApiKey

public static RedmineManager createWithApiKey(java.lang.String uri,
                              java.lang.String apiAccessKey,
                              TransportConfiguration config)

Creates an instance of RedmineManager class. Host and apiAccessKey are not checked at this moment.

Parameters:

uri - complete Redmine server web URI, including protocol and port number. Example: http://demo.redmine.org:8080

apiAccessKey - Redmine API access key. It is shown on "My Account" / "API access key" webpage (check http://redmine_server_url/my/account URL). This parameter is optional (can be set to NULL) for Redmine projects, which are "public".

config - transport configuration.

createWithUserAuth

public static RedmineManager createWithUserAuth(java.lang.String uri,
                                java.lang.String login,
                                java.lang.String password)

Creates a new RedmineManager with user-based authentication.

Parameters:

uri - redmine manager URI.

login - user's name.

password - user's password.

createWithUserAuth

public static RedmineManager createWithUserAuth(java.lang.String uri,
                                java.lang.String login,
                                java.lang.String password,
                                TransportConfiguration config)

Creates a new redmine managen with user-based authentication.

Parameters:

uri - redmine manager URI.

login - user's name.

password - user's password.

config - transport configuration.

createInsecureConnectionManager

public static org.apache.http.impl.conn.PoolingClientConnectionManager createInsecureConnectionManager()
                                                                                                throws java.security.KeyStoreException,
                                                                                                       java.security.NoSuchAlgorithmException,
                                                                                                       java.security.cert.CertificateException,
                                                                                                       java.security.KeyManagementException,
                                                                                                       java.security.UnrecoverableKeyException

Creates default insecure connection manager.

Returns:

default insecure connection manager.

Throws:

java.security.KeyStoreException

java.security.NoSuchAlgorithmException

java.security.cert.CertificateException

java.security.KeyManagementException

java.security.UnrecoverableKeyException

createDefaultConnectionManager

public static org.apache.http.impl.conn.PoolingClientConnectionManager createDefaultConnectionManager()
                                                                                               throws java.security.KeyStoreException,
                                                                                                      java.security.NoSuchAlgorithmException,
                                                                                                      java.security.cert.CertificateException,
                                                                                                      java.security.KeyManagementException,
                                                                                                      java.security.UnrecoverableKeyException

Creates default connection manager.

Returns:

default insecure connection manager.

Throws:

java.security.KeyStoreException

java.security.NoSuchAlgorithmException

java.security.cert.CertificateException

java.security.KeyManagementException

java.security.UnrecoverableKeyException

createSystemDefaultConnectionManager

public static org.apache.http.impl.conn.PoolingClientConnectionManager createSystemDefaultConnectionManager()
                                                                                                     throws java.security.KeyStoreException,
                                                                                                            java.security.NoSuchAlgorithmException,
                                                                                                            java.security.cert.CertificateException,
                                                                                                            java.security.KeyManagementException,
                                                                                                            java.security.UnrecoverableKeyException

Creates system default connection manager. Takes in account system properties for SSL configuration.

Returns:

default insecure connection manager.

Throws:

java.security.KeyStoreException

java.security.NoSuchAlgorithmException

java.security.cert.CertificateException

java.security.KeyManagementException

java.security.UnrecoverableKeyException

createConnectionManager

public static org.apache.http.impl.conn.PoolingClientConnectionManager createConnectionManager(int maxConnections,
                                                                               org.apache.http.conn.ssl.SSLSocketFactory sslSocketFactory)

createDefaultHttpClientConfig

public static TransportConfiguration createDefaultHttpClientConfig()

Creates a default configuration using a default HTTP client.

createShortTermConfig

public static TransportConfiguration createShortTermConfig(org.apache.http.conn.ClientConnectionManager connectionManager)

Creates a transport which uses a client connection manager underneath. This transport configuration do not perform any connectino eviction and is usefull for some short-time communication. Common scerario for this method is to create RedmineManager, load/update some tasks and then shutdown all the manager.

Note that this configuration will shutdown connection manager when shutdown will be called on RedmineManager instance.

createLongTermConfiguration

public static TransportConfiguration createLongTermConfiguration(org.apache.http.conn.ClientConnectionManager connectionManager,
                                                 int idleTimeout,
                                                 int evictionCheck)

Creates a transport which supports connection eviction. This transport can be used in a long-term interactive scenarios where actual redmine communications are interleaved with user interactios (data input).

Shutting down redmine manager will also shut down provided connection manager.

Parameters:

connectionManager - connection manager to use.

idleTimeout - idle timeout for connection before eviction, seconds.

evictionCheck - eviction check interval, seconds.

createDefaultTransportConfig

public static TransportConfiguration createDefaultTransportConfig()

getNewHttpClient

public static org.apache.http.impl.client.DefaultHttpClient getNewHttpClient(org.apache.http.conn.ClientConnectionManager connectionManager)

Helper method to create an http client from connection manager. This new client is configured to use system proxy (if any).