Package net.dreamlu.mica.http

Class HttpRequest

java.lang.Object

net.dreamlu.mica.http.HttpRequest

public class HttpRequest
extends Object

ok http 封装，请求结构体

Author:

L.cm

Method Summary

Modifier and Type	Method	Description
HttpRequest	addCookie(Consumer<okhttp3.Cookie.Builder> consumer)
HttpRequest	addCookie(okhttp3.Cookie cookie)
HttpRequest	addHeader(String... namesAndValues)
HttpRequest	addHeader(String name, String value)
HttpRequest	addHeader(Map<String,String> headers)
AsyncExchange	async()
HttpRequest	authenticator(okhttp3.Authenticator authenticator)
HttpRequest	baseAuth(String userName, String password)
HttpRequest	body(byte[] body)
HttpRequest	body(byte[] body, okhttp3.MediaType contentType)
HttpRequest	body(File body, okhttp3.MediaType contentType)
HttpRequest	body(String body, okhttp3.MediaType contentType)
HttpRequest	body(okhttp3.RequestBody requestBody)
HttpRequest	bodyJson(Object body)
HttpRequest	bodyJson(Object body, okhttp3.MediaType contentType)
HttpRequest	bodyString(String body)
HttpRequest	bodyString(okhttp3.MediaType contentType, String body)
HttpRequest	cacheControl(okhttp3.CacheControl cacheControl)
HttpRequest	connectTimeout(Duration timeout)
HttpRequest	cookieManager(okhttp3.CookieJar cookieJar)
static HttpRequest	delete(String url)
static HttpRequest	delete(URI uri)
HttpRequest	eventListener(okhttp3.EventListener eventListener)
Exchange	execute()
CompletableFuture<ResponseSpec>	executeAsync()
ResponseSpec	executeAsyncAndJoin()
HttpRequest	followRedirects(boolean followRedirects)
HttpRequest	followSslRedirects(boolean followSslRedirects)
FormBuilder	formBuilder()
static HttpRequest	get(String url)
static HttpRequest	get(URI uri)
static Pair<SSLContext,X509TrustManager>	getSslContext(InputStream keyStoreInputStream, String keyPass, InputStream trustInputStream, String trustPass)
static Pair<SSLContext,X509TrustManager>	getSslContext(String keyStoreFile, String keyPass, String trustStoreFile, String trustPass)
HttpRequest	hostnameVerifier(HostnameVerifier hostnameVerifier)
HttpRequest	interceptor(okhttp3.Interceptor interceptor)
MultipartFormBuilder	multipartFormBuilder()
static HttpRequest	patch(String url)
static HttpRequest	patch(URI uri)
HttpRequest	pathParam(String name, Object value)
static HttpRequest	post(String url)
static HttpRequest	post(URI uri)
HttpRequest	protocols(List<okhttp3.Protocol> protocols)
HttpRequest	proxy(String hostname, int port)
HttpRequest	proxy(InetSocketAddress address)
HttpRequest	proxy(Proxy proxy)
HttpRequest	proxy(Proxy.Type type, InetSocketAddress address)
HttpRequest	proxyAuthenticator(okhttp3.Authenticator proxyAuthenticator)
HttpRequest	proxySelector(ProxySelector proxySelector)
static HttpRequest	put(String url)
static HttpRequest	put(URI uri)
HttpRequest	query(String query)
HttpRequest	query(String name, @Nullable Object value)
HttpRequest	queryEncoded(String encodedQuery)
HttpRequest	queryEncoded(String encodedName, @Nullable Object encodedValue)
HttpRequest	queryMap(@Nullable Map<String,Object> queryMap)
HttpRequest	readTimeout(Duration readTimeout)
HttpRequest	removeHeader(String name)
HttpRequest	retry()
HttpRequest	retry(int maxAttempts, long sleepMillis)
HttpRequest	retry(int maxAttempts, long sleepMillis, Predicate<ResponseSpec> respPredicate)
HttpRequest	retry(IRetry retry)
HttpRequest	retry(IRetry retry, Predicate<ResponseSpec> respPredicate)
HttpRequest	retryOn(Predicate<ResponseSpec> respPredicate)
static void	setGlobalConsoleLog(LogLevel logLevel)	设置全局日志，控制台日志
static void	setGlobalDefaultLog(LogLevel logLevel)	设置全局日志，平台自带日志，默认 jdk 日志
static void	setGlobalLog(HttpLoggingInterceptor.Logger logger)	设置全局日志，默认级别：BODY
static void	setGlobalLog(HttpLoggingInterceptor.Logger logger, LogLevel logLevel)	设置全局日志
static void	setGlobalLog(LogLevel logLevel)	设置全局日志，默认：Slf4j
static okhttp3.OkHttpClient	setGlobalSSL()	设置全局的 ssl 配置
static okhttp3.OkHttpClient	setGlobalSSL(InputStream keyStoreInputStream, String keyPass)
static okhttp3.OkHttpClient	setGlobalSSL(InputStream keyStoreInputStream, String keyPass, InputStream trustInputStream, String trustPass)
static okhttp3.OkHttpClient	setGlobalSSL(String keyStoreFile, String keyPass)
static okhttp3.OkHttpClient	setGlobalSSL(String keyStoreFile, String keyPass, String trustStoreFile, String trustPass)
static okhttp3.OkHttpClient	setGlobalSSL(SSLSocketFactory sslSocketFactory, X509TrustManager trustManager)
HttpRequest	setHeader(String name, String value)
static void	setHttpClient(okhttp3.OkHttpClient httpClient)
HttpRequest	sslSocketFactory(SSLSocketFactory sslSocketFactory, @Nullable X509TrustManager trustManager)
String	toString()
HttpRequest	useConsoleLog()
HttpRequest	useConsoleLog(LogLevel logLevel)
HttpRequest	useDefaultLog()
HttpRequest	useDefaultLog(LogLevel logLevel)
HttpRequest	useLog(HttpLoggingInterceptor.Logger logger)
HttpRequest	useLog(HttpLoggingInterceptor.Logger logger, LogLevel logLevel)
HttpRequest	userAgent(String userAgent)
HttpRequest	useSlf4jLog()
HttpRequest	useSlf4jLog(LogLevel logLevel)
HttpRequest	useSSL()
HttpRequest	useSSL(InputStream keyStoreInputStream, String keyPass)
HttpRequest	useSSL(InputStream keyStoreInputStream, String keyPass, InputStream trustInputStream, String trustPass)
HttpRequest	useSSL(String keyStoreFile, String keyPass)
HttpRequest	useSSL(String keyStoreFile, String keyPass, String trustStoreFile, String trustPass)
HttpRequest	useSSL(SSLSocketFactory sslSocketFactory, X509TrustManager trustManager)
HttpRequest	writeTimeout(Duration writeTimeout)

Methods inherited from class java.lang.Object

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

Method Details

get

public static HttpRequest get(String url)

get

public static HttpRequest get(URI uri)

post

public static HttpRequest post(String url)

post

public static HttpRequest post(URI uri)

patch

public static HttpRequest patch(String url)

patch

public static HttpRequest patch(URI uri)

put

public static HttpRequest put(String url)

put

public static HttpRequest put(URI uri)

delete

public static HttpRequest delete(String url)

delete

public static HttpRequest delete(URI uri)

pathParam

public HttpRequest pathParam(String name,
 Object value)

query

public HttpRequest query(String query)

queryEncoded

public HttpRequest queryEncoded(String encodedQuery)

queryMap

public HttpRequest queryMap(@Nullable Map<String,Object> queryMap)

query

public HttpRequest query(String name,
 @Nullable Object value)

queryEncoded

public HttpRequest queryEncoded(String encodedName,
 @Nullable Object encodedValue)

formBuilder

public FormBuilder formBuilder()

multipartFormBuilder

public MultipartFormBuilder multipartFormBuilder()

body

public HttpRequest body(okhttp3.RequestBody requestBody)

body

public HttpRequest body(byte[] body)

body

public HttpRequest body(byte[] body,
 okhttp3.MediaType contentType)

body

public HttpRequest body(File body,
 okhttp3.MediaType contentType)

body

public HttpRequest body(String body,
 okhttp3.MediaType contentType)

bodyString

public HttpRequest bodyString(String body)

bodyString

public HttpRequest bodyString(okhttp3.MediaType contentType,
 String body)

bodyJson

public HttpRequest bodyJson(Object body)

bodyJson

public HttpRequest bodyJson(Object body,
 okhttp3.MediaType contentType)

execute

public Exchange execute()

async

public AsyncExchange async()

executeAsync

public CompletableFuture<ResponseSpec> executeAsync()

executeAsyncAndJoin

public ResponseSpec executeAsyncAndJoin()

baseAuth

public HttpRequest baseAuth(String userName,
 String password)

addHeader

public HttpRequest addHeader(Map<String,String> headers)

addHeader

public HttpRequest addHeader(String... namesAndValues)

addHeader

public HttpRequest addHeader(String name,
 String value)

setHeader

public HttpRequest setHeader(String name,
 String value)

removeHeader

public HttpRequest removeHeader(String name)

addCookie

public HttpRequest addCookie(okhttp3.Cookie cookie)

addCookie

public HttpRequest addCookie(Consumer<okhttp3.Cookie.Builder> consumer)

cacheControl

public HttpRequest cacheControl(okhttp3.CacheControl cacheControl)

userAgent

public HttpRequest userAgent(String userAgent)

followRedirects

public HttpRequest followRedirects(boolean followRedirects)

followSslRedirects

public HttpRequest followSslRedirects(boolean followSslRedirects)

useSlf4jLog

public HttpRequest useSlf4jLog()

useSlf4jLog

public HttpRequest useSlf4jLog(LogLevel logLevel)

useConsoleLog

public HttpRequest useConsoleLog()

useConsoleLog

public HttpRequest useConsoleLog(LogLevel logLevel)

useDefaultLog

public HttpRequest useDefaultLog()

useDefaultLog

public HttpRequest useDefaultLog(LogLevel logLevel)

useLog

public HttpRequest useLog(HttpLoggingInterceptor.Logger logger)

useLog

public HttpRequest useLog(HttpLoggingInterceptor.Logger logger,
 LogLevel logLevel)

authenticator

public HttpRequest authenticator(okhttp3.Authenticator authenticator)

eventListener

public HttpRequest eventListener(okhttp3.EventListener eventListener)

interceptor

public HttpRequest interceptor(okhttp3.Interceptor interceptor)

cookieManager

public HttpRequest cookieManager(okhttp3.CookieJar cookieJar)

connectTimeout

public HttpRequest connectTimeout(Duration timeout)

readTimeout

public HttpRequest readTimeout(Duration readTimeout)

writeTimeout

public HttpRequest writeTimeout(Duration writeTimeout)

protocols

public HttpRequest protocols(List<okhttp3.Protocol> protocols)

proxy

public HttpRequest proxy(Proxy proxy)

proxy

public HttpRequest proxy(Proxy.Type type,
 InetSocketAddress address)

proxy

public HttpRequest proxy(InetSocketAddress address)

proxy

public HttpRequest proxy(String hostname,
 int port)

proxySelector

public HttpRequest proxySelector(ProxySelector proxySelector)

proxyAuthenticator

public HttpRequest proxyAuthenticator(okhttp3.Authenticator proxyAuthenticator)

retry

public HttpRequest retry()

retryOn

public HttpRequest retryOn(Predicate<ResponseSpec> respPredicate)

retry

public HttpRequest retry(int maxAttempts,
 long sleepMillis)

retry

public HttpRequest retry(int maxAttempts,
 long sleepMillis,
 Predicate<ResponseSpec> respPredicate)

retry

public HttpRequest retry(IRetry retry)

retry

public HttpRequest retry(IRetry retry,
 Predicate<ResponseSpec> respPredicate)

hostnameVerifier

public HttpRequest hostnameVerifier(HostnameVerifier hostnameVerifier)

sslSocketFactory

public HttpRequest sslSocketFactory(SSLSocketFactory sslSocketFactory,
 @Nullable X509TrustManager trustManager)

useSSL

public HttpRequest useSSL(SSLSocketFactory sslSocketFactory,
 X509TrustManager trustManager)

useSSL

public HttpRequest useSSL()

useSSL

public HttpRequest useSSL(String keyStoreFile,
 String keyPass)

useSSL

public HttpRequest useSSL(String keyStoreFile,
 String keyPass,
 String trustStoreFile,
 String trustPass)

useSSL

public HttpRequest useSSL(InputStream keyStoreInputStream,
 String keyPass)

useSSL

public HttpRequest useSSL(InputStream keyStoreInputStream,
 String keyPass,
 InputStream trustInputStream,
 String trustPass)

toString

public String toString()

Overrides:

toString in class Object

setHttpClient

public static void setHttpClient(okhttp3.OkHttpClient httpClient)

setGlobalDefaultLog

public static void setGlobalDefaultLog(LogLevel logLevel)

设置全局日志，平台自带日志，默认 jdk 日志

Parameters:

logLevel - LogLevel

setGlobalConsoleLog

public static void setGlobalConsoleLog(LogLevel logLevel)

设置全局日志，控制台日志

Parameters:

logLevel - LogLevel

setGlobalLog

public static void setGlobalLog(HttpLoggingInterceptor.Logger logger)

设置全局日志，默认级别：BODY

Parameters:

logger - HttpLoggingInterceptor.Logger

setGlobalLog

public static void setGlobalLog(LogLevel logLevel)

设置全局日志，默认：Slf4j

Parameters:

logLevel - LogLevel

setGlobalLog

public static void setGlobalLog(HttpLoggingInterceptor.Logger logger,
 LogLevel logLevel)

设置全局日志

Parameters:

logger - HttpLoggingInterceptor.Logger

logLevel - LogLevel

setGlobalSSL

public static okhttp3.OkHttpClient setGlobalSSL()

设置全局的 ssl 配置

setGlobalSSL

public static okhttp3.OkHttpClient setGlobalSSL(String keyStoreFile,
 String keyPass)

setGlobalSSL

public static okhttp3.OkHttpClient setGlobalSSL(String keyStoreFile,
 String keyPass,
 String trustStoreFile,
 String trustPass)

setGlobalSSL

public static okhttp3.OkHttpClient setGlobalSSL(InputStream keyStoreInputStream,
 String keyPass)

setGlobalSSL

public static okhttp3.OkHttpClient setGlobalSSL(InputStream keyStoreInputStream,
 String keyPass,
 InputStream trustInputStream,
 String trustPass)

setGlobalSSL

public static okhttp3.OkHttpClient setGlobalSSL(SSLSocketFactory sslSocketFactory,
 X509TrustManager trustManager)

getSslContext

public static Pair<SSLContext,X509TrustManager> getSslContext(String keyStoreFile,
 String keyPass,
 String trustStoreFile,
 String trustPass)

getSslContext

public static Pair<SSLContext,X509TrustManager> getSslContext(InputStream keyStoreInputStream,
 String keyPass,
 InputStream trustInputStream,
 String trustPass)