|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.vertx.groovy.core.http.HttpClient
abstract class HttpClient
An HTTP client that maintains a pool of connections to a specific host, at a specific port. The client supports pipelining of requests.
As well as HTTP requests, the client can act as a factory for WebSocket websockets.
If an instance is instantiated from an event loop then the handlers of the instance will always be called on that same event loop. If an instance is instantiated from some other arbitrary Java thread then and event loop will be assigned to the instance and used when any of its handlers are called.
Instances cannot be used from worker verticles
Field Summary | |
---|---|
protected HttpClient |
jClient
|
Method Summary | |
---|---|
void
|
close()
Close the HTTP client. |
HttpClientRequest
|
connect(java.lang.String uri, groovy.lang.Closure responseHandler)
This method returns an HttpClientRequest instance which represents an HTTP CONNECT request with the specified uri. |
void
|
connectWebsocket(java.lang.String uri, groovy.lang.Closure handler)
Attempt to connect an HTML5 websocket to the specified URI |
void
|
connectWebsocket(java.lang.String uri, WebSocketVersion version, groovy.lang.Closure handler)
Attempt to connect an HTML5 websocket to the specified URI |
HttpClientRequest
|
delete(java.lang.String uri, groovy.lang.Closure responseHandler)
This method returns an HttpClientRequest instance which represents an HTTP DELETE request with the specified uri. |
void
|
exceptionHandler(groovy.lang.Closure handler)
Set an exception handler |
HttpClientRequest
|
get(java.lang.String uri, groovy.lang.Closure responseHandler)
This method returns an HttpClientRequest instance which represents an HTTP GET request with the specified uri. |
java.lang.Integer
|
getBossThreads()
@return The number of boss threads |
java.lang.Long
|
getConnectTimeout()
@return The connect timeout |
java.lang.String
|
getKeyStorePassword()
@return The keystore password |
java.lang.String
|
getKeyStorePath()
@return The path to the key store |
int
|
getMaxPoolSize()
Returns the maximum number of connections in the pool |
void
|
getNow(java.lang.String uri, groovy.lang.Closure responseHandler)
This is a quick version of the get(String, Closure) method where you do not want to do anything with the request before sending. |
void
|
getNow(java.lang.String uri, java.util.Map headers, groovy.lang.Closure responseHandler)
This method works in the same manner as getNow(String,Closure), except that it allows you specify a set of headers that will be sent with the request. |
java.lang.Integer
|
getReceiveBufferSize()
@return The TCP receive buffer size |
java.lang.Integer
|
getSendBufferSize()
@return The TCP send buffer size |
java.lang.Integer
|
getTrafficClass()
@return the value of TCP traffic class |
java.lang.String
|
getTrustStorePassword()
@return The trust store password |
java.lang.String
|
getTrustStorePath()
@return The trust store path |
HttpClientRequest
|
head(java.lang.String uri, groovy.lang.Closure responseHandler)
This method returns an HttpClientRequest instance which represents an HTTP HEAD request with the specified uri. |
java.lang.Boolean
|
isReuseAddress()
@return The value of TCP reuse address |
boolean
|
isSSL()
@return true if this client will make SSL connections |
java.lang.Boolean
|
isSoLinger()
@return the value of TCP so linger |
java.lang.Boolean
|
isTCPKeepAlive()
@return true if TCP keep alive is enabled |
java.lang.Boolean
|
isTCPNoDelay()
@return true if Nagle's algorithm is disabled. |
boolean
|
isTrustAll()
@return true if this client will trust all server certificates. |
HttpClientRequest
|
options(java.lang.String uri, groovy.lang.Closure responseHandler)
This method returns an HttpClientRequest instance which represents an HTTP OPTIONS request with the specified uri. |
HttpClientRequest
|
patch(java.lang.String uri, groovy.lang.Closure responseHandler)
This method returns an HttpClientRequest instance which represents an HTTP PATCH request with the specified uri. |
HttpClientRequest
|
post(java.lang.String uri, groovy.lang.Closure responseHandler)
This method returns an HttpClientRequest instance which represents an HTTP POST request with the specified uri. |
HttpClientRequest
|
put(java.lang.String uri, groovy.lang.Closure responseHandler)
This method returns an HttpClientRequest instance which represents an HTTP PUT request with the specified uri. |
HttpClientRequest
|
request(java.lang.String method, java.lang.String uri, groovy.lang.Closure responseHandler)
This method returns an HttpClientRequest instance which represents an HTTP request with the specified uri. |
HttpClient
|
setBossThreads(long threads)
Set the number of boss threads to use. |
HttpClient
|
setConnectTimeout(long timeout)
Set the connect timeout in milliseconds |
HttpClient
|
setHost(java.lang.String host)
Set the host that the client will attempt to connect to the server on to host. |
HttpClient
|
setKeepAlive(boolean keepAlive)
If keepAlive is true then, after the request has ended the connection will be returned to the pool where it can be used by another request. |
HttpClient
|
setKeyStorePassword(java.lang.String pwd)
Set the password for the SSL key store. |
HttpClient
|
setKeyStorePath(java.lang.String path)
Set the path to the SSL key store. |
HttpClient
|
setMaxPoolSize(int maxConnections)
Set the maximum pool size |
HttpClient
|
setPort(int port)
Set the port that the client will attempt to connect to the server on to port. |
HttpClient
|
setReceiveBufferSize(int size)
Set the TCP receive buffer size for connections created by this instance to size in bytes. |
HttpClient
|
setReuseAddress(boolean reuse)
Set the TCP reuseAddress setting for connections created by this instance to reuse. |
HttpClient
|
setSSL(boolean ssl)
If ssl is true, this signifies that any connections will be SSL connections. |
HttpClient
|
setSendBufferSize(int size)
Set the TCP send buffer size for connections created by this instance to size in bytes. |
HttpClient
|
setSoLinger(boolean linger)
Set the TCP soLinger setting for connections created by this instance to linger. |
HttpClient
|
setTCPKeepAlive(boolean keepAlive)
Set the TCP keepAlive setting for connections created by this instance to keepAlive. |
HttpClient
|
setTCPNoDelay(boolean tcpNoDelay)
If tcpNoDelay is set to true then Nagle's algorithm will turned off for the TCP connections created by this instance. |
HttpClient
|
setTrafficClass(int trafficClass)
Set the TCP trafficClass setting for connections created by this instance to trafficClass. |
HttpClient
|
setTrustAll(boolean trustAll)
If you want an SSL client to trust *all* server certificates rather than match them against those in its trust store, you can set this to true. |
HttpClient
|
setTrustStorePassword(java.lang.String pwd)
Set the password for the SSL trust store. |
HttpClient
|
setTrustStorePath(java.lang.String path)
Set the path to the SSL trust store. |
HttpClientRequest
|
trace(java.lang.String uri, groovy.lang.Closure responseHandler)
This method returns an HttpClientRequest instance which represents an HTTP TRACE request with the specified uri. |
Methods inherited from class java.lang.Object | |
---|---|
java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
Field Detail |
---|
protected HttpClient jClient
Method Detail |
---|
void close()
HttpClientRequest connect(java.lang.String uri, groovy.lang.Closure responseHandler)
When an HTTP response is received from the server the responseHandler is called passing in the response.
void connectWebsocket(java.lang.String uri, groovy.lang.Closure handler)
The connect is done asynchronously and wsConnect is called back with the websocket
void connectWebsocket(java.lang.String uri, WebSocketVersion version, groovy.lang.Closure handler)
This version of the method allows you to specify the websockets version using the wsVersion parameter The connect is done asynchronously and wsConnect is called back with the websocket
HttpClientRequest delete(java.lang.String uri, groovy.lang.Closure responseHandler)
When an HTTP response is received from the server the responseHandler is called passing in the response.
void exceptionHandler(groovy.lang.Closure handler)
HttpClientRequest get(java.lang.String uri, groovy.lang.Closure responseHandler)
When an HTTP response is received from the server the responseHandler is called passing in the response.
java.lang.Integer getBossThreads()
java.lang.Long getConnectTimeout()
java.lang.String getKeyStorePassword()
java.lang.String getKeyStorePath()
int getMaxPoolSize()
void getNow(java.lang.String uri, groovy.lang.Closure responseHandler)
Normally with any of the HTTP methods you create the request then when you are ready to send it you call HttpClientRequest#end()#end() on it. With this method the request is immediately sent.
When an HTTP response is received from the server the responseHandler is called passing in the response.
void getNow(java.lang.String uri, java.util.Map headers, groovy.lang.Closure responseHandler)
java.lang.Integer getReceiveBufferSize()
java.lang.Integer getSendBufferSize()
java.lang.Integer getTrafficClass()
java.lang.String getTrustStorePassword()
java.lang.String getTrustStorePath()
HttpClientRequest head(java.lang.String uri, groovy.lang.Closure responseHandler)
When an HTTP response is received from the server the responseHandler is called passing in the response.
java.lang.Boolean isReuseAddress()
boolean isSSL()
java.lang.Boolean isSoLinger()
java.lang.Boolean isTCPKeepAlive()
java.lang.Boolean isTCPNoDelay()
boolean isTrustAll()
HttpClientRequest options(java.lang.String uri, groovy.lang.Closure responseHandler)
When an HTTP response is received from the server the responseHandler is called passing in the response.
HttpClientRequest patch(java.lang.String uri, groovy.lang.Closure responseHandler)
When an HTTP response is received from the server the responseHandler is called passing in the response.
HttpClientRequest post(java.lang.String uri, groovy.lang.Closure responseHandler)
When an HTTP response is received from the server the responseHandler is called passing in the response.
HttpClientRequest put(java.lang.String uri, groovy.lang.Closure responseHandler)
When an HTTP response is received from the server the responseHandler is called passing in the response.
HttpClientRequest request(java.lang.String method, java.lang.String uri, groovy.lang.Closure responseHandler)
When an HTTP response is received from the server the responseHandler is called passing in the response.
HttpClient setBossThreads(long threads)
HttpClient setConnectTimeout(long timeout)
HttpClient setHost(java.lang.String host)
HttpClient setKeepAlive(boolean keepAlive)
If keepAlive is false then a new connection will be created for each request and it won't ever go in the pool, the connection will closed after the response has been received. Even with no keep alive, the client will not allow more than getMaxPoolSize() connections to be created at any one time.
HttpClient setKeyStorePassword(java.lang.String pwd)
HttpClient setKeyStorePath(java.lang.String path)
The SSL key store is a standard Java Key Store, and will contain the client certificate. Client certificates are only required if the server requests client authentication.
HttpClient setMaxPoolSize(int maxConnections)
The client will maintain up to maxConnections HTTP connections in an internal pool
HttpClient setPort(int port)
HttpClient setReceiveBufferSize(int size)
HttpClient setReuseAddress(boolean reuse)
HttpClient setSSL(boolean ssl)
HttpClient setSendBufferSize(int size)
HttpClient setSoLinger(boolean linger)
HttpClient setTCPKeepAlive(boolean keepAlive)
HttpClient setTCPNoDelay(boolean tcpNoDelay)
HttpClient setTrafficClass(int trafficClass)
HttpClient setTrustAll(boolean trustAll)
Use this with caution as you may be exposed to "main in the middle" attacks
trustAll
- Set to true if you want to trust all server certificates
HttpClient setTrustStorePassword(java.lang.String pwd)
HttpClient setTrustStorePath(java.lang.String path)
The trust store is a standard Java Key Store, and should contain the certificates of any servers that the client trusts. If you wish the client to trust all server certificates you can use the setTrustAll(boolean) method.
HttpClientRequest trace(java.lang.String uri, groovy.lang.Closure responseHandler)
When an HTTP response is received from the server the responseHandler is called passing in the response.
Groovy Documentation