Module org.eclipse.jgit

Package org.eclipse.jgit.transport.http

Class JDKHttpConnection

java.lang.Object

org.eclipse.jgit.transport.http.JDKHttpConnection

All Implemented Interfaces:

HttpConnection

public class JDKHttpConnection
extends Object
implements HttpConnection

A HttpConnection which simply delegates every call to a HttpURLConnection. This is the default implementation used by JGit

Since:

3.3

Field Summary

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

HTTP_11_MOVED_PERM, HTTP_11_MOVED_TEMP, HTTP_FORBIDDEN, HTTP_MOVED_PERM, HTTP_MOVED_TEMP, HTTP_NOT_AUTHORITATIVE, HTTP_NOT_FOUND, HTTP_OK, HTTP_SEE_OTHER, HTTP_UNAUTHORIZED

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JDKHttpConnection(URL url)	Constructor for JDKHttpConnection.
protected	JDKHttpConnection(URL url, Proxy proxy)	Constructor for JDKHttpConnection.

Method Summary

Modifier and Type	Method	Description
void	configure(KeyManager[] km, TrustManager[] tm, SecureRandom random)	Configure the connection so that it can be used for https communication.
void	connect()	Connect
int	getContentLength()	Get content length
String	getContentType()	Get content type
String	getHeaderField(String name)	Get header field.
Map<String,List<String>>	getHeaderFields()	Get map of header fields
List<String>	getHeaderFields(String name)	Get all values of given header field.
InputStream	getInputStream()	Get input stream
OutputStream	getOutputStream()	Get output stream
String	getRequestMethod()	Get request method
int	getResponseCode()	Get response code
String	getResponseMessage()	Get response message
URL	getURL()	Get URL
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(HostnameVerifier hostnameverifier)	Set the HostnameVerifier used during https communication
void	setInstanceFollowRedirects(boolean followRedirects)	Set whether or not to follow HTTP redirects.
void	setReadTimeout(int timeout)	Set read timeout
void	setRequestMethod(String method)	Set request method
void	setRequestProperty(String key, 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

Constructor Details

JDKHttpConnection

protected JDKHttpConnection(URL url)
                     throws MalformedURLException,
IOException

Constructor for JDKHttpConnection.

Parameters:

url - a URL object.

Throws:

MalformedURLException - if URL is malformed

IOException - if an IO error occurred

JDKHttpConnection

protected JDKHttpConnection(URL url,
 Proxy proxy)
                     throws MalformedURLException,
IOException

Constructor for JDKHttpConnection.

Parameters:

url - a URL object.

proxy - a Proxy object.

Throws:

MalformedURLException - if URL is malformed

IOException - if an IO error occurred

Method Details

getResponseCode

public int getResponseCode()
                    throws IOException

Description copied from interface: HttpConnection

Get response code

Specified by:

getResponseCode in interface HttpConnection

Returns:

the HTTP Status-Code, or -1

Throws:

IOException - if an IO error occurred

See Also:

• HttpURLConnection.getResponseCode()

getURL

public URL getURL()

Description copied from interface: HttpConnection

Get URL

Specified by:

getURL in interface HttpConnection

Returns:

the URL.

See Also:

• URLConnection.getURL()

getResponseMessage

public String getResponseMessage()
                          throws IOException

Description copied from interface: HttpConnection

Get response message

Specified by:

getResponseMessage in interface HttpConnection

Returns:

the HTTP response message, or null

Throws:

IOException - if an IO error occurred

See Also:

• HttpURLConnection.getResponseMessage()

getHeaderFields

public Map<String,List<String>> getHeaderFields()

Description copied from interface: HttpConnection

Get map of header fields

Specified by:

getHeaderFields in interface HttpConnection

Returns:

a Map of header fields

See Also:

• URLConnection.getHeaderFields()

setRequestProperty

public void setRequestProperty(String key,
 String value)

Description copied from interface: HttpConnection

Set request property

Specified by:

setRequestProperty in interface HttpConnection

Parameters:

key - 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(String method)
                      throws ProtocolException

Description copied from interface: HttpConnection

Set request method

Specified by:

setRequestMethod in interface HttpConnection

Parameters:

method - the HTTP method

Throws:

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)

Description copied from interface: HttpConnection

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)

Description copied from interface: HttpConnection

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 timeout)

Description copied from interface: HttpConnection

Set read timeout

Specified by:

setReadTimeout in interface HttpConnection

Parameters:

timeout - an int that specifies the timeout value to be used in milliseconds

See Also:

• URLConnection.setReadTimeout(int)

getContentType

public String getContentType()

Description copied from interface: HttpConnection

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 InputStream getInputStream()
                           throws IOException

Description copied from interface: HttpConnection

Get input stream

Specified by:

getInputStream in interface HttpConnection

Returns:

an input stream that reads from this open connection.

Throws:

IOException - if an I/O error occurs while creating the input stream.

See Also:

• URLConnection.getInputStream()

getHeaderField

public String getHeaderField(@NonNull
 String name)

Description copied from interface: HttpConnection

Get header field. According to RFC 2616 header field names are case insensitive. Header fields defined as a comma separated list can have multiple header fields with the same field name. This method only returns one of these header fields. If you want the union of all values of all multiple header fields with the same field name then use HttpConnection.getHeaderFields(String)

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)

getHeaderFields

public List<String> getHeaderFields(@NonNull
 String name)

Description copied from interface: HttpConnection

Get all values of given header field. According to RFC 2616 header field names are case insensitive. Header fields defined as a comma separated list can have multiple header fields with the same field name. This method does not validate if the given header field is defined as a comma separated list.

Specified by:

getHeaderFields in interface HttpConnection

Parameters:

name - the name of a header field.

Returns:

the list of values of the named header field

getContentLength

public int getContentLength()

Description copied from interface: HttpConnection

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)

Description copied from interface: HttpConnection

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)

Description copied from interface: HttpConnection

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)

Description copied from interface: HttpConnection

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 OutputStream getOutputStream()
                             throws IOException

Description copied from interface: HttpConnection

Get output stream

Specified by:

getOutputStream in interface HttpConnection

Returns:

an output stream that writes to this connection.

Throws:

IOException - if an IO error occurred

See Also:

• URLConnection.getOutputStream()

setChunkedStreamingMode

public void setChunkedStreamingMode(int chunklen)

Description copied from interface: HttpConnection

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 String getRequestMethod()

Description copied from interface: HttpConnection

Get request method

Specified by:

getRequestMethod in interface HttpConnection

Returns:

the HTTP request method

See Also:

• HttpURLConnection.getRequestMethod()

usingProxy

public boolean usingProxy()

Description copied from interface: HttpConnection

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 IOException

Description copied from interface: HttpConnection

Connect

Specified by:

connect in interface HttpConnection

Throws:

IOException - if an IO error occurred

See Also:

• URLConnection.connect()

setHostnameVerifier

public void setHostnameVerifier(HostnameVerifier hostnameverifier)

Description copied from interface: HttpConnection

Set the HostnameVerifier used during https communication

Specified by:

setHostnameVerifier in interface HttpConnection

Parameters:

hostnameverifier - a HostnameVerifier object.

configure

public void configure(KeyManager[] km,
 TrustManager[] tm,
 SecureRandom random)
               throws NoSuchAlgorithmException,
KeyManagementException

Description copied from interface: HttpConnection

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:

NoSuchAlgorithmException - if algorithm isn't available

KeyManagementException - if key management failed