HttpClientConnection

java.lang.Object
- org.eclipse.jgit.transport.http.apache.HttpClientConnection

All Implemented Interfaces:: HttpConnection

public class HttpClientConnection
extends java.lang.Object
implements HttpConnection

A HttpConnection which uses HttpClient

Since:: 3.3

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) org.apache.http.client.HttpClient`	`client`
`(package private) javax.net.ssl.SSLContext`	`ctx`
`private TemporaryBufferEntity`	`entity`
`private java.lang.Boolean`	`followRedirects`
`private javax.net.ssl.HostnameVerifier`	`hostnameverifier`
`private boolean`	`isUsingProxy`
`(package private) java.lang.String`	`method`
`private java.net.Proxy`	`proxy`
`private java.lang.Integer`	`readTimeout`
`(package private) org.apache.http.client.methods.HttpUriRequest`	`req`
`(package private) org.apache.http.HttpResponse`	`resp`
`private java.lang.Integer`	`timeout`
`(package private) java.net.URL`	`url`

Fields inherited from interface org.eclipse.jgit.transport.http.HttpConnection
HTTP_11_MOVED_TEMP, HTTP_FORBIDDEN, HTTP_MOVED_PERM, HTTP_MOVED_TEMP, HTTP_NOT_FOUND, HTTP_OK, HTTP_SEE_OTHER, HTTP_UNAUTHORIZED

Constructor Summary

Constructors
Constructor and Description
`HttpClientConnection(java.lang.String urlStr)` Constructor for HttpClientConnection.
`HttpClientConnection(java.lang.String urlStr, java.net.Proxy proxy)` Constructor for HttpClientConnection.
`HttpClientConnection(java.lang.String urlStr, java.net.Proxy proxy, org.apache.http.client.HttpClient cl)` Constructor for HttpClientConnection.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`configure(javax.net.ssl.KeyManager[] km, javax.net.ssl.TrustManager[] tm, java.security.SecureRandom random)` Configure the connection so that it can be used for https communication.
`void`	`connect()` Connect
`private void`	`execute()`
`private org.apache.http.client.HttpClient`	`getClient()`
`int`	`getContentLength()` Get content length
`java.lang.String`	`getContentType()` Get content type
`java.lang.String`	`getHeaderField(java.lang.String name)` Get header field
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getHeaderFields()` Get list of header fields
`java.io.InputStream`	`getInputStream()` Get input stream
`java.io.OutputStream`	`getOutputStream()` Get output stream
`java.lang.String`	`getRequestMethod()` Get request method
`int`	`getResponseCode()` Get response code
`java.lang.String`	`getResponseMessage()` Get response message
`private javax.net.ssl.SSLContext`	`getSSLContext()`
`java.net.URL`	`getURL()` Get URL
`void`	`setBuffer(TemporaryBuffer buffer)` Sets the buffer from which to take the request body
`void`	`setChunkedStreamingMode(int chunklen)` Set chunked streaming mode
`void`	`setConnectTimeout(int timeout)` Set connect timeout
`void`	`setDoOutput(boolean dooutput)` Set if to do output
`void`	`setFixedLengthStreamingMode(int contentLength)` Set fixed length streaming mode
`void`	`setHostnameVerifier(javax.net.ssl.HostnameVerifier hostnameverifier)` Set the `HostnameVerifier` used during https communication
`void`	`setInstanceFollowRedirects(boolean followRedirects)` Set whether or not to follow HTTP redirects.
`void`	`setReadTimeout(int readTimeout)` Set read timeout
`void`	`setRequestMethod(java.lang.String method)` Set request method
`void`	`setRequestProperty(java.lang.String name, java.lang.String value)` Set request property
`void`	`setUseCaches(boolean usecaches)` Set if to use caches
`boolean`	`usingProxy()` Whether we use a proxy

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - client
```
org.apache.http.client.HttpClient client
```
  - url
```
java.net.URL url
```
  - req
```
org.apache.http.client.methods.HttpUriRequest req
```
  - resp
```
org.apache.http.HttpResponse resp
```
  - method
```
java.lang.String method
```
  - entity
```
private TemporaryBufferEntity entity
```
  - isUsingProxy
```
private boolean isUsingProxy
```
  - proxy
```
private java.net.Proxy proxy
```
  - timeout
```
private java.lang.Integer timeout
```
  - readTimeout
```
private java.lang.Integer readTimeout
```
  - followRedirects
```
private java.lang.Boolean followRedirects
```
  - hostnameverifier
```
private javax.net.ssl.HostnameVerifier hostnameverifier
```
  - ctx
```
javax.net.ssl.SSLContext ctx
```
- Constructor Detail
  - HttpClientConnection
```
public HttpClientConnection(java.lang.String urlStr)
                     throws java.net.MalformedURLException
```
    Constructor for HttpClientConnection.
    
    Parameters:
    
    urlStr -
    
    Throws:
    
    java.net.MalformedURLException
  - HttpClientConnection
```
public HttpClientConnection(java.lang.String urlStr,
                            java.net.Proxy proxy)
                     throws java.net.MalformedURLException
```
    Constructor for HttpClientConnection.
    
    Parameters:
    
    urlStr -
    
    proxy -
    
    Throws:
    
    java.net.MalformedURLException
  - HttpClientConnection
```
public HttpClientConnection(java.lang.String urlStr,
                            java.net.Proxy proxy,
                            org.apache.http.client.HttpClient cl)
                     throws java.net.MalformedURLException
```
    Constructor for HttpClientConnection.
    
    Parameters:
    
    urlStr -
    
    proxy -
    
    cl -
    
    Throws:
    
    java.net.MalformedURLException
- Method Detail
  - getClient
```
private org.apache.http.client.HttpClient getClient()
```
  - getSSLContext
```
private javax.net.ssl.SSLContext getSSLContext()
```
  - setBuffer
```
public void setBuffer(TemporaryBuffer buffer)
```
    Sets the buffer from which to take the request body
    
    Parameters:
    
    buffer -
  - getResponseCode
```
public int getResponseCode()
                    throws java.io.IOException
```
    Get response code
    
    Specified by:
    
    getResponseCode in interface HttpConnection
    
    Returns:
    
    the HTTP Status-Code, or -1
    
    Throws:
    
    java.io.IOException
    
    See Also:
    
    HttpURLConnection.getResponseCode()
  - getURL
```
public java.net.URL getURL()
```
    Get URL
    
    Specified by:
    
    getURL in interface HttpConnection
    
    Returns:
    
    the URL.
    
    See Also:
    
    URLConnection.getURL()
  - getResponseMessage
```
public java.lang.String getResponseMessage()
                                    throws java.io.IOException
```
    Get response message
    
    Specified by:
    
    getResponseMessage in interface HttpConnection
    
    Returns:
    
    the HTTP response message, or null
    
    Throws:
    
    java.io.IOException
    
    See Also:
    
    HttpURLConnection.getResponseMessage()
  - execute
```
private void execute()
              throws java.io.IOException,
                     org.apache.http.client.ClientProtocolException
```
    Throws:
    
    java.io.IOException
    
    org.apache.http.client.ClientProtocolException
  - getHeaderFields
```
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getHeaderFields()
```
    Get list of header fields
    
    Specified by:
    
    getHeaderFields in interface HttpConnection
    
    Returns:
    
    a Map of header fields
    
    See Also:
    
    URLConnection.getHeaderFields()
  - setRequestProperty
```
public void setRequestProperty(java.lang.String name,
                               java.lang.String value)
```
    Set request property
    
    Specified by:
    
    setRequestProperty in interface HttpConnection
    
    Parameters:
    
    name - the keyword by which the request is known (e.g., " Accept").
    
    value - the value associated with it.
    
    See Also:
    
    URLConnection.setRequestProperty(String, String)
  - setRequestMethod
```
public void setRequestMethod(java.lang.String method)
                      throws java.net.ProtocolException
```
    Set request method
    
    Specified by:
    
    setRequestMethod in interface HttpConnection
    
    Parameters:
    
    method - the HTTP method
    
    Throws:
    
    java.net.ProtocolException - if the method cannot be reset or if the requested method isn't valid for HTTP.
    
    See Also:
    
    HttpURLConnection.setRequestMethod(String)
  - setUseCaches
```
public void setUseCaches(boolean usecaches)
```
    Set if to use caches
    
    Specified by:
    
    setUseCaches in interface HttpConnection
    
    Parameters:
    
    usecaches - a boolean indicating whether or not to allow caching
    
    See Also:
    
    URLConnection.setUseCaches(boolean)
  - setConnectTimeout
```
public void setConnectTimeout(int timeout)
```
    Set connect timeout
    
    Specified by:
    
    setConnectTimeout in interface HttpConnection
    
    Parameters:
    
    timeout - an int that specifies the connect timeout value in milliseconds
    
    See Also:
    
    URLConnection.setConnectTimeout(int)
  - setReadTimeout
```
public void setReadTimeout(int readTimeout)
```
    Set read timeout
    
    Specified by:
    
    setReadTimeout in interface HttpConnection
    
    Parameters:
    
    readTimeout - an int that specifies the timeout value to be used in milliseconds
    
    See Also:
    
    URLConnection.setReadTimeout(int)
  - getContentType
```
public java.lang.String getContentType()
```
    Get content type
    
    Specified by:
    
    getContentType in interface HttpConnection
    
    Returns:
    
    the content type of the resource that the URL references, or null if not known.
    
    See Also:
    
    URLConnection.getContentType()
  - getInputStream
```
public java.io.InputStream getInputStream()
                                   throws java.io.IOException
```
    Get input stream
    
    Specified by:
    
    getInputStream in interface HttpConnection
    
    Returns:
    
    an input stream that reads from this open connection.
    
    Throws:
    
    java.io.IOException - if an I/O error occurs while creating the input stream.
    
    See Also:
    
    URLConnection.getInputStream()
  - getHeaderField
```
public java.lang.String getHeaderField(java.lang.String name)
```
    Get header field
    
    Specified by:
    
    getHeaderField in interface HttpConnection
    
    Parameters:
    
    name - the name of a header field.
    
    Returns:
    
    the value of the named header field, or null if there is no such field in the header.
    
    See Also:
    
    URLConnection.getHeaderField(String)
  - getContentLength
```
public int getContentLength()
```
    Get content length
    
    Specified by:
    
    getContentLength in interface HttpConnection
    
    Returns:
    
    the content length of the resource that this connection's URL references, -1 if the content length is not known, or if the content length is greater than Integer.MAX_VALUE.
    
    See Also:
    
    URLConnection.getContentLength()
  - setInstanceFollowRedirects
```
public void setInstanceFollowRedirects(boolean followRedirects)
```
    Set whether or not to follow HTTP redirects.
    
    Specified by:
    
    setInstanceFollowRedirects in interface HttpConnection
    
    Parameters:
    
    followRedirects - a boolean indicating whether or not to follow HTTP redirects.
    
    See Also:
    
    HttpURLConnection.setInstanceFollowRedirects(boolean)
  - setDoOutput
```
public void setDoOutput(boolean dooutput)
```
    Set if to do output
    
    Specified by:
    
    setDoOutput in interface HttpConnection
    
    Parameters:
    
    dooutput - the new value.
    
    See Also:
    
    URLConnection.setDoOutput(boolean)
  - setFixedLengthStreamingMode
```
public void setFixedLengthStreamingMode(int contentLength)
```
    Set fixed length streaming mode
    
    Specified by:
    
    setFixedLengthStreamingMode in interface HttpConnection
    
    Parameters:
    
    contentLength - The number of bytes which will be written to the OutputStream.
    
    See Also:
    
    HttpURLConnection.setFixedLengthStreamingMode(int)
  - getOutputStream
```
public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException
```
    Get output stream
    
    Specified by:
    
    getOutputStream in interface HttpConnection
    
    Returns:
    
    an output stream that writes to this connection.
    
    Throws:
    
    java.io.IOException
    
    See Also:
    
    URLConnection.getOutputStream()
  - setChunkedStreamingMode
```
public void setChunkedStreamingMode(int chunklen)
```
    Set chunked streaming mode
    
    Specified by:
    
    setChunkedStreamingMode in interface HttpConnection
    
    Parameters:
    
    chunklen - The number of bytes to write in each chunk. If chunklen is less than or equal to zero, a default value will be used.
    
    See Also:
    
    HttpURLConnection.setChunkedStreamingMode(int)
  - getRequestMethod
```
public java.lang.String getRequestMethod()
```
    Get request method
    
    Specified by:
    
    getRequestMethod in interface HttpConnection
    
    Returns:
    
    the HTTP request method
    
    See Also:
    
    HttpURLConnection.getRequestMethod()
  - usingProxy
```
public boolean usingProxy()
```
    Whether we use a proxy
    
    Specified by:
    
    usingProxy in interface HttpConnection
    
    Returns:
    
    a boolean indicating if the connection is using a proxy.
    
    See Also:
    
    HttpURLConnection.usingProxy()
  - connect
```
public void connect()
             throws java.io.IOException
```
    Connect
    
    Specified by:
    
    connect in interface HttpConnection
    
    Throws:
    
    java.io.IOException
    
    See Also:
    
    URLConnection.connect()
  - setHostnameVerifier
```
public void setHostnameVerifier(javax.net.ssl.HostnameVerifier hostnameverifier)
```
    Set the HostnameVerifier used during https communication
    
    Specified by:
    
    setHostnameVerifier in interface HttpConnection
    
    Parameters:
    
    hostnameverifier - a HostnameVerifier object.
  - configure
```
public void configure(javax.net.ssl.KeyManager[] km,
                      javax.net.ssl.TrustManager[] tm,
                      java.security.SecureRandom random)
               throws java.security.KeyManagementException
```
    Configure the connection so that it can be used for https communication.
    
    Specified by:
    
    configure in interface HttpConnection
    
    Parameters:
    
    km - the keymanager managing the key material used to authenticate the local SSLSocket to its peer
    
    tm - the trustmanager responsible for managing the trust material that is used when making trust decisions, and for deciding whether credentials presented by a peer should be accepted.
    
    random - the source of randomness for this generator or null. See SSLContext.init(KeyManager[], TrustManager[], SecureRandom)
    
    Throws:
    
    java.security.KeyManagementException

Class HttpClientConnection

Field Summary

Fields inherited from interface org.eclipse.jgit.transport.http.HttpConnection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

client

url

req

resp

method

entity

isUsingProxy

proxy

timeout

readTimeout

followRedirects

hostnameverifier

ctx

Constructor Detail

HttpClientConnection

HttpClientConnection

HttpClientConnection

Method Detail

getClient

getSSLContext

setBuffer

getResponseCode

getURL

getResponseMessage

execute

getHeaderFields

setRequestProperty

setRequestMethod

setUseCaches

setConnectTimeout

setReadTimeout

getContentType

getInputStream

getHeaderField

getContentLength

setInstanceFollowRedirects

setDoOutput

setFixedLengthStreamingMode

getOutputStream

setChunkedStreamingMode

getRequestMethod

usingProxy

connect

setHostnameVerifier

configure