Class MockHttpURLConnection

java.lang.Object

java.net.URLConnection

java.net.HttpURLConnection

com.google.api.client.testing.http.javanet.MockHttpURLConnection

@Beta
public class MockHttpURLConnection
extends HttpURLConnection

Beta
Mock for HttpURLConnection.

Implementation is not thread-safe.

Since:

1.11

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	doOutputCalled	Whether URLConnection.doOutput was called.
static final byte[]	ERROR_BUF	Deprecated. As of 1.20.
private InputStream	errorStream	The error stream.
private Map<String, List<String>>	headers
static final byte[]	INPUT_BUF	Deprecated. As of 1.20.
private InputStream	inputStream	The input stream.
private OutputStream	outputStream	Output stream or null to throw an UnknownServiceException when getOutputStream() is called.
private boolean	setFixedLengthStreamingModeIntCalled	Whether setFixedLengthStreamingMode(int) was called.
private boolean	setFixedLengthStreamingModeLongCalled	Whether setFixedLengthStreamingMode(long) was called.

Fields inherited from class HttpURLConnection

chunkLength, fixedContentLength, fixedContentLengthLong, HTTP_ACCEPTED, HTTP_BAD_GATEWAY, HTTP_BAD_METHOD, HTTP_BAD_REQUEST, HTTP_CLIENT_TIMEOUT, HTTP_CONFLICT, HTTP_CREATED, HTTP_ENTITY_TOO_LARGE, HTTP_FORBIDDEN, HTTP_GATEWAY_TIMEOUT, HTTP_GONE, HTTP_INTERNAL_ERROR, HTTP_LENGTH_REQUIRED, HTTP_MOVED_PERM, HTTP_MOVED_TEMP, HTTP_MULT_CHOICE, HTTP_NO_CONTENT, HTTP_NOT_ACCEPTABLE, HTTP_NOT_AUTHORITATIVE, HTTP_NOT_FOUND, HTTP_NOT_IMPLEMENTED, HTTP_NOT_MODIFIED, HTTP_OK, HTTP_PARTIAL, HTTP_PAYMENT_REQUIRED, HTTP_PRECON_FAILED, HTTP_PROXY_AUTH, HTTP_REQ_TOO_LONG, HTTP_RESET, HTTP_SEE_OTHER, HTTP_SERVER_ERROR, HTTP_UNAUTHORIZED, HTTP_UNAVAILABLE, HTTP_UNSUPPORTED_TYPE, HTTP_USE_PROXY, HTTP_VERSION, instanceFollowRedirects, method, responseCode, responseMessage

Fields inherited from class URLConnection

allowUserInteraction, connected, doInput, doOutput, ifModifiedSince, url, useCaches

Constructor Summary

Constructors

Constructor	Description
MockHttpURLConnection(URL u)

Method Summary

Modifier and Type	Method	Description
MockHttpURLConnection	addHeader(String name, String value)	Sets a custom response header.
void	connect()
void	disconnect()
final boolean	doOutputCalled()	Returns whether URLConnection.doOutput was called.
int	getChunkLength()
InputStream	getErrorStream()
String	getHeaderField(String name)
Map<String, List<String>>	getHeaderFields()
InputStream	getInputStream()
OutputStream	getOutputStream()
int	getResponseCode()
boolean	isSetFixedLengthStreamingModeIntCalled()
boolean	isSetFixedLengthStreamingModeLongCalled()
void	setDoOutput(boolean dooutput)
MockHttpURLConnection	setErrorStream(InputStream is)	Sets the error stream.
void	setFixedLengthStreamingMode(int contentLength)
void	setFixedLengthStreamingMode(long contentLength)
MockHttpURLConnection	setInputStream(InputStream is)	Sets the input stream.
MockHttpURLConnection	setOutputStream(OutputStream outputStream)	Sets the output stream or null to throw an UnknownServiceException when getOutputStream() is called.
MockHttpURLConnection	setResponseCode(int responseCode)	Sets the HTTP response status code.
boolean	usingProxy()

Methods inherited from class HttpURLConnection

getFollowRedirects, getHeaderField, getHeaderFieldDate, getHeaderFieldKey, getInstanceFollowRedirects, getPermission, getRequestMethod, getResponseMessage, setChunkedStreamingMode, setFollowRedirects, setInstanceFollowRedirects, setRequestMethod

Methods inherited from class URLConnection

addRequestProperty, getAllowUserInteraction, getConnectTimeout, getContent, getContent, getContentEncoding, getContentLength, getContentLengthLong, getContentType, getDate, getDefaultAllowUserInteraction, getDefaultRequestProperty, getDefaultUseCaches, getDoInput, getDoOutput, getExpiration, getFileNameMap, getHeaderFieldInt, getHeaderFieldLong, getIfModifiedSince, getLastModified, getReadTimeout, getRequestProperties, getRequestProperty, getURL, getUseCaches, guessContentTypeFromName, guessContentTypeFromStream, setAllowUserInteraction, setConnectTimeout, setContentHandlerFactory, setDefaultAllowUserInteraction, setDefaultRequestProperty, setDefaultUseCaches, setDoInput, setFileNameMap, setIfModifiedSince, setReadTimeout, setRequestProperty, setUseCaches, toString

Methods inherited from class Object

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

Field Details

doOutputCalled

private boolean doOutputCalled

Whether URLConnection.doOutput was called.

setFixedLengthStreamingModeIntCalled

private boolean setFixedLengthStreamingModeIntCalled

Whether setFixedLengthStreamingMode(int) was called.

setFixedLengthStreamingModeLongCalled

private boolean setFixedLengthStreamingModeLongCalled

Whether setFixedLengthStreamingMode(long) was called.

outputStream

private OutputStream outputStream

Output stream or null to throw an UnknownServiceException when getOutputStream() is called.

INPUT_BUF

@Deprecated
public static final byte[] INPUT_BUF

Deprecated.

As of 1.20. Use setInputStream(InputStream) instead.

The input byte array which represents the content when the status code is less then 400.

ERROR_BUF

@Deprecated
public static final byte[] ERROR_BUF

Deprecated.

As of 1.20. Use setErrorStream(InputStream) instead.

The error byte array which represents the content when the status code is greater or equal to 400.

inputStream

private InputStream inputStream

The input stream.

errorStream

private InputStream errorStream

The error stream.

headers

private Map<String, List<String>> headers

Constructor Details

MockHttpURLConnection

public MockHttpURLConnection(URL u)

Parameters:

u - the URL or null for none

Method Details

disconnect

public void disconnect()

Specified by:

disconnect in class HttpURLConnection

usingProxy

public boolean usingProxy()

Specified by:

usingProxy in class HttpURLConnection

connect

public void connect()
             throws IOException

Specified by:

connect in class URLConnection

Throws:

IOException

getResponseCode

public int getResponseCode()
                    throws IOException

Overrides:

getResponseCode in class HttpURLConnection

Throws:

IOException

setDoOutput

public void setDoOutput(boolean dooutput)

Overrides:

setDoOutput in class URLConnection

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Overrides:

getOutputStream in class URLConnection

Throws:

IOException

doOutputCalled

public final boolean doOutputCalled()

Returns whether URLConnection.doOutput was called.

setOutputStream

public MockHttpURLConnection setOutputStream(OutputStream outputStream)

Sets the output stream or null to throw an UnknownServiceException when getOutputStream() is called.

By default it is null.

setResponseCode

public MockHttpURLConnection setResponseCode(int responseCode)

Sets the HTTP response status code.

addHeader

public MockHttpURLConnection addHeader(String name,
 String value)

Sets a custom response header.

Since:

1.20

setInputStream

public MockHttpURLConnection setInputStream(InputStream is)

Sets the input stream.

To prevent incidental overwrite, only the first non-null assignment is honored.

Since:

1.20

setErrorStream

public MockHttpURLConnection setErrorStream(InputStream is)

Sets the error stream.

To prevent incidental overwrite, only the first non-null assignment is honored.

Since:

1.20

getInputStream

public InputStream getInputStream()
                           throws IOException

Overrides:

getInputStream in class URLConnection

Throws:

IOException

getErrorStream

public InputStream getErrorStream()

Overrides:

getErrorStream in class HttpURLConnection

getHeaderFields

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

Overrides:

getHeaderFields in class URLConnection

getHeaderField

public String getHeaderField(String name)

Overrides:

getHeaderField in class URLConnection

getChunkLength

public int getChunkLength()

setFixedLengthStreamingMode

public void setFixedLengthStreamingMode(int contentLength)

Overrides:

setFixedLengthStreamingMode in class HttpURLConnection

setFixedLengthStreamingMode

public void setFixedLengthStreamingMode(long contentLength)

Overrides:

setFixedLengthStreamingMode in class HttpURLConnection

isSetFixedLengthStreamingModeIntCalled

public boolean isSetFixedLengthStreamingModeIntCalled()

isSetFixedLengthStreamingModeLongCalled

public boolean isSetFixedLengthStreamingModeLongCalled()