org.eclipse.jgit.transport.http

Interface HttpConnection

All Known Implementing Classes:

JDKHttpConnection

public interface HttpConnection

The interface of connections used during HTTP communication. This interface is that subset of the interface exposed by HttpURLConnection which is used by JGit

Since:

3.3

Field Summary

Fields

Modifier and Type	Field and Description
static int	HTTP_11_MOVED_TEMP HTTP 1.1 additional MOVED_TEMP status code; value = 307.
static int	HTTP_FORBIDDEN
static int	HTTP_MOVED_PERM
static int	HTTP_MOVED_TEMP
static int	HTTP_NOT_FOUND
static int	HTTP_OK
static int	HTTP_SEE_OTHER
static int	HTTP_UNAUTHORIZED

Method Summary

Modifier and Type	Method and 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

Field Detail

HTTP_OK

static final int HTTP_OK

See Also:

HttpURLConnection.HTTP_OK, Constant Field Values

HTTP_MOVED_PERM

static final int HTTP_MOVED_PERM

Since:

4.7

See Also:

HttpURLConnection.HTTP_MOVED_PERM, Constant Field Values

HTTP_MOVED_TEMP

static final int HTTP_MOVED_TEMP

Since:

4.9

See Also:

HttpURLConnection.HTTP_MOVED_TEMP, Constant Field Values

HTTP_SEE_OTHER

static final int HTTP_SEE_OTHER

Since:

4.9

See Also:

HttpURLConnection.HTTP_SEE_OTHER, Constant Field Values

HTTP_11_MOVED_TEMP

static final int HTTP_11_MOVED_TEMP

HTTP 1.1 additional MOVED_TEMP status code; value = 307.

Since:

4.9

See Also:

HTTP_MOVED_TEMP, Constant Field Values

HTTP_NOT_FOUND

static final int HTTP_NOT_FOUND

See Also:

HttpURLConnection.HTTP_NOT_FOUND, Constant Field Values

HTTP_UNAUTHORIZED

static final int HTTP_UNAUTHORIZED

See Also:

HttpURLConnection.HTTP_UNAUTHORIZED, Constant Field Values

HTTP_FORBIDDEN

static final int HTTP_FORBIDDEN

See Also:

HttpURLConnection.HTTP_FORBIDDEN, Constant Field Values

Method Detail

getResponseCode

int getResponseCode()
             throws IOException

Get response code

Returns:

the HTTP Status-Code, or -1

Throws:

IOException

See Also:

HttpURLConnection.getResponseCode()

getURL

URL getURL()

Get URL

Returns:

the URL.

See Also:

URLConnection.getURL()

getResponseMessage

String getResponseMessage()
                   throws IOException

Get response message

Returns:

the HTTP response message, or null

Throws:

IOException

See Also:

HttpURLConnection.getResponseMessage()

getHeaderFields

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

Get map of header fields

Returns:

a Map of header fields

See Also:

URLConnection.getHeaderFields()

setRequestProperty

void setRequestProperty(String key,
                        String value)

Set request property

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

void setRequestMethod(String method)
               throws ProtocolException

Set request method

Parameters:

method - the HTTP method

Throws:

ProtocolException - if the method cannot be reset or if the requested method isn't valid for HTTP.

ProtocolException - if any.

See Also:

HttpURLConnection.setRequestMethod(String)

setUseCaches

void setUseCaches(boolean usecaches)

Set if to use caches

Parameters:

usecaches - a boolean indicating whether or not to allow caching

See Also:

URLConnection.setUseCaches(boolean)

setConnectTimeout

void setConnectTimeout(int timeout)

Set connect timeout

Parameters:

timeout - an int that specifies the connect timeout value in milliseconds

See Also:

URLConnection.setConnectTimeout(int)

setReadTimeout

void setReadTimeout(int timeout)

Set read timeout

Parameters:

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

See Also:

URLConnection.setReadTimeout(int)

getContentType

String getContentType()

Get content type

Returns:

the content type of the resource that the URL references, or null if not known.

See Also:

URLConnection.getContentType()

getInputStream

InputStream getInputStream()
                    throws IOException

Get input stream

Returns:

an input stream that reads from this open connection.

Throws:

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

IOException - if any.

See Also:

URLConnection.getInputStream()

getHeaderField

String getHeaderField(@NonNull
                      String name)

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

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

List<String> getHeaderFields(@NonNull
                             String name)

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.

Parameters:

name - the name of a header field.

Returns:

the list of values of the named header field

Since:

5.2

getContentLength

int getContentLength()

Get content length

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

void setInstanceFollowRedirects(boolean followRedirects)

Set whether or not to follow HTTP redirects.

Parameters:

followRedirects - a boolean indicating whether or not to follow HTTP redirects.

See Also:

HttpURLConnection.setInstanceFollowRedirects(boolean)

setDoOutput

void setDoOutput(boolean dooutput)

Set if to do output

Parameters:

dooutput - the new value.

See Also:

URLConnection.setDoOutput(boolean)

setFixedLengthStreamingMode

void setFixedLengthStreamingMode(int contentLength)

Set fixed length streaming mode

Parameters:

contentLength - The number of bytes which will be written to the OutputStream.

See Also:

HttpURLConnection.setFixedLengthStreamingMode(int)

getOutputStream

OutputStream getOutputStream()
                      throws IOException

Get output stream

Returns:

an output stream that writes to this connection.

Throws:

IOException

See Also:

URLConnection.getOutputStream()

setChunkedStreamingMode

void setChunkedStreamingMode(int chunklen)

Set chunked streaming mode

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

String getRequestMethod()

Get request method

Returns:

the HTTP request method

See Also:

HttpURLConnection.getRequestMethod()

usingProxy

boolean usingProxy()

Whether we use a proxy

Returns:

a boolean indicating if the connection is using a proxy.

See Also:

HttpURLConnection.usingProxy()

connect

void connect()
      throws IOException

Connect

Throws:

IOException

See Also:

URLConnection.connect()

configure

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

Configure the connection so that it can be used for https communication.

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

KeyManagementException

setHostnameVerifier

void setHostnameVerifier(HostnameVerifier hostnameverifier)
                  throws NoSuchAlgorithmException,
                         KeyManagementException

Set the HostnameVerifier used during https communication

Parameters:

hostnameverifier - a HostnameVerifier object.

Throws:

NoSuchAlgorithmException

KeyManagementException