diff --git a/javadoc/allclasses-frame.html b/javadoc/allclasses-frame.html new file mode 100644 index 000000000..6cdc97722 --- /dev/null +++ b/javadoc/allclasses-frame.html @@ -0,0 +1,40 @@ + + + + + + + +All Classes (mockwebserver 20120819 API) + + + + + + + + + + + +All Classes +
+ + + + + +
Dispatcher +
+MockResponse +
+MockWebServer +
+RecordedRequest +
+SocketPolicy +
+
+ + + diff --git a/javadoc/allclasses-noframe.html b/javadoc/allclasses-noframe.html new file mode 100644 index 000000000..2f15ae42a --- /dev/null +++ b/javadoc/allclasses-noframe.html @@ -0,0 +1,40 @@ + + + + + + + +All Classes (mockwebserver 20120819 API) + + + + + + + + + + + +All Classes +
+ + + + + +
Dispatcher +
+MockResponse +
+MockWebServer +
+RecordedRequest +
+SocketPolicy +
+
+ + + diff --git a/javadoc/com/google/mockwebserver/Dispatcher.html b/javadoc/com/google/mockwebserver/Dispatcher.html new file mode 100644 index 000000000..0c1660037 --- /dev/null +++ b/javadoc/com/google/mockwebserver/Dispatcher.html @@ -0,0 +1,284 @@ + + + + + + + +Dispatcher (mockwebserver 20120819 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.google.mockwebserver +
+Class Dispatcher

+
+java.lang.Object
+  extended by com.google.mockwebserver.Dispatcher
+
+
+
+
public abstract class Dispatcher
extends Object
+ + +

+Handler for mock server requests. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
Dispatcher() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+abstract  MockResponsedispatch(RecordedRequest request) + +
+          Returns a response to satisfy request.
+ SocketPolicypeekSocketPolicy() + +
+          Returns the socket policy of the next request.
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Dispatcher

+
+public Dispatcher()
+
+
+ + + + + + + + +
+Method Detail
+ +

+dispatch

+
+public abstract MockResponse dispatch(RecordedRequest request)
+                               throws InterruptedException
+
+
Returns a response to satisfy request. This method may block (for + instance, to wait on a CountdownLatch). +

+

+ +
Throws: +
InterruptedException
+
+
+
+ +

+peekSocketPolicy

+
+public SocketPolicy peekSocketPolicy()
+
+
Returns the socket policy of the next request. Default implementation + returns SocketPolicy.KEEP_OPEN. Mischievous implementations can + return other values to test HTTP edge cases. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011-2012. All Rights Reserved. + + diff --git a/javadoc/com/google/mockwebserver/MockResponse.html b/javadoc/com/google/mockwebserver/MockResponse.html new file mode 100644 index 000000000..5b4afa736 --- /dev/null +++ b/javadoc/com/google/mockwebserver/MockResponse.html @@ -0,0 +1,721 @@ + + + + + + + +MockResponse (mockwebserver 20120819 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.google.mockwebserver +
+Class MockResponse

+
+java.lang.Object
+  extended by com.google.mockwebserver.MockResponse
+
+
+
All Implemented Interfaces:
Cloneable
+
+
+
+
public final class MockResponse
extends Object
implements Cloneable
+ + +

+A scripted response to be replayed by the mock web server. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
MockResponse() + +
+          Creates a new mock response with an empty body.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ MockResponseaddHeader(String header) + +
+          Adds header as an HTTP header.
+ MockResponseaddHeader(String name, + Object value) + +
+          Adds a new header with the name and value.
+ MockResponseclearHeaders() + +
+          Removes all HTTP headers including any "Content-Length" and + "Transfer-encoding" headers that were added by default.
+ MockResponseclone() + +
+           
+ byte[]getBody() + +
+          Returns the raw HTTP payload.
+ intgetBytesPerSecond() + +
+           
+ List<String>getHeaders() + +
+          Returns the HTTP headers, such as "Content-Length: 0".
+ SocketPolicygetSocketPolicy() + +
+           
+ StringgetStatus() + +
+          Returns the HTTP response line, such as "HTTP/1.1 200 OK".
+ MockResponseremoveHeader(String name) + +
+          Removes all headers named name.
+ MockResponsesetBody(byte[] body) + +
+           
+ MockResponsesetBody(String body) + +
+          Sets the response body to the UTF-8 encoded bytes of body.
+ MockResponsesetBytesPerSecond(int bytesPerSecond) + +
+          Set simulated network speed, in bytes per second.
+ MockResponsesetChunkedBody(byte[] body, + int maxChunkSize) + +
+          Sets the response body to body, chunked every maxChunkSize bytes.
+ MockResponsesetChunkedBody(String body, + int maxChunkSize) + +
+          Sets the response body to the UTF-8 encoded bytes of body, + chunked every maxChunkSize bytes.
+ MockResponsesetHeader(String name, + Object value) + +
+          Removes all headers named name, then adds a new header with the + name and value.
+ MockResponsesetResponseCode(int code) + +
+           
+ MockResponsesetSocketPolicy(SocketPolicy socketPolicy) + +
+           
+ MockResponsesetStatus(String status) + +
+           
+ StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+MockResponse

+
+public MockResponse()
+
+
Creates a new mock response with an empty body. +

+

+ + + + + + + + +
+Method Detail
+ +

+clone

+
+public MockResponse clone()
+
+
+
Overrides:
clone in class Object
+
+
+
+
+
+
+ +

+getStatus

+
+public String getStatus()
+
+
Returns the HTTP response line, such as "HTTP/1.1 200 OK". +

+

+
+
+
+
+
+
+
+ +

+setResponseCode

+
+public MockResponse setResponseCode(int code)
+
+
+
+
+
+
+
+
+
+ +

+setStatus

+
+public MockResponse setStatus(String status)
+
+
+
+
+
+
+
+
+
+ +

+getHeaders

+
+public List<String> getHeaders()
+
+
Returns the HTTP headers, such as "Content-Length: 0". +

+

+
+
+
+
+
+
+
+ +

+clearHeaders

+
+public MockResponse clearHeaders()
+
+
Removes all HTTP headers including any "Content-Length" and + "Transfer-encoding" headers that were added by default. +

+

+
+
+
+
+
+
+
+ +

+addHeader

+
+public MockResponse addHeader(String header)
+
+
Adds header as an HTTP header. For well-formed HTTP header should contain a name followed by a colon and a value. +

+

+
+
+
+
+
+
+
+ +

+addHeader

+
+public MockResponse addHeader(String name,
+                              Object value)
+
+
Adds a new header with the name and value. This may be used to add + multiple headers with the same name. +

+

+
+
+
+
+
+
+
+ +

+setHeader

+
+public MockResponse setHeader(String name,
+                              Object value)
+
+
Removes all headers named name, then adds a new header with the + name and value. +

+

+
+
+
+
+
+
+
+ +

+removeHeader

+
+public MockResponse removeHeader(String name)
+
+
Removes all headers named name. +

+

+
+
+
+
+
+
+
+ +

+getBody

+
+public byte[] getBody()
+
+
Returns the raw HTTP payload. +

+

+
+
+
+
+
+
+
+ +

+setBody

+
+public MockResponse setBody(byte[] body)
+
+
+
+
+
+
+
+
+
+ +

+setBody

+
+public MockResponse setBody(String body)
+
+
Sets the response body to the UTF-8 encoded bytes of body. +

+

+
+
+
+
+
+
+
+ +

+setChunkedBody

+
+public MockResponse setChunkedBody(byte[] body,
+                                   int maxChunkSize)
+
+
Sets the response body to body, chunked every maxChunkSize bytes. +

+

+
+
+
+
+
+
+
+ +

+setChunkedBody

+
+public MockResponse setChunkedBody(String body,
+                                   int maxChunkSize)
+
+
Sets the response body to the UTF-8 encoded bytes of body, + chunked every maxChunkSize bytes. +

+

+
+
+
+
+
+
+
+ +

+getSocketPolicy

+
+public SocketPolicy getSocketPolicy()
+
+
+
+
+
+
+
+
+
+ +

+setSocketPolicy

+
+public MockResponse setSocketPolicy(SocketPolicy socketPolicy)
+
+
+
+
+
+
+
+
+
+ +

+getBytesPerSecond

+
+public int getBytesPerSecond()
+
+
+
+
+
+
+
+
+
+ +

+setBytesPerSecond

+
+public MockResponse setBytesPerSecond(int bytesPerSecond)
+
+
Set simulated network speed, in bytes per second. This applies to the + response body only; response headers are not throttled. +

+

+
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011-2012. All Rights Reserved. + + diff --git a/javadoc/com/google/mockwebserver/MockWebServer.html b/javadoc/com/google/mockwebserver/MockWebServer.html new file mode 100644 index 000000000..e312508f7 --- /dev/null +++ b/javadoc/com/google/mockwebserver/MockWebServer.html @@ -0,0 +1,557 @@ + + + + + + + +MockWebServer (mockwebserver 20120819 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.google.mockwebserver +
+Class MockWebServer

+
+java.lang.Object
+  extended by com.google.mockwebserver.MockWebServer
+
+
+
+
public final class MockWebServer
extends Object
+ + +

+A scriptable web server. Callers supply canned responses and the server + replays them upon request in sequence. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
MockWebServer() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidenqueue(MockResponse response) + +
+          Scripts response to be returned to a request made in sequence.
+ StringgetCookieDomain() + +
+          Returns a cookie domain for this server.
+ StringgetHostName() + +
+           
+ intgetPort() + +
+           
+ intgetRequestCount() + +
+          Returns the number of HTTP requests received thus far by this server.
+ URLgetUrl(String path) + +
+          Returns a URL for connecting to this server.
+ voidplay() + +
+          Equivalent to play(0).
+ voidplay(int port) + +
+          Starts the server, serves all enqueued requests, and shuts the server + down.
+ voidsetBodyLimit(int maxBodyLength) + +
+          Sets the number of bytes of the POST body to keep in memory to the given + limit.
+ voidsetDispatcher(Dispatcher dispatcher) + +
+          Sets the dispatcher used to match incoming requests to mock responses.
+ voidshutdown() + +
+           
+ RecordedRequesttakeRequest() + +
+          Awaits the next HTTP request, removes it, and returns it.
+ ProxytoProxyAddress() + +
+           
+ voiduseHttps(SSLSocketFactory sslSocketFactory, + boolean tunnelProxy) + +
+          Serve requests with HTTPS rather than otherwise.
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+MockWebServer

+
+public MockWebServer()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getPort

+
+public int getPort()
+
+
+
+
+
+
+ +

+getHostName

+
+public String getHostName()
+
+
+
+
+
+
+ +

+toProxyAddress

+
+public Proxy toProxyAddress()
+
+
+
+
+
+
+ +

+getUrl

+
+public URL getUrl(String path)
+
+
Returns a URL for connecting to this server. +

+

+
Parameters:
path - the request path, such as "/".
+
+
+
+ +

+getCookieDomain

+
+public String getCookieDomain()
+
+
Returns a cookie domain for this server. This returns the server's + non-loopback host name if it is known. Otherwise this returns ".local" + for this server's loopback name. +

+

+
+
+
+
+ +

+setBodyLimit

+
+public void setBodyLimit(int maxBodyLength)
+
+
Sets the number of bytes of the POST body to keep in memory to the given + limit. +

+

+
+
+
+
+ +

+useHttps

+
+public void useHttps(SSLSocketFactory sslSocketFactory,
+                     boolean tunnelProxy)
+
+
Serve requests with HTTPS rather than otherwise. +

+

+
Parameters:
tunnelProxy - whether to expect the HTTP CONNECT method before + negotiating TLS.
+
+
+
+ +

+takeRequest

+
+public RecordedRequest takeRequest()
+                            throws InterruptedException
+
+
Awaits the next HTTP request, removes it, and returns it. Callers should + use this to verify the request sent was as intended. +

+

+ +
Throws: +
InterruptedException
+
+
+
+ +

+getRequestCount

+
+public int getRequestCount()
+
+
Returns the number of HTTP requests received thus far by this server. + This may exceed the number of HTTP connections when connection reuse is + in practice. +

+

+
+
+
+
+ +

+enqueue

+
+public void enqueue(MockResponse response)
+
+
Scripts response to be returned to a request made in sequence. + The first request is served by the first enqueued response; the second + request by the second enqueued response; and so on. +

+

+ +
Throws: +
ClassCastException - if the default dispatcher has been replaced + with setDispatcher(Dispatcher).
+
+
+
+ +

+play

+
+public void play()
+          throws IOException
+
+
Equivalent to play(0). +

+

+ +
Throws: +
IOException
+
+
+
+ +

+play

+
+public void play(int port)
+          throws IOException
+
+
Starts the server, serves all enqueued requests, and shuts the server + down. +

+

+
Parameters:
port - the port to listen to, or 0 for any available port. + Automated tests should always use port 0 to avoid flakiness when a + specific port is unavailable. +
Throws: +
IOException
+
+
+
+ +

+shutdown

+
+public void shutdown()
+              throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+setDispatcher

+
+public void setDispatcher(Dispatcher dispatcher)
+
+
Sets the dispatcher used to match incoming requests to mock responses. + The default dispatcher simply serves a fixed sequence of responses from + a queue; custom dispatchers can vary the + response based on timing or the content of the request. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011-2012. All Rights Reserved. + + diff --git a/javadoc/com/google/mockwebserver/RecordedRequest.html b/javadoc/com/google/mockwebserver/RecordedRequest.html new file mode 100644 index 000000000..62073f2c2 --- /dev/null +++ b/javadoc/com/google/mockwebserver/RecordedRequest.html @@ -0,0 +1,481 @@ + + + + + + + +RecordedRequest (mockwebserver 20120819 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.google.mockwebserver +
+Class RecordedRequest

+
+java.lang.Object
+  extended by com.google.mockwebserver.RecordedRequest
+
+
+
+
public final class RecordedRequest
extends Object
+ + +

+An HTTP request that came into the mock web server. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ byte[]getBody() + +
+          Returns the body of this POST request.
+ intgetBodySize() + +
+          Returns the total size of the body of this POST request (before + truncation).
+ List<Integer>getChunkSizes() + +
+          Returns the sizes of the chunks of this request's body, or an empty list + if the request's body was empty or unchunked.
+ StringgetHeader(String name) + +
+          Returns the first header named name, or null if no such header + exists.
+ List<String>getHeaders() + +
+          Returns all headers.
+ List<String>getHeaders(String name) + +
+          Returns the headers named name.
+ StringgetMethod() + +
+           
+ StringgetPath() + +
+           
+ StringgetRequestLine() + +
+           
+ intgetSequenceNumber() + +
+          Returns the index of this request on its HTTP connection.
+ StringgetSslProtocol() + +
+          Returns the connection's SSL protocol like TLSv1, SSLv3, + NONE or null if the connection doesn't use SSL.
+ StringgetUtf8Body() + +
+          Returns the body of this POST request decoded as a UTF-8 string.
+ StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Method Detail
+ +

+getRequestLine

+
+public String getRequestLine()
+
+
+
+
+
+
+ +

+getMethod

+
+public String getMethod()
+
+
+
+
+
+
+ +

+getPath

+
+public String getPath()
+
+
+
+
+
+
+ +

+getHeaders

+
+public List<String> getHeaders()
+
+
Returns all headers. +

+

+
+
+
+
+ +

+getHeader

+
+public String getHeader(String name)
+
+
Returns the first header named name, or null if no such header + exists. +

+

+
+
+
+
+ +

+getHeaders

+
+public List<String> getHeaders(String name)
+
+
Returns the headers named name. +

+

+
+
+
+
+ +

+getChunkSizes

+
+public List<Integer> getChunkSizes()
+
+
Returns the sizes of the chunks of this request's body, or an empty list + if the request's body was empty or unchunked. +

+

+
+
+
+
+ +

+getBodySize

+
+public int getBodySize()
+
+
Returns the total size of the body of this POST request (before + truncation). +

+

+
+
+
+
+ +

+getBody

+
+public byte[] getBody()
+
+
Returns the body of this POST request. This may be truncated. +

+

+
+
+
+
+ +

+getUtf8Body

+
+public String getUtf8Body()
+
+
Returns the body of this POST request decoded as a UTF-8 string. +

+

+
+
+
+
+ +

+getSequenceNumber

+
+public int getSequenceNumber()
+
+
Returns the index of this request on its HTTP connection. Since a single + HTTP connection may serve multiple requests, each request is assigned its + own sequence number. +

+

+
+
+
+
+ +

+getSslProtocol

+
+public String getSslProtocol()
+
+
Returns the connection's SSL protocol like TLSv1, SSLv3, + NONE or null if the connection doesn't use SSL. +

+

+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011-2012. All Rights Reserved. + + diff --git a/javadoc/com/google/mockwebserver/SocketPolicy.html b/javadoc/com/google/mockwebserver/SocketPolicy.html new file mode 100644 index 000000000..9ab677347 --- /dev/null +++ b/javadoc/com/google/mockwebserver/SocketPolicy.html @@ -0,0 +1,432 @@ + + + + + + + +SocketPolicy (mockwebserver 20120819 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ +

+ +com.google.mockwebserver +
+Enum SocketPolicy

+
+java.lang.Object
+  extended by java.lang.Enum<SocketPolicy>
+      extended by com.google.mockwebserver.SocketPolicy
+
+
+
All Implemented Interfaces:
Serializable, Comparable<SocketPolicy>
+
+
+
+
public enum SocketPolicy
extends Enum<SocketPolicy>
+ + +

+What should be done with the incoming socket. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
DISCONNECT_AT_END + +
+          Close the socket after the response.
DISCONNECT_AT_START + +
+          Request immediate close of connection without even reading the + request.
FAIL_HANDSHAKE + +
+          Don't trust the client during the SSL handshake.
KEEP_OPEN + +
+          Keep the socket open after the response.
SHUTDOWN_INPUT_AT_END + +
+          Shutdown the socket input after sending the response.
SHUTDOWN_OUTPUT_AT_END + +
+          Shutdown the socket output after sending the response.
UPGRADE_TO_SSL_AT_END + +
+          Wrap the socket with SSL at the completion of this request/response + pair.
+  + + + + + + + + + + + + + + + +
+Method Summary
+static SocketPolicyvalueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static SocketPolicy[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  + + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+KEEP_OPEN

+
+public static final SocketPolicy KEEP_OPEN
+
+
Keep the socket open after the response. This is the default HTTP/1.1 + behavior. +

+

+
+
+
+ +

+DISCONNECT_AT_END

+
+public static final SocketPolicy DISCONNECT_AT_END
+
+
Close the socket after the response. This is the default HTTP/1.0 + behavior. +

+

+
+
+
+ +

+UPGRADE_TO_SSL_AT_END

+
+public static final SocketPolicy UPGRADE_TO_SSL_AT_END
+
+
Wrap the socket with SSL at the completion of this request/response + pair. Used for CONNECT messages to tunnel SSL over an HTTP proxy. +

+

+
+
+
+ +

+DISCONNECT_AT_START

+
+public static final SocketPolicy DISCONNECT_AT_START
+
+
Request immediate close of connection without even reading the + request. + +

Use to simulate the real life case of losing connection + because of bugger SSL server close connection when it seems + something like a compression method or TLS extension it doesn't + understand, instead of simply ignoring it like it should. +

+

+
+
+
+ +

+FAIL_HANDSHAKE

+
+public static final SocketPolicy FAIL_HANDSHAKE
+
+
Don't trust the client during the SSL handshake. +

+

+
+
+
+ +

+SHUTDOWN_INPUT_AT_END

+
+public static final SocketPolicy SHUTDOWN_INPUT_AT_END
+
+
Shutdown the socket input after sending the response. For testing bad + behavior. +

+

+
+
+
+ +

+SHUTDOWN_OUTPUT_AT_END

+
+public static final SocketPolicy SHUTDOWN_OUTPUT_AT_END
+
+
Shutdown the socket output after sending the response. For testing bad + behavior. +

+

+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static SocketPolicy[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (SocketPolicy c : SocketPolicy.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static SocketPolicy valueOf(String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
IllegalArgumentException - if this enum type has no constant +with the specified name +
NullPointerException - if the argument is null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+Copyright © 2011-2012. All Rights Reserved. + + diff --git a/javadoc/com/google/mockwebserver/class-use/Dispatcher.html b/javadoc/com/google/mockwebserver/class-use/Dispatcher.html new file mode 100644 index 000000000..282a84e2d --- /dev/null +++ b/javadoc/com/google/mockwebserver/class-use/Dispatcher.html @@ -0,0 +1,166 @@ + + + + + + + +Uses of Class com.google.mockwebserver.Dispatcher (mockwebserver 20120819 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.google.mockwebserver.Dispatcher

+
+ + + + + +
+Uses of Dispatcher in com.google.mockwebserver
+  +

+ + + + + + + + + +
Methods in com.google.mockwebserver with parameters of type Dispatcher
+ voidMockWebServer.setDispatcher(Dispatcher dispatcher) + +
+          Sets the dispatcher used to match incoming requests to mock responses.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011-2012. All Rights Reserved. + + diff --git a/javadoc/com/google/mockwebserver/class-use/MockResponse.html b/javadoc/com/google/mockwebserver/class-use/MockResponse.html new file mode 100644 index 000000000..563b32aff --- /dev/null +++ b/javadoc/com/google/mockwebserver/class-use/MockResponse.html @@ -0,0 +1,301 @@ + + + + + + + +Uses of Class com.google.mockwebserver.MockResponse (mockwebserver 20120819 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.google.mockwebserver.MockResponse

+
+ + + + + +
+Uses of MockResponse in com.google.mockwebserver
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in com.google.mockwebserver that return MockResponse
+ MockResponseMockResponse.addHeader(String header) + +
+          Adds header as an HTTP header.
+ MockResponseMockResponse.addHeader(String name, + Object value) + +
+          Adds a new header with the name and value.
+ MockResponseMockResponse.clearHeaders() + +
+          Removes all HTTP headers including any "Content-Length" and + "Transfer-encoding" headers that were added by default.
+ MockResponseMockResponse.clone() + +
+           
+abstract  MockResponseDispatcher.dispatch(RecordedRequest request) + +
+          Returns a response to satisfy request.
+ MockResponseMockResponse.removeHeader(String name) + +
+          Removes all headers named name.
+ MockResponseMockResponse.setBody(byte[] body) + +
+           
+ MockResponseMockResponse.setBody(String body) + +
+          Sets the response body to the UTF-8 encoded bytes of body.
+ MockResponseMockResponse.setBytesPerSecond(int bytesPerSecond) + +
+          Set simulated network speed, in bytes per second.
+ MockResponseMockResponse.setChunkedBody(byte[] body, + int maxChunkSize) + +
+          Sets the response body to body, chunked every maxChunkSize bytes.
+ MockResponseMockResponse.setChunkedBody(String body, + int maxChunkSize) + +
+          Sets the response body to the UTF-8 encoded bytes of body, + chunked every maxChunkSize bytes.
+ MockResponseMockResponse.setHeader(String name, + Object value) + +
+          Removes all headers named name, then adds a new header with the + name and value.
+ MockResponseMockResponse.setResponseCode(int code) + +
+           
+ MockResponseMockResponse.setSocketPolicy(SocketPolicy socketPolicy) + +
+           
+ MockResponseMockResponse.setStatus(String status) + +
+           
+  +

+ + + + + + + + + +
Methods in com.google.mockwebserver with parameters of type MockResponse
+ voidMockWebServer.enqueue(MockResponse response) + +
+          Scripts response to be returned to a request made in sequence.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011-2012. All Rights Reserved. + + diff --git a/javadoc/com/google/mockwebserver/class-use/MockWebServer.html b/javadoc/com/google/mockwebserver/class-use/MockWebServer.html new file mode 100644 index 000000000..0797fcc22 --- /dev/null +++ b/javadoc/com/google/mockwebserver/class-use/MockWebServer.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class com.google.mockwebserver.MockWebServer (mockwebserver 20120819 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.google.mockwebserver.MockWebServer

+
+No usage of com.google.mockwebserver.MockWebServer +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011-2012. All Rights Reserved. + + diff --git a/javadoc/com/google/mockwebserver/class-use/RecordedRequest.html b/javadoc/com/google/mockwebserver/class-use/RecordedRequest.html new file mode 100644 index 000000000..e2f264c17 --- /dev/null +++ b/javadoc/com/google/mockwebserver/class-use/RecordedRequest.html @@ -0,0 +1,182 @@ + + + + + + + +Uses of Class com.google.mockwebserver.RecordedRequest (mockwebserver 20120819 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.google.mockwebserver.RecordedRequest

+
+ + + + + +
+Uses of RecordedRequest in com.google.mockwebserver
+  +

+ + + + + + + + + +
Methods in com.google.mockwebserver that return RecordedRequest
+ RecordedRequestMockWebServer.takeRequest() + +
+          Awaits the next HTTP request, removes it, and returns it.
+  +

+ + + + + + + + + +
Methods in com.google.mockwebserver with parameters of type RecordedRequest
+abstract  MockResponseDispatcher.dispatch(RecordedRequest request) + +
+          Returns a response to satisfy request.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011-2012. All Rights Reserved. + + diff --git a/javadoc/com/google/mockwebserver/class-use/SocketPolicy.html b/javadoc/com/google/mockwebserver/class-use/SocketPolicy.html new file mode 100644 index 000000000..4f9dd4887 --- /dev/null +++ b/javadoc/com/google/mockwebserver/class-use/SocketPolicy.html @@ -0,0 +1,207 @@ + + + + + + + +Uses of Class com.google.mockwebserver.SocketPolicy (mockwebserver 20120819 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.google.mockwebserver.SocketPolicy

+
+ + + + + +
+Uses of SocketPolicy in com.google.mockwebserver
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in com.google.mockwebserver that return SocketPolicy
+ SocketPolicyMockResponse.getSocketPolicy() + +
+           
+ SocketPolicyDispatcher.peekSocketPolicy() + +
+          Returns the socket policy of the next request.
+static SocketPolicySocketPolicy.valueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static SocketPolicy[]SocketPolicy.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+ + + + + + + + + +
Methods in com.google.mockwebserver with parameters of type SocketPolicy
+ MockResponseMockResponse.setSocketPolicy(SocketPolicy socketPolicy) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011-2012. All Rights Reserved. + + diff --git a/javadoc/com/google/mockwebserver/package-frame.html b/javadoc/com/google/mockwebserver/package-frame.html new file mode 100644 index 000000000..0f3f49e76 --- /dev/null +++ b/javadoc/com/google/mockwebserver/package-frame.html @@ -0,0 +1,50 @@ + + + + + + + +com.google.mockwebserver (mockwebserver 20120819 API) + + + + + + + + + + + +com.google.mockwebserver + + + + +
+Classes  + +
+Dispatcher +
+MockResponse +
+MockWebServer +
+RecordedRequest
+ + + + + + +
+Enums  + +
+SocketPolicy
+ + + + diff --git a/javadoc/com/google/mockwebserver/package-summary.html b/javadoc/com/google/mockwebserver/package-summary.html new file mode 100644 index 000000000..9f05d8662 --- /dev/null +++ b/javadoc/com/google/mockwebserver/package-summary.html @@ -0,0 +1,182 @@ + + + + + + + +com.google.mockwebserver (mockwebserver 20120819 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.google.mockwebserver +

+ + + + + + + + + + + + + + + + + + + + + +
+Class Summary
DispatcherHandler for mock server requests.
MockResponseA scripted response to be replayed by the mock web server.
MockWebServerA scriptable web server.
RecordedRequestAn HTTP request that came into the mock web server.
+  + +

+ + + + + + + + + +
+Enum Summary
SocketPolicyWhat should be done with the incoming socket.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011-2012. All Rights Reserved. + + diff --git a/javadoc/com/google/mockwebserver/package-tree.html b/javadoc/com/google/mockwebserver/package-tree.html new file mode 100644 index 000000000..f1ec41452 --- /dev/null +++ b/javadoc/com/google/mockwebserver/package-tree.html @@ -0,0 +1,160 @@ + + + + + + + +com.google.mockwebserver Class Hierarchy (mockwebserver 20120819 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.google.mockwebserver +

+
+

+Class Hierarchy +

+ +

+Enum Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011-2012. All Rights Reserved. + + diff --git a/javadoc/com/google/mockwebserver/package-use.html b/javadoc/com/google/mockwebserver/package-use.html new file mode 100644 index 000000000..ddc54e2e1 --- /dev/null +++ b/javadoc/com/google/mockwebserver/package-use.html @@ -0,0 +1,174 @@ + + + + + + + +Uses of Package com.google.mockwebserver (mockwebserver 20120819 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.google.mockwebserver

+
+ + + + + + + + + + + + + + + + + +
+Classes in com.google.mockwebserver used by com.google.mockwebserver
Dispatcher + +
+          Handler for mock server requests.
MockResponse + +
+          A scripted response to be replayed by the mock web server.
RecordedRequest + +
+          An HTTP request that came into the mock web server.
SocketPolicy + +
+          What should be done with the incoming socket.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011-2012. All Rights Reserved. + + diff --git a/javadoc/constant-values.html b/javadoc/constant-values.html new file mode 100644 index 000000000..9dfb18e76 --- /dev/null +++ b/javadoc/constant-values.html @@ -0,0 +1,145 @@ + + + + + + + +Constant Field Values (mockwebserver 20120819 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Constant Field Values

+
+
+Contents + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011-2012. All Rights Reserved. + + diff --git a/javadoc/deprecated-list.html b/javadoc/deprecated-list.html new file mode 100644 index 000000000..d54eb0bfa --- /dev/null +++ b/javadoc/deprecated-list.html @@ -0,0 +1,145 @@ + + + + + + + +Deprecated List (mockwebserver 20120819 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree   Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Deprecated API

+
+
+Contents + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree   Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011-2012. All Rights Reserved. + + diff --git a/javadoc/help-doc.html b/javadoc/help-doc.html new file mode 100644 index 000000000..bb807f4ee --- /dev/null +++ b/javadoc/help-doc.html @@ -0,0 +1,216 @@ + + + + + + + +API Help (mockwebserver 20120819 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated  Index   Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+How This API Document Is Organized

+
+This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

+Package

+
+ +

+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

+
+

+Class/Interface

+
+ +

+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+ +

+Annotation Type

+
+ +

+Each annotation type has its own separate page with the following sections:

+
+ +

+Enum

+
+ +

+Each enum has its own separate page with the following sections:

+
+

+Use

+
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+

+Tree (Class Hierarchy)

+
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object. +
+

+Deprecated API

+
+The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+

+Index

+
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+

+Prev/Next

+These links take you to the next or previous class, interface, package, or related page.

+Frames/No Frames

+These links show and hide the HTML frames. All pages are available with or without frames. +

+

+Serialized Form

+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

+

+Constant Field Values

+The Constant Field Values page lists the static final fields and their values. +

+ + +This help file applies to API documentation generated using the standard doclet. + +
+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated  Index   Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011-2012. All Rights Reserved. + + diff --git a/javadoc/index-all.html b/javadoc/index-all.html new file mode 100644 index 000000000..2ead9bbfd --- /dev/null +++ b/javadoc/index-all.html @@ -0,0 +1,368 @@ + + + + + + + +Index (mockwebserver 20120819 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +A C D E G M P R S T U V
+

+A

+
+
addHeader(String) - +Method in class com.google.mockwebserver.MockResponse +
Adds header as an HTTP header. +
addHeader(String, Object) - +Method in class com.google.mockwebserver.MockResponse +
Adds a new header with the name and value. +
+
+

+C

+
+
clearHeaders() - +Method in class com.google.mockwebserver.MockResponse +
Removes all HTTP headers including any "Content-Length" and + "Transfer-encoding" headers that were added by default. +
clone() - +Method in class com.google.mockwebserver.MockResponse +
  +
com.google.mockwebserver - package com.google.mockwebserver
 
+
+

+D

+
+
dispatch(RecordedRequest) - +Method in class com.google.mockwebserver.Dispatcher +
Returns a response to satisfy request. +
Dispatcher - Class in com.google.mockwebserver
Handler for mock server requests.
Dispatcher() - +Constructor for class com.google.mockwebserver.Dispatcher +
  +
+
+

+E

+
+
enqueue(MockResponse) - +Method in class com.google.mockwebserver.MockWebServer +
Scripts response to be returned to a request made in sequence. +
+
+

+G

+
+
getBody() - +Method in class com.google.mockwebserver.MockResponse +
Returns the raw HTTP payload. +
getBody() - +Method in class com.google.mockwebserver.RecordedRequest +
Returns the body of this POST request. +
getBodySize() - +Method in class com.google.mockwebserver.RecordedRequest +
Returns the total size of the body of this POST request (before + truncation). +
getBytesPerSecond() - +Method in class com.google.mockwebserver.MockResponse +
  +
getChunkSizes() - +Method in class com.google.mockwebserver.RecordedRequest +
Returns the sizes of the chunks of this request's body, or an empty list + if the request's body was empty or unchunked. +
getCookieDomain() - +Method in class com.google.mockwebserver.MockWebServer +
Returns a cookie domain for this server. +
getHeader(String) - +Method in class com.google.mockwebserver.RecordedRequest +
Returns the first header named name, or null if no such header + exists. +
getHeaders() - +Method in class com.google.mockwebserver.MockResponse +
Returns the HTTP headers, such as "Content-Length: 0". +
getHeaders() - +Method in class com.google.mockwebserver.RecordedRequest +
Returns all headers. +
getHeaders(String) - +Method in class com.google.mockwebserver.RecordedRequest +
Returns the headers named name. +
getHostName() - +Method in class com.google.mockwebserver.MockWebServer +
  +
getMethod() - +Method in class com.google.mockwebserver.RecordedRequest +
  +
getPath() - +Method in class com.google.mockwebserver.RecordedRequest +
  +
getPort() - +Method in class com.google.mockwebserver.MockWebServer +
  +
getRequestCount() - +Method in class com.google.mockwebserver.MockWebServer +
Returns the number of HTTP requests received thus far by this server. +
getRequestLine() - +Method in class com.google.mockwebserver.RecordedRequest +
  +
getSequenceNumber() - +Method in class com.google.mockwebserver.RecordedRequest +
Returns the index of this request on its HTTP connection. +
getSocketPolicy() - +Method in class com.google.mockwebserver.MockResponse +
  +
getSslProtocol() - +Method in class com.google.mockwebserver.RecordedRequest +
Returns the connection's SSL protocol like TLSv1, SSLv3, + NONE or null if the connection doesn't use SSL. +
getStatus() - +Method in class com.google.mockwebserver.MockResponse +
Returns the HTTP response line, such as "HTTP/1.1 200 OK". +
getUrl(String) - +Method in class com.google.mockwebserver.MockWebServer +
Returns a URL for connecting to this server. +
getUtf8Body() - +Method in class com.google.mockwebserver.RecordedRequest +
Returns the body of this POST request decoded as a UTF-8 string. +
+
+

+M

+
+
MockResponse - Class in com.google.mockwebserver
A scripted response to be replayed by the mock web server.
MockResponse() - +Constructor for class com.google.mockwebserver.MockResponse +
Creates a new mock response with an empty body. +
MockWebServer - Class in com.google.mockwebserver
A scriptable web server.
MockWebServer() - +Constructor for class com.google.mockwebserver.MockWebServer +
  +
+
+

+P

+
+
peekSocketPolicy() - +Method in class com.google.mockwebserver.Dispatcher +
Returns the socket policy of the next request. +
play() - +Method in class com.google.mockwebserver.MockWebServer +
Equivalent to play(0). +
play(int) - +Method in class com.google.mockwebserver.MockWebServer +
Starts the server, serves all enqueued requests, and shuts the server + down. +
+
+

+R

+
+
RecordedRequest - Class in com.google.mockwebserver
An HTTP request that came into the mock web server.
removeHeader(String) - +Method in class com.google.mockwebserver.MockResponse +
Removes all headers named name. +
+
+

+S

+
+
setBody(byte[]) - +Method in class com.google.mockwebserver.MockResponse +
  +
setBody(String) - +Method in class com.google.mockwebserver.MockResponse +
Sets the response body to the UTF-8 encoded bytes of body. +
setBodyLimit(int) - +Method in class com.google.mockwebserver.MockWebServer +
Sets the number of bytes of the POST body to keep in memory to the given + limit. +
setBytesPerSecond(int) - +Method in class com.google.mockwebserver.MockResponse +
Set simulated network speed, in bytes per second. +
setChunkedBody(byte[], int) - +Method in class com.google.mockwebserver.MockResponse +
Sets the response body to body, chunked every maxChunkSize bytes. +
setChunkedBody(String, int) - +Method in class com.google.mockwebserver.MockResponse +
Sets the response body to the UTF-8 encoded bytes of body, + chunked every maxChunkSize bytes. +
setDispatcher(Dispatcher) - +Method in class com.google.mockwebserver.MockWebServer +
Sets the dispatcher used to match incoming requests to mock responses. +
setHeader(String, Object) - +Method in class com.google.mockwebserver.MockResponse +
Removes all headers named name, then adds a new header with the + name and value. +
setResponseCode(int) - +Method in class com.google.mockwebserver.MockResponse +
  +
setSocketPolicy(SocketPolicy) - +Method in class com.google.mockwebserver.MockResponse +
  +
setStatus(String) - +Method in class com.google.mockwebserver.MockResponse +
  +
shutdown() - +Method in class com.google.mockwebserver.MockWebServer +
  +
SocketPolicy - Enum in com.google.mockwebserver
What should be done with the incoming socket.
+
+

+T

+
+
takeRequest() - +Method in class com.google.mockwebserver.MockWebServer +
Awaits the next HTTP request, removes it, and returns it. +
toProxyAddress() - +Method in class com.google.mockwebserver.MockWebServer +
  +
toString() - +Method in class com.google.mockwebserver.MockResponse +
  +
toString() - +Method in class com.google.mockwebserver.RecordedRequest +
  +
+
+

+U

+
+
useHttps(SSLSocketFactory, boolean) - +Method in class com.google.mockwebserver.MockWebServer +
Serve requests with HTTPS rather than otherwise. +
+
+

+V

+
+
valueOf(String) - +Static method in enum com.google.mockwebserver.SocketPolicy +
Returns the enum constant of this type with the specified name. +
values() - +Static method in enum com.google.mockwebserver.SocketPolicy +
Returns an array containing the constants of this enum type, in +the order they are declared. +
+
+A C D E G M P R S T U V + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011-2012. All Rights Reserved. + + diff --git a/javadoc/index.html b/javadoc/index.html new file mode 100644 index 000000000..62d9e9ea4 --- /dev/null +++ b/javadoc/index.html @@ -0,0 +1,37 @@ + + + + + + + +mockwebserver 20120819 API + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="com/google/mockwebserver/package-summary.html">Non-frame version.</A> + + + diff --git a/javadoc/overview-tree.html b/javadoc/overview-tree.html new file mode 100644 index 000000000..29d9491f3 --- /dev/null +++ b/javadoc/overview-tree.html @@ -0,0 +1,162 @@ + + + + + + + +Class Hierarchy (mockwebserver 20120819 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For All Packages

+
+
+
Package Hierarchies:
com.google.mockwebserver
+
+

+Class Hierarchy +

+ +

+Enum Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011-2012. All Rights Reserved. + + diff --git a/javadoc/package-list b/javadoc/package-list new file mode 100644 index 000000000..89508e5d3 --- /dev/null +++ b/javadoc/package-list @@ -0,0 +1 @@ +com.google.mockwebserver diff --git a/javadoc/resources/inherit.gif b/javadoc/resources/inherit.gif new file mode 100644 index 000000000..c814867a1 Binary files /dev/null and b/javadoc/resources/inherit.gif differ diff --git a/javadoc/stylesheet.css b/javadoc/stylesheet.css new file mode 100644 index 000000000..6ea9e5161 --- /dev/null +++ b/javadoc/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +