org.smartboot.http.server.impl

Class WebSocketRequestImpl

java.lang.Object

org.smartboot.http.server.impl.WebSocketRequestImpl

All Implemented Interfaces:

WebSocket, Reset, HttpRequest, WebSocketRequest

public class WebSocketRequestImpl
extends Object
implements WebSocketRequest, WebSocket, Reset

Version:

V1.0 , 2018/8/31

Author:

三刀

Field Summary

Fields

Modifier and Type	Field and Description
Request	request

Fields inherited from interface org.smartboot.http.common.codec.websocket.WebSocket

PAYLOAD_FINISH

Fields inherited from interface org.smartboot.http.server.HttpRequest

SSL_ENGINE_THREAD_LOCAL

Constructor Summary

Constructors

Constructor and Description
WebSocketRequestImpl(Request baseHttpRequest)

Method Summary

Modifier and Type	Method and Description
org.smartboot.socket.util.Attachment	getAttachment() 获取附件对象
String	getCharacterEncoding()
long	getContentLength()
String	getContentType()
Cookie[]	getCookies() 获取Cookie
int	getFrameOpcode()
int	getFrameRsv()
String	getHeader(HeaderNameEnum headName)
String	getHeader(String headName) 获取指定名称的Http Header值
Collection<String>	getHeaderNames()
Collection<String>	getHeaders(String name)
BodyInputStream	getInputStream()
InetSocketAddress	getLocalAddress()
Locale	getLocale()
Enumeration<Locale>	getLocales()
byte[]	getMaskingKey()
String	getMethod() Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
String	getParameter(String name)
Map<String,String[]>	getParameters()
String[]	getParameterValues(String name)
Collection<Part>	getParts()
Collection<Part>	getParts(MultipartConfig configElement)
byte[]	getPayload()
SmartDecoder	getPayloadDecoder()
long	getPayloadLength()
HttpProtocolEnum	getProtocol()
String	getQueryString()
String	getRemoteAddr() Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.
InetSocketAddress	getRemoteAddress()
String	getRemoteHost() Returns the fully qualified name of the client or the last proxy that sent the request.
Request	getRequest()
String	getRequestURI()
String	getRequestURL()
WebSocketResponseImpl	getResponse()
String	getScheme()
SSLEngine	getSslEngine()
Map<String,String>	getTrailerFields()
protected void	init(Request request)
boolean	isFrameFinalFlag()
boolean	isFrameMasked()
boolean	isSecure() 是否启动安全通信
boolean	isTrailerFieldsReady()
PushBuilder	newPushBuilder()
void	reset()
void	setAttachment(org.smartboot.socket.util.Attachment attachment) 存放附件，支持任意类型
void	setFrameFinalFlag(boolean frameFinalFlag)
void	setFrameMasked(boolean frameMasked)
void	setFrameOpcode(int frameOpcode)
void	setFrameRsv(int frameRsv)
void	setMaskingKey(byte[] maskingKey)
void	setPayload(byte[] payload)
void	setPayloadDecoder(SmartDecoder payloadDecoder)
void	setPayloadLength(long payloadLength)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.smartboot.http.server.WebSocketRequest

getHeader, getHeaderNames, getHeaders, getLocalAddress, getParameters, getQueryString, getRemoteAddress, getRequestURI, getRequestURL, isSecure

Field Detail

request

public Request request

Constructor Detail

WebSocketRequestImpl

public WebSocketRequestImpl(Request baseHttpRequest)

Method Detail

getResponse

public final WebSocketResponseImpl getResponse()

getInputStream

public BodyInputStream getInputStream()

Specified by:

getInputStream in interface HttpRequest

reset

public void reset()

Specified by:

reset in interface Reset

isFrameFinalFlag

public boolean isFrameFinalFlag()

Specified by:

isFrameFinalFlag in interface WebSocket

setFrameFinalFlag

public void setFrameFinalFlag(boolean frameFinalFlag)

Specified by:

setFrameFinalFlag in interface WebSocket

isFrameMasked

public boolean isFrameMasked()

Specified by:

isFrameMasked in interface WebSocket

setFrameMasked

public void setFrameMasked(boolean frameMasked)

Specified by:

setFrameMasked in interface WebSocket

getFrameRsv

public int getFrameRsv()

Specified by:

getFrameRsv in interface WebSocket

setFrameRsv

public void setFrameRsv(int frameRsv)

Specified by:

setFrameRsv in interface WebSocket

getFrameOpcode

public int getFrameOpcode()

Specified by:

getFrameOpcode in interface WebSocket

Specified by:

getFrameOpcode in interface WebSocketRequest

setFrameOpcode

public void setFrameOpcode(int frameOpcode)

Specified by:

setFrameOpcode in interface WebSocket

getPayload

public byte[] getPayload()

Specified by:

getPayload in interface WebSocket

Specified by:

getPayload in interface WebSocketRequest

getParts

public Collection<Part> getParts()
                          throws IOException

Specified by:

getParts in interface HttpRequest

Throws:

IOException

getParts

public Collection<Part> getParts(MultipartConfig configElement)
                          throws IOException

Specified by:

getParts in interface HttpRequest

Throws:

IOException

getTrailerFields

public Map<String,String> getTrailerFields()

Specified by:

getTrailerFields in interface HttpRequest

isTrailerFieldsReady

public boolean isTrailerFieldsReady()

Specified by:

isTrailerFieldsReady in interface HttpRequest

getAttachment

public org.smartboot.socket.util.Attachment getAttachment()

Description copied from interface: HttpRequest

获取附件对象

Specified by:

getAttachment in interface HttpRequest

Specified by:

getAttachment in interface WebSocketRequest

Returns:

附件

setAttachment

public void setAttachment(org.smartboot.socket.util.Attachment attachment)

Description copied from interface: HttpRequest

存放附件，支持任意类型

Specified by:

setAttachment in interface HttpRequest

Specified by:

setAttachment in interface WebSocketRequest

Parameters:

attachment - 附件对象

newPushBuilder

public PushBuilder newPushBuilder()

Specified by:

newPushBuilder in interface HttpRequest

getPayloadLength

public long getPayloadLength()

Specified by:

getPayloadLength in interface WebSocket

setPayloadLength

public void setPayloadLength(long payloadLength)

Specified by:

setPayloadLength in interface WebSocket

getMaskingKey

public byte[] getMaskingKey()

Specified by:

getMaskingKey in interface WebSocket

setMaskingKey

public void setMaskingKey(byte[] maskingKey)

Specified by:

setMaskingKey in interface WebSocket

setPayload

public void setPayload(byte[] payload)

Specified by:

setPayload in interface WebSocket

getPayloadDecoder

public SmartDecoder getPayloadDecoder()

Specified by:

getPayloadDecoder in interface WebSocket

setPayloadDecoder

public void setPayloadDecoder(SmartDecoder payloadDecoder)

Specified by:

setPayloadDecoder in interface WebSocket

init

protected void init(Request request)

getSslEngine

public SSLEngine getSslEngine()

Specified by:

getSslEngine in interface HttpRequest

getHeader

public final String getHeader(String headName)

Description copied from interface: HttpRequest

获取指定名称的Http Header值

Specified by:

getHeader in interface HttpRequest

Returns:

getHeader

public final String getHeader(HeaderNameEnum headName)

getHeaders

public final Collection<String> getHeaders(String name)

Specified by:

getHeaders in interface HttpRequest

getHeaderNames

public final Collection<String> getHeaderNames()

Specified by:

getHeaderNames in interface HttpRequest

getRequestURI

public final String getRequestURI()

Specified by:

getRequestURI in interface HttpRequest

getProtocol

public final HttpProtocolEnum getProtocol()

Specified by:

getProtocol in interface HttpRequest

getMethod

public final String getMethod()

Description copied from interface: HttpRequest

Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT. Same as the value of the CGI variable REQUEST_METHOD.

Specified by:

getMethod in interface HttpRequest

Returns:

a String specifying the name of the method with which this request was made

getScheme

public final String getScheme()

Specified by:

getScheme in interface HttpRequest

getRequestURL

public final String getRequestURL()

Specified by:

getRequestURL in interface HttpRequest

getQueryString

public final String getQueryString()

Specified by:

getQueryString in interface HttpRequest

getContentType

public final String getContentType()

Specified by:

getContentType in interface HttpRequest

getContentLength

public final long getContentLength()

Specified by:

getContentLength in interface HttpRequest

getParameter

public final String getParameter(String name)

Specified by:

getParameter in interface HttpRequest

getParameters

public final Map<String,String[]> getParameters()

Specified by:

getParameters in interface HttpRequest

getParameterValues

public final String[] getParameterValues(String name)

Specified by:

getParameterValues in interface HttpRequest

getRemoteAddr

public final String getRemoteAddr()

Description copied from interface: HttpRequest

Returns the Internet Protocol (IP) address of the client or last proxy that sent the request. For HTTP servlets, same as the value of the CGI variable REMOTE_ADDR.

Specified by:

getRemoteAddr in interface HttpRequest

Returns:

a String containing the IP address of the client that sent the request

getRemoteAddress

public final InetSocketAddress getRemoteAddress()

Specified by:

getRemoteAddress in interface HttpRequest

getLocalAddress

public final InetSocketAddress getLocalAddress()

Specified by:

getLocalAddress in interface HttpRequest

getRemoteHost

public final String getRemoteHost()

Description copied from interface: HttpRequest

Returns the fully qualified name of the client or the last proxy that sent the request. If the engine cannot or chooses not to resolve the hostname (to improve performance), this method returns the dotted-string form of the IP address. For HTTP servlets, same as the value of the CGI variable REMOTE_HOST.

Specified by:

getRemoteHost in interface HttpRequest

Returns:

a String containing the fully qualified name of the client

getLocale

public final Locale getLocale()

Specified by:

getLocale in interface HttpRequest

getLocales

public final Enumeration<Locale> getLocales()

Specified by:

getLocales in interface HttpRequest

getCharacterEncoding

public final String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface HttpRequest

getRequest

public final Request getRequest()

getCookies

public Cookie[] getCookies()

Description copied from interface: HttpRequest

获取Cookie

Specified by:

getCookies in interface HttpRequest

isSecure

public final boolean isSecure()

Description copied from interface: HttpRequest

是否启动安全通信

Specified by:

isSecure in interface HttpRequest