com.google.mockwebserver.Dispatcher
-| Dispatcher
- -MockResponse - -MockWebServer - -QueueDispatcher - -RecordedRequest - -SocketPolicy - - |
-
| Dispatcher
- -MockResponse - -MockWebServer - -QueueDispatcher - -RecordedRequest - -SocketPolicy - - |
-
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-java.lang.Object --
public abstract class Dispatcher
-Handler for mock server requests. -
- -
-
| -Constructor Summary | -|
|---|---|
Dispatcher()
-
-- |
-|
| -Method Summary | -|
|---|---|
-abstract MockResponse |
-dispatch(RecordedRequest request)
-
-- Returns a response to satisfy request. |
-
- SocketPolicy |
-peekSocketPolicy()
-
-- 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 | -
|---|
-public Dispatcher()-
| -Method Detail | -
|---|
-public abstract MockResponse dispatch(RecordedRequest request) - throws InterruptedException-
request. This method can block (for instance, to wait on a CountdownLatch).
--
InterruptedException-public SocketPolicy peekSocketPolicy()-
SocketPolicy.KEEP_OPEN.
- Mischievous implementations can return other values to test HTTP edge cases.
--
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-java.lang.Object --
-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 | -|
|---|---|
- MockResponse |
-addHeader(String header)
-
-- Adds header as an HTTP header. |
-
- MockResponse |
-addHeader(String name,
- Object value)
-
-- Adds a new header with the name and value. |
-
- MockResponse |
-clearHeaders()
-
-- Removes all HTTP headers including any "Content-Length" and - "Transfer-encoding" headers that were added by default. |
-
- MockResponse |
-clone()
-
-- |
-
- byte[] |
-getBody()
-
-- Returns the raw HTTP payload. |
-
- int |
-getBytesPerSecond()
-
-- |
-
- List<String> |
-getHeaders()
-
-- Returns the HTTP headers, such as "Content-Length: 0". |
-
- SocketPolicy |
-getSocketPolicy()
-
-- |
-
- String |
-getStatus()
-
-- Returns the HTTP response line, such as "HTTP/1.1 200 OK". |
-
- MockResponse |
-removeHeader(String name)
-
-- Removes all headers named name. |
-
- MockResponse |
-setBody(byte[] body)
-
-- |
-
- MockResponse |
-setBody(String body)
-
-- Sets the response body to the UTF-8 encoded bytes of body. |
-
- MockResponse |
-setBytesPerSecond(int bytesPerSecond)
-
-- Set simulated network speed, in bytes per second. |
-
- MockResponse |
-setChunkedBody(byte[] body,
- int maxChunkSize)
-
-- Sets the response body to body, chunked every maxChunkSize bytes. |
-
- MockResponse |
-setChunkedBody(String body,
- int maxChunkSize)
-
-- Sets the response body to the UTF-8 encoded bytes of body,
- chunked every maxChunkSize bytes. |
-
- MockResponse |
-setHeader(String name,
- Object value)
-
-- Removes all headers named name, then adds a new header with the
- name and value. |
-
- MockResponse |
-setResponseCode(int code)
-
-- |
-
- MockResponse |
-setSocketPolicy(SocketPolicy socketPolicy)
-
-- |
-
- MockResponse |
-setStatus(String status)
-
-- |
-
- String |
-toString()
-
-- |
-
| Methods inherited from class java.lang.Object | -
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
-
| -Constructor Detail | -
|---|
-public MockResponse()-
-
| -Method Detail | -
|---|
-public MockResponse clone()- -
-public String getStatus()-
-
-public MockResponse setResponseCode(int code)-
-public MockResponse setStatus(String status)-
-public List<String> getHeaders()-
-
-public MockResponse clearHeaders()-
-
-public MockResponse addHeader(String header)-
header as an HTTP header. For well-formed HTTP header should contain a name followed by a colon and a value.
--
-public MockResponse addHeader(String name, - Object value)-
-
-public MockResponse setHeader(String name, - Object value)-
name, then adds a new header with the
- name and value.
--
-public MockResponse removeHeader(String name)-
name.
--
-public byte[] getBody()-
-
-public MockResponse setBody(byte[] body)-
-public MockResponse setBody(String body)-
body.
--
-public MockResponse setChunkedBody(byte[] body, - int maxChunkSize)-
body, chunked every maxChunkSize bytes.
--
-public MockResponse setChunkedBody(String body, - int maxChunkSize)-
body,
- chunked every maxChunkSize bytes.
--
-public SocketPolicy getSocketPolicy()-
-public MockResponse setSocketPolicy(SocketPolicy socketPolicy)-
-public int getBytesPerSecond()-
-public MockResponse setBytesPerSecond(int bytesPerSecond)-
-
-public String toString()- - -
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-java.lang.Object --
public final class MockWebServer
-A scriptable web server. Callers supply canned responses and the server - replays them upon request in sequence. -
- -
-
| -Constructor Summary | -|
|---|---|
MockWebServer()
-
-- |
-|
| -Method Summary | -|
|---|---|
- void |
-enqueue(MockResponse response)
-
-- |
-
- String |
-getCookieDomain()
-
-- Returns a cookie domain for this server. |
-
- String |
-getHostName()
-
-- |
-
- int |
-getPort()
-
-- |
-
- int |
-getRequestCount()
-
-- Returns the number of HTTP requests received thus far by this server. |
-
- URL |
-getUrl(String path)
-
-- Returns a URL for connecting to this server. |
-
- void |
-play()
-
-- Equivalent to play(0). |
-
- void |
-play(int port)
-
-- Starts the server, serves all enqueued requests, and shuts the server - down. |
-
- void |
-setBodyLimit(int maxBodyLength)
-
-- Sets the number of bytes of the POST body to keep in memory to the given - limit. |
-
- void |
-setDispatcher(Dispatcher dispatcher)
-
-- |
-
- void |
-shutdown()
-
-- |
-
- RecordedRequest |
-takeRequest()
-
-- Awaits the next HTTP request, removes it, and returns it. |
-
- Proxy |
-toProxyAddress()
-
-- |
-
- void |
-useHttps(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 | -
|---|
-public MockWebServer()-
| -Method Detail | -
|---|
-public int getPort()-
-public String getHostName()-
-public Proxy toProxyAddress()-
-public URL getUrl(String path)-
-
path - the request path, such as "/".-public String getCookieDomain()-
-
-public void setBodyLimit(int maxBodyLength)-
-
-public void useHttps(SSLSocketFactory sslSocketFactory, - boolean tunnelProxy)-
-
tunnelProxy - whether to expect the HTTP CONNECT method before
- negotiating TLS.-public RecordedRequest takeRequest() - throws InterruptedException-
-
InterruptedException-public int getRequestCount()-
-
-public void enqueue(MockResponse response)-
-public void play() - throws IOException-
play(0).
--
IOException-public void play(int port) - throws IOException-
-
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.
-IOException-public void shutdown() - throws IOException-
IOException-public void setDispatcher(Dispatcher dispatcher)-
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-java.lang.Object --
public class QueueDispatcher
-Default dispatcher that processes a script of responses. Populate the script by calling
- enqueueResponse(MockResponse).
-
- -
-
| -Constructor Summary | -|
|---|---|
QueueDispatcher()
-
-- |
-|
| -Method Summary | -|
|---|---|
- MockResponse |
-dispatch(RecordedRequest request)
-
-- Returns a response to satisfy request. |
-
- void |
-enqueueResponse(MockResponse response)
-
-- |
-
- SocketPolicy |
-peekSocketPolicy()
-
-- 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 | -
|---|
-public QueueDispatcher()-
| -Method Detail | -
|---|
-public MockResponse dispatch(RecordedRequest request) - throws InterruptedException-
Dispatcherrequest. This method can block (for instance, to wait on a CountdownLatch).
--
dispatch in class DispatcherInterruptedException-public SocketPolicy peekSocketPolicy()-
DispatcherSocketPolicy.KEEP_OPEN.
- Mischievous implementations can return other values to test HTTP edge cases.
--
peekSocketPolicy in class Dispatcher-public void enqueueResponse(MockResponse response)-
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-java.lang.Object --
public final class RecordedRequest
-An HTTP request that came into the mock web server. -
- -
-
| -Method Summary | -|
|---|---|
- byte[] |
-getBody()
-
-- Returns the body of this POST request. |
-
- int |
-getBodySize()
-
-- 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. |
-
- String |
-getHeader(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. |
-
- String |
-getMethod()
-
-- |
-
- String |
-getPath()
-
-- |
-
- String |
-getRequestLine()
-
-- |
-
- int |
-getSequenceNumber()
-
-- Returns the index of this request on its HTTP connection. |
-
- String |
-getSslProtocol()
-
-- Returns the connection's SSL protocol like TLSv1, SSLv3,
- NONE or null if the connection doesn't use SSL. |
-
- String |
-getUtf8Body()
-
-- Returns the body of this POST request decoded as a UTF-8 string. |
-
- String |
-toString()
-
-- |
-
| Methods inherited from class java.lang.Object | -
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
-
| -Method Detail | -
|---|
-public String getRequestLine()-
-public String getMethod()-
-public String getPath()-
-public List<String> getHeaders()-
-
-public String getHeader(String name)-
name, or null if no such header
- exists.
--
-public List<String> getHeaders(String name)-
name.
--
-public List<Integer> getChunkSizes()-
-
-public int getBodySize()-
-
-public byte[] getBody()-
-
-public String getUtf8Body()-
-
-public int getSequenceNumber()-
-
-public String getSslProtocol()-
TLSv1, SSLv3,
- NONE or null if the connection doesn't use SSL.
--
-public String toString()- - -
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | --DETAIL: ENUM CONSTANTS | FIELD | METHOD | -||||||||
-java.lang.Object --
public 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 SocketPolicy |
-valueOf(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 | -
|---|
-public static final SocketPolicy KEEP_OPEN-
-
-public static final SocketPolicy DISCONNECT_AT_END-
-
-public static final SocketPolicy UPGRADE_TO_SSL_AT_END-
-
-public static final SocketPolicy DISCONNECT_AT_START-
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. -
-
-public static final SocketPolicy FAIL_HANDSHAKE-
-
-public static final SocketPolicy SHUTDOWN_INPUT_AT_END-
-
-public static final SocketPolicy SHUTDOWN_OUTPUT_AT_END-
-
| -Method Detail | -
|---|
-public static SocketPolicy[] values()-
-for (SocketPolicy c : SocketPolicy.values()) - System.out.println(c); --
-
-public static SocketPolicy valueOf(String name)-
-
name - the name of the enum constant to be returned.
-IllegalArgumentException - if this enum type has no constant
-with the specified name
-NullPointerException - if the argument is null
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | --DETAIL: ENUM CONSTANTS | FIELD | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
| -Uses of Dispatcher in com.google.mockwebserver | -
|---|
- -
| Subclasses of Dispatcher in com.google.mockwebserver | -|
|---|---|
- class |
-QueueDispatcher
-
-- Default dispatcher that processes a script of responses. |
-
- -
| Methods in com.google.mockwebserver with parameters of type Dispatcher | -|
|---|---|
- void |
-MockWebServer.setDispatcher(Dispatcher dispatcher)
-
-- |
-
-
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
| -Uses of MockResponse in com.google.mockwebserver | -
|---|
- -
| Methods in com.google.mockwebserver that return MockResponse | -|
|---|---|
- MockResponse |
-MockResponse.addHeader(String header)
-
-- Adds header as an HTTP header. |
-
- MockResponse |
-MockResponse.addHeader(String name,
- Object value)
-
-- Adds a new header with the name and value. |
-
- MockResponse |
-MockResponse.clearHeaders()
-
-- Removes all HTTP headers including any "Content-Length" and - "Transfer-encoding" headers that were added by default. |
-
- MockResponse |
-MockResponse.clone()
-
-- |
-
- MockResponse |
-QueueDispatcher.dispatch(RecordedRequest request)
-
-- |
-
-abstract MockResponse |
-Dispatcher.dispatch(RecordedRequest request)
-
-- Returns a response to satisfy request. |
-
- MockResponse |
-MockResponse.removeHeader(String name)
-
-- Removes all headers named name. |
-
- MockResponse |
-MockResponse.setBody(byte[] body)
-
-- |
-
- MockResponse |
-MockResponse.setBody(String body)
-
-- Sets the response body to the UTF-8 encoded bytes of body. |
-
- MockResponse |
-MockResponse.setBytesPerSecond(int bytesPerSecond)
-
-- Set simulated network speed, in bytes per second. |
-
- MockResponse |
-MockResponse.setChunkedBody(byte[] body,
- int maxChunkSize)
-
-- Sets the response body to body, chunked every maxChunkSize bytes. |
-
- MockResponse |
-MockResponse.setChunkedBody(String body,
- int maxChunkSize)
-
-- Sets the response body to the UTF-8 encoded bytes of body,
- chunked every maxChunkSize bytes. |
-
- MockResponse |
-MockResponse.setHeader(String name,
- Object value)
-
-- Removes all headers named name, then adds a new header with the
- name and value. |
-
- MockResponse |
-MockResponse.setResponseCode(int code)
-
-- |
-
- MockResponse |
-MockResponse.setSocketPolicy(SocketPolicy socketPolicy)
-
-- |
-
- MockResponse |
-MockResponse.setStatus(String status)
-
-- |
-
- -
| Methods in com.google.mockwebserver with parameters of type MockResponse | -|
|---|---|
- void |
-MockWebServer.enqueue(MockResponse response)
-
-- |
-
- void |
-QueueDispatcher.enqueueResponse(MockResponse response)
-
-- |
-
-
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
| -Uses of RecordedRequest in com.google.mockwebserver | -
|---|
- -
| Methods in com.google.mockwebserver that return RecordedRequest | -|
|---|---|
- RecordedRequest |
-MockWebServer.takeRequest()
-
-- Awaits the next HTTP request, removes it, and returns it. |
-
- -
| Methods in com.google.mockwebserver with parameters of type RecordedRequest | -|
|---|---|
- MockResponse |
-QueueDispatcher.dispatch(RecordedRequest request)
-
-- |
-
-abstract MockResponse |
-Dispatcher.dispatch(RecordedRequest request)
-
-- Returns a response to satisfy request. |
-
-
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
| -Uses of SocketPolicy in com.google.mockwebserver | -
|---|
- -
| Methods in com.google.mockwebserver that return SocketPolicy | -|
|---|---|
- SocketPolicy |
-MockResponse.getSocketPolicy()
-
-- |
-
- SocketPolicy |
-QueueDispatcher.peekSocketPolicy()
-
-- |
-
- SocketPolicy |
-Dispatcher.peekSocketPolicy()
-
-- Returns the socket policy of the next request. |
-
-static SocketPolicy |
-SocketPolicy.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 | -|
|---|---|
- MockResponse |
-MockResponse.setSocketPolicy(SocketPolicy socketPolicy)
-
-- |
-
-
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
|
-Classes
-
- -Dispatcher - -MockResponse - -MockWebServer - -QueueDispatcher - -RecordedRequest |
-
|
-Enums
-
- -SocketPolicy |
-
-
-
|
-- - | -||||||||
| - PREV PACKAGE - NEXT PACKAGE | -- FRAMES - NO FRAMES - - - - - | -||||||||
| -Class Summary | -|
|---|---|
| Dispatcher | -Handler for mock server requests. | -
| MockResponse | -A scripted response to be replayed by the mock web server. | -
| MockWebServer | -A scriptable web server. | -
| QueueDispatcher | -Default dispatcher that processes a script of responses. | -
| RecordedRequest | -An HTTP request that came into the mock web server. | -
- -
| -Enum Summary | -|
|---|---|
| SocketPolicy | -What should be done with the incoming socket. | -
-
-
-
|
-- - | -||||||||
| - PREV PACKAGE - NEXT PACKAGE | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
| -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. |
-|
-
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
- ---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:
-
-- Interfaces (italic)
- Classes
- Enums
- Exceptions
- Errors
- Annotation Types
- -- --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.- Class inheritance diagram
- Direct Subclasses
- All Known Subinterfaces
- All Known Implementing Classes
- Class/interface declaration
- Class/interface description -
-
- Nested Class Summary
- Field Summary
- Constructor Summary
- Method Summary -
-
- Field Detail
- Constructor Detail
- Method Detail
- -- --Each annotation type has its own separate page with the following sections:
-
-- Annotation Type declaration
- Annotation Type description
- Required Element Summary
- Optional Element Summary
- Element Detail
- ---Each enum has its own separate page with the following sections:
-
-- Enum declaration
- Enum description
- Enum Constant Summary
- Enum Constant Detail
-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.-
-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 fromjava.lang.Object.-
-- When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
- When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
-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.-
-The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.-
-
-
-
-
-This help file applies to API documentation generated using the standard doclet.
-
-
-
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
header as an HTTP header.
-request.
-name, or null if no such header
- exists.
-name.
-TLSv1, SSLv3,
- NONE or null if the connection doesn't use SSL.
-play(0).
-name.
-body.
-body, chunked every maxChunkSize bytes.
-body,
- chunked every maxChunkSize bytes.
-name, then adds a new header with the
- name and value.
-
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||