com.taskadapter.redmineapi

Class TransportConfiguration

java.lang.Object

com.taskadapter.redmineapi.TransportConfiguration

public final class TransportConfiguration
extends java.lang.Object

Configuration of transport layer for the Redmine manager. We are leaking transport level abstraction. As demand grows, we provide more and more options. That options make sense only for a specific implementations (like eviction parameters). Adding more options will just leak more and more abstractions and we still would not be able to change implementation without making out API obsolete. So we provide a class to configure lowest possible level but encourage users to use provided factory methods for such configurations.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.Runnable	shutdownListener

Method Summary

Modifier and Type	Method and Description
static TransportConfiguration	create(org.apache.http.client.HttpClient client, java.lang.Runnable shutdownListener) Creates a new transport configuration to use inside redmine manager.

Methods inherited from class java.lang.Object

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

Field Detail

shutdownListener

public final java.lang.Runnable shutdownListener

Method Detail

create

public static TransportConfiguration create(org.apache.http.client.HttpClient client,
                                            java.lang.Runnable shutdownListener)

Creates a new transport configuration to use inside redmine manager.

Redmine manager works with the HTTP protocol. That protocol supports keep-alive connections so connection management became crucial. At some point RedmineManager may became unneeded and can be closed by call to a RedmineManager.shutdown(). We need to notify an underlying provider that this "client" is no longer used by manager. We can't close client's connection manager for two reasons. First, that connection manager can be used by other clients. Second, some additional work may be associated with that connection manager. Connection evictors are usually point of caution.

Parameters:

client - http client to use for the communication with the server.

shutdownListener - listener to call when redmine manager is shut down or finalized. May be null if no additional shutdown procedures are required.

Returns:

transport configuration for redmine manager.