org.tio.http.common

Class HttpRequest

java.lang.Object

org.tio.core.intf.Packet

org.tio.http.common.HttpPacket

org.tio.http.common.HttpRequest

All Implemented Interfaces:

Serializable

public class HttpRequest
extends HttpPacket

Author:

tanyaowu

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.tio.core.intf.Packet

org.tio.core.intf.Packet.Meta

Field Summary

Fields

Modifier and Type	Field and Description
org.tio.core.ChannelContext	channelContext
protected Map<String,String>	headers
HttpConfig	httpConfig
RequestLine	requestLine

Fields inherited from class org.tio.http.common.HttpPacket

body

Constructor Summary

Constructors

Constructor and Description
HttpRequest()
HttpRequest(org.tio.core.Node remote)

Method Summary

Modifier and Type	Method and Description
void	addHeader(String key, String value)
void	addHeaders(Map<String,String> headers)
void	addParam(String key, Object value)
void	close() 关闭连接
void	close(String remark) 关闭连接
HttpResponse	forward(String newPath)
HttpConst.RequestBodyFormat	getBodyFormat()
String	getBodyString()
Byte	getByte(String name)
byte	getByte(String name, byte defaultValue)
org.tio.core.ChannelContext	getChannelContext()
Charset	getCharset()
String	getClientIp() 获取真实的客户端ip
String	getConnection()
int	getContentLength()
Cookie	getCookie(String name)
@NotNull Map<String,Cookie>	getCookieMap()
Collection<Cookie>	getCookies()
long	getCreateTime()
String	getDomain() 根据host字段，获取去除端口的纯域名部分的值，形如：www.t-io.org, t-io.org等值
Double	getDouble(String name)
double	getDouble(String name, double defaultValue)
Float	getFloat(String name)
float	getFloat(String name, float defaultValue)
String	getHeader(String key)
Map<String,String>	getHeaders()
String	getHost() 获取请求头中的host字段，形如：www.t-io.org:8080, www.t-io.org等值
HttpConfig	getHttpConfig()
long	getId()
Integer	getInt(String name)
int	getInt(String name, int defaultValue) 获取 int 参数
boolean	getIsSupportGzip()
Long	getLong(String name)
long	getLong(String name, long defaultValue)
Object	getObject(String name)
Map<String,Object>	getParam() 把类型为数组的参数值转换成Object，相当于是取了数组的第一个值，便于业务开发（因为大部分参数值其实只有一个）
String	getParam(String name)
Object[]	getParamArray(String name)
Map<String,Object[]>	getParams()
String	getReferer()
org.tio.core.Node	getRemote()
RequestLine	getRequestLine()
Short	getShort(String name)
short	getShort(String name, short defaultValue)
String	getString(String name) 同getParam(String name)
UploadFile	getUploadFile(String name)
String	getUserAgent() 获取请求头中的User-Agent字段
boolean	isClosed()
boolean	isForward()
boolean	isNeedForward()
String	logstr()
void	removeHeader(String key, String value)
void	setBodyFormat(HttpConst.RequestBodyFormat bodyFormat)
void	setBodyString(String bodyString)
void	setChannelContext(org.tio.core.ChannelContext channelContext)
void	setCharset(Charset charset)
void	setClosed(boolean closed)
void	setConnection(String connection)
void	setContentLength(int contentLength)
void	setCreateTime(long createTime)
void	setForward(boolean isForward)
void	setHeaders(Map<String,String> headers) 设置好header后，会把cookie等头部信息也设置好
void	setHttpConfig(HttpConfig httpConfig)
void	setNeedForward(boolean needForward)
void	setParams(Map<String,Object[]> params)
void	setRemote(org.tio.core.Node remote)
void	setRequestLine(RequestLine requestLine)
String	toString()

Methods inherited from class org.tio.http.common.HttpPacket

getAttribute, getAttribute, getBody, getHeaderString, removeAttribute, setAttribute, setBody, setHeaderString

Methods inherited from class org.tio.core.intf.Packet

getByteCount, getMeta, getPacketListener, getPreEncodedByteBuffer, getSynSeq, isFromCluster, isSslEncrypted, setByteCount, setFromCluster, setMeta, setPacketListener, setPreEncodedByteBuffer, setSslEncrypted, setSynSeq

Methods inherited from class java.lang.Object

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

Field Detail

requestLine

public RequestLine requestLine

channelContext

public org.tio.core.ChannelContext channelContext

httpConfig

public HttpConfig httpConfig

headers

protected Map<String,String> headers

Constructor Detail

HttpRequest

public HttpRequest(org.tio.core.Node remote)

HttpRequest

public HttpRequest()

Method Detail

getId

public long getId()

Returns:

the id

close

public void close()

关闭连接

close

public void close(String remark)

关闭连接

Parameters:

remark - remark

addParam

public void addParam(String key,
                     Object value)

forward

public HttpResponse forward(String newPath)

Parameters:

newPath - newPath

Returns:

HttpResponse

getBodyFormat

public HttpConst.RequestBodyFormat getBodyFormat()

Returns:

the bodyFormat

setBodyFormat

public void setBodyFormat(HttpConst.RequestBodyFormat bodyFormat)

Parameters:

bodyFormat - the bodyFormat to set

getUserAgent

public String getUserAgent()

获取请求头中的User-Agent字段

Returns:

String

getHost

public String getHost()

获取请求头中的host字段，形如：www.t-io.org:8080, www.t-io.org等值

Returns:

String

getClientIp

public String getClientIp()

获取真实的客户端ip

Returns:

String

addHeader

public void addHeader(String key,
                      String value)

addHeaders

public void addHeaders(Map<String,String> headers)

getDomain

public String getDomain()

根据host字段，获取去除端口的纯域名部分的值，形如：www.t-io.org, t-io.org等值

Returns:

String

getBodyString

public String getBodyString()

Returns:

the bodyString

setBodyString

public void setBodyString(String bodyString)

Parameters:

bodyString - the bodyString to set

getChannelContext

public org.tio.core.ChannelContext getChannelContext()

Returns:

the channelContext

setChannelContext

public void setChannelContext(org.tio.core.ChannelContext channelContext)

Parameters:

channelContext - the channelContext to set

getCharset

public Charset getCharset()

Returns:

the charset

setCharset

public void setCharset(Charset charset)

Parameters:

charset - the charset to set

getContentLength

public int getContentLength()

Returns:

the bodyLength

setContentLength

public void setContentLength(int contentLength)

Parameters:

contentLength - the bodyLength to set

getCookieMap

@NotNull
public @NotNull Map<String,Cookie> getCookieMap()

Returns:

the cookieMap

getCookies

public Collection<Cookie> getCookies()

Returns:

the cookies

getCookie

public Cookie getCookie(String name)

getHttpConfig

public HttpConfig getHttpConfig()

Returns:

the httpConfig

setHttpConfig

public void setHttpConfig(HttpConfig httpConfig)

Parameters:

httpConfig - the httpConfig to set

getHeader

public String getHeader(String key)

getHeaders

public Map<String,String> getHeaders()

Returns:

the headers

setHeaders

public void setHeaders(Map<String,String> headers)

设置好header后，会把cookie等头部信息也设置好

Parameters:

headers - the headers to set

removeHeader

public void removeHeader(String key,
                         String value)

getIsSupportGzip

public boolean getIsSupportGzip()

Returns:

the isSupportGzip

getParams

public Map<String,Object[]> getParams()

Returns:

the params

setParams

public void setParams(Map<String,Object[]> params)

Parameters:

params - the params to set

getParam

public Map<String,Object> getParam()

把类型为数组的参数值转换成Object，相当于是取了数组的第一个值，便于业务开发（因为大部分参数值其实只有一个）

Returns:

Map

getObject

public Object getObject(String name)

getParam

public String getParam(String name)

Parameters:

name - name

Returns:

String

getString

public String getString(String name)

同getParam(String name)

Parameters:

name - name

Returns:

String

getUploadFile

public UploadFile getUploadFile(String name)

Parameters:

name - name

Returns:

UploadFile

getInt

public Integer getInt(String name)

Parameters:

name - name

Returns:

Integer

getInt

public int getInt(String name,
                  int defaultValue)

获取 int 参数

Parameters:

name - name

defaultValue - 默认值

Returns:

int

getShort

public Short getShort(String name)

getShort

public short getShort(String name,
                      short defaultValue)

getByte

public Byte getByte(String name)

getByte

public byte getByte(String name,
                    byte defaultValue)

getLong

public Long getLong(String name)

getLong

public long getLong(String name,
                    long defaultValue)

getDouble

public double getDouble(String name,
                        double defaultValue)

getDouble

public Double getDouble(String name)

getFloat

public Float getFloat(String name)

getFloat

public float getFloat(String name,
                      float defaultValue)

getParamArray

public Object[] getParamArray(String name)

Parameters:

name - name

Returns:

Object array

getRemote

public org.tio.core.Node getRemote()

setRemote

public void setRemote(org.tio.core.Node remote)

getRequestLine

public RequestLine getRequestLine()

Returns:

the firstLine

setRequestLine

public void setRequestLine(RequestLine requestLine)

Parameters:

requestLine - the requestLine to set

logstr

public String logstr()

Overrides:

logstr in class org.tio.core.intf.Packet

getCreateTime

public long getCreateTime()

setCreateTime

public void setCreateTime(long createTime)

toString

public String toString()

Overrides:

toString in class Object

isClosed

public boolean isClosed()

setClosed

public void setClosed(boolean closed)

getConnection

public String getConnection()

Returns:

the connection

setConnection

public void setConnection(String connection)

Parameters:

connection - the connection to set

getReferer

public String getReferer()

isNeedForward

public boolean isNeedForward()

setNeedForward

public void setNeedForward(boolean needForward)

isForward

public boolean isForward()

setForward

public void setForward(boolean isForward)