cn.orionsec.kit.http

Class BaseHttpRequest

java.lang.Object

cn.orionsec.kit.http.BaseHttpRequest

Direct Known Subclasses:

BaseApacheRequest, BaseOkRequest, ParseRequest

public abstract class BaseHttpRequest
extends Object

公共 Http 请求 基类

Since:

2021/3/5 16:50

Version:

1.0.0

Author:

Jiahang Li

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	body 请求体
protected int	bodyLen 长度
protected int	bodyOffset 偏移量
protected String	charset charset
protected String	contentType Content-Type GET HEAD DELETE OPTION TRACE 无效
protected Collection<HttpCookie>	cookies cookies
protected static String	DEFAULT_USERAGENT
protected Map<String,String>	formParts 表单参数
protected Map<String,String>	headers 请求头
protected Collection<String>	ignoreHeaders 忽略的请求头
protected String	method method
protected Map<String,Object>	queryParams 请求参数
protected String	queryString 请求参数
protected boolean	queryStringEncode 请求参数是否编码
protected String	url url

Constructor Summary

Constructors

Constructor and Description
BaseHttpRequest()

Method Summary

Modifier and Type	Method and Description
BaseHttpRequest	body(byte[] body)
BaseHttpRequest	body(byte[] body, int offset, int len)
BaseHttpRequest	body(String body)
protected void	buildRequest() 构建请求
BaseHttpRequest	charset(String charset)
BaseHttpRequest	contentType(HttpContentType contentType)
BaseHttpRequest	contentType(String contentType)
BaseHttpRequest	cookie(HttpCookie cookie)
BaseHttpRequest	cookies(Collection<HttpCookie> cookies)
BaseHttpRequest	format(Map<String,Object> map) 格式化 url 的参数 ${?}
BaseHttpRequest	format(Object... o) 格式化 url 的参数 {}
BaseHttpRequest	formPart(String key, String value)
BaseHttpRequest	formParts(Map<String,String> formParts)
byte[]	getBody()
int	getBodyLen()
int	getBodyOffset()
String	getCharset()
String	getContentType()
Collection<HttpCookie>	getCookies()
Map<String,String>	getFormParts()
Map<String,String>	getHeaders()
Collection<String>	getIgnoreHeaders()
String	getMethod()
Map<String,Object>	getQueryParams()
String	getQueryString()
String	getUrl()
BaseHttpRequest	header(String key, String value)
BaseHttpRequest	headers(Map<String,String> headers)
BaseHttpRequest	ignoreHeader(String ignoreHeader)
BaseHttpRequest	ignoreHeaders(Collection<String> ignoreHeaders)
BaseHttpRequest	ignoreHeaders(String... ignoreHeaders)
protected boolean	isNoBodyRequest() 是否为无body的请求
boolean	isQueryStringEncode()
BaseHttpRequest	method(HttpMethod method)
BaseHttpRequest	method(String method)
BaseHttpRequest	queryParam(String key, Object value)
BaseHttpRequest	queryParams(Map<String,?> queryParams)
BaseHttpRequest	queryStringEncode(boolean queryStringEncode)
BaseHttpRequest	referer(String value)
String	toString()
BaseHttpRequest	url(String url)
BaseHttpRequest	userAgent(String value)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_USERAGENT

protected static final String DEFAULT_USERAGENT

url

protected String url

url

method

protected String method

method

queryParams

protected Map<String,Object> queryParams

请求参数

queryString

protected String queryString

请求参数

queryStringEncode

protected boolean queryStringEncode

请求参数是否编码

charset

protected String charset

charset

contentType

protected String contentType

Content-Type GET HEAD DELETE OPTION TRACE 无效

headers

protected Map<String,String> headers

请求头

ignoreHeaders

protected Collection<String> ignoreHeaders

忽略的请求头

cookies

protected Collection<HttpCookie> cookies

cookies

formParts

protected Map<String,String> formParts

表单参数

body

protected byte[] body

请求体

bodyOffset

protected int bodyOffset

偏移量

bodyLen

protected int bodyLen

长度

Constructor Detail

BaseHttpRequest

public BaseHttpRequest()

Method Detail

url

public BaseHttpRequest url(String url)

format

public BaseHttpRequest format(Object... o)

格式化 url 的参数 {}

Parameters:

o - 参数

Returns:

this

format

public BaseHttpRequest format(Map<String,Object> map)

格式化 url 的参数 ${?}

Parameters:

map - 参数

Returns:

this

method

public BaseHttpRequest method(String method)

method

public BaseHttpRequest method(HttpMethod method)

queryParam

public BaseHttpRequest queryParam(String key,
                                  Object value)

queryParams

public BaseHttpRequest queryParams(Map<String,?> queryParams)

queryStringEncode

public BaseHttpRequest queryStringEncode(boolean queryStringEncode)

charset

public BaseHttpRequest charset(String charset)

header

public BaseHttpRequest header(String key,
                              String value)

headers

public BaseHttpRequest headers(Map<String,String> headers)

userAgent

public BaseHttpRequest userAgent(String value)

referer

public BaseHttpRequest referer(String value)

contentType

public BaseHttpRequest contentType(String contentType)

contentType

public BaseHttpRequest contentType(HttpContentType contentType)

ignoreHeader

public BaseHttpRequest ignoreHeader(String ignoreHeader)

ignoreHeaders

public BaseHttpRequest ignoreHeaders(String... ignoreHeaders)

ignoreHeaders

public BaseHttpRequest ignoreHeaders(Collection<String> ignoreHeaders)

cookie

public BaseHttpRequest cookie(HttpCookie cookie)

cookies

public BaseHttpRequest cookies(Collection<HttpCookie> cookies)

formPart

public BaseHttpRequest formPart(String key,
                                String value)

formParts

public BaseHttpRequest formParts(Map<String,String> formParts)

body

public BaseHttpRequest body(String body)

body

public BaseHttpRequest body(byte[] body)

body

public BaseHttpRequest body(byte[] body,
                            int offset,
                            int len)

buildRequest

protected void buildRequest()

构建请求

isNoBodyRequest

protected boolean isNoBodyRequest()

是否为无body的请求

Returns:

ignore

getUrl

public String getUrl()

getMethod

public String getMethod()

getQueryParams

public Map<String,Object> getQueryParams()

getQueryString

public String getQueryString()

isQueryStringEncode

public boolean isQueryStringEncode()

getCharset

public String getCharset()

getContentType

public String getContentType()

getHeaders

public Map<String,String> getHeaders()

getIgnoreHeaders

public Collection<String> getIgnoreHeaders()

getCookies

public Collection<HttpCookie> getCookies()

getFormParts

public Map<String,String> getFormParts()

getBody

public byte[] getBody()

getBodyOffset

public int getBodyOffset()

getBodyLen

public int getBodyLen()

toString

public String toString()

Overrides:

toString in class Object