Tyrus 2.2.0 · org.glassfish.tyrus.servlet.TyrusHttpUpgradeHandler

Field Summary

Modifier and Type	Field and Description
private boolean	authenticated
private ByteBuffer	buf
private volatile boolean	closed
private Connection	connection
private final CountDownLatch	connectionLatch
public static final String	FRAME_BUFFER_SIZE The size to precede OutOfMemory Exception and potentially DDoS attacks when buffering incoming WebSocket frames.
private int	incomingBufferSize
private ServletInputStream	is
private static final Logger	LOGGER
private ServletOutputStream	os
private WebSocketEngine.UpgradeInfo	upgradeInfo
private WebConnection	wc
private Writer	writer

Constructor Summary

Access	Constructor and Description
public	TyrusHttpUpgradeHandler()

Method Summary

Modifier and Type	Method and Description
private void	close(int closeCode, String closeReason)
public void	destroy() Implements jakarta.servlet.http.HttpUpgradeHandler.destroy. It is called when the client is disconnected.
private int	Returns: legth of actually read data. fillBuf(int length of data available to read. length) Fill the buf with some more websocket protocol data.
pack-priv WebConnection	getWebConnection()
private void	httpSessionForcedClose(int closeCode, String closeReason)
public void	init(WebConnection the WebConnection object associated to this upgrade request wc) Implements jakarta.servlet.http.HttpUpgradeHandler.init. It is called once the HTTP Upgrade process has been completed and the upgraded connection is ready to start using the new protocol.
public void	onAllDataRead() Implements jakarta.servlet.ReadListener.onAllDataRead. Invoked when all data for the current request has been read.
public void	onDataAvailable() Implements jakarta.servlet.ReadListener.onDataAvailable. When an instance of the `ReadListener` is registered with a `ServletInputStream`, this method will be invoked by the container the first time when it is possible to read data.
public void	onError(Throwable the throwable to indicate why the read operation failed t) Implements jakarta.servlet.ReadListener.onError. Invoked when an error occurs processing the request.
public void	preInit(WebSocketEngine.UpgradeInfo The WebSocket UpgradeInfo. upgradeInfo, Writer The Tyrus SPI Writer. writer, boolean Whether the authentication has been used. authenticated) Sets the required information before `init(WebConnection)` is invoked.
public void	sessionDestroyed() Called when related `jakarta.servlet.http.HttpSession` is destroyed or invalidated.
public void	setIncomingBufferSize(int The new incoming frame buffer size value. incomingBufferSize) Override the default `FRAME_BUFFER_SIZE`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

authenticated	back to summary
private boolean authenticated

buf	back to summary
private ByteBuffer buf

closed	back to summary
private volatile boolean closed

connection	back to summary
private Connection connection

connectionLatch	back to summary
private final CountDownLatch connectionLatch

FRAME_BUFFER_SIZE	back to summary
public static final String FRAME_BUFFER_SIZE The size to precede OutOfMemory Exception and potentially DDoS attacks when buffering incoming WebSocket frames. The default value is 4194315 bytes, which correspond to 4M plus few bytes to frame headers.

FRAME_BUFFER_SIZE

back to summary

public static final String FRAME_BUFFER_SIZE

The size to precede OutOfMemory Exception and potentially DDoS attacks when buffering incoming WebSocket frames.

The default value is 4194315 bytes, which correspond to 4M plus few bytes to frame headers.

incomingBufferSize	back to summary
private int incomingBufferSize

is	back to summary
private ServletInputStream is

LOGGER	back to summary
private static final Logger LOGGER

os	back to summary
private ServletOutputStream os

upgradeInfo	back to summary
private WebSocketEngine.UpgradeInfo upgradeInfo

wc	back to summary
private WebConnection wc

writer	back to summary
private Writer writer

Constructor Detail

TyrusHttpUpgradeHandler	back to summary
public TyrusHttpUpgradeHandler()

Method Detail

close	back to summary
private void close(int closeCode, String closeReason)

destroy	back to summary
public void destroy() Implements jakarta.servlet.http.HttpUpgradeHandler.destroy. Doc from jakarta.servlet.http.HttpUpgradeHandler.destroy. It is called when the client is disconnected. Annotations @Override

destroy

back to summary

public void destroy()

Implements jakarta.servlet.http.HttpUpgradeHandler.destroy.

Doc from jakarta.servlet.http.HttpUpgradeHandler.destroy.

It is called when the client is disconnected.

Annotations

@Override

fillBuf	back to summary
private int fillBuf(int length) throws IOException Fill the buf with some more websocket protocol data. Parameters length:int length of data available to read. Returns:int legth of actually read data. Exceptions IOException: if some other I/O error occurs.

fillBuf

back to summary

private int fillBuf(int length) throws IOException

Fill the buf with some more websocket protocol data.

Parameters

length:int: length of data available to read.

Returns:int

legth of actually read data.

Exceptions

IOException:: if some other I/O error occurs.

getWebConnection	back to summary
pack-priv WebConnection getWebConnection()

httpSessionForcedClose	back to summary
private void httpSessionForcedClose(int closeCode, String closeReason)

init	back to summary
public void init(WebConnection wc) Implements jakarta.servlet.http.HttpUpgradeHandler.init. Doc from jakarta.servlet.http.HttpUpgradeHandler.init. It is called once the HTTP Upgrade process has been completed and the upgraded connection is ready to start using the new protocol. Parameters wc:WebConnection the WebConnection object associated to this upgrade request Annotations @Override

init

back to summary

public void init(WebConnection wc)

Implements jakarta.servlet.http.HttpUpgradeHandler.init.

Doc from jakarta.servlet.http.HttpUpgradeHandler.init.

It is called once the HTTP Upgrade process has been completed and the upgraded connection is ready to start using the new protocol.

Parameters

wc:WebConnection: the WebConnection object associated to this upgrade request

Annotations

@Override

onAllDataRead	back to summary
public void onAllDataRead() Implements jakarta.servlet.ReadListener.onAllDataRead. Doc from jakarta.servlet.ReadListener.onAllDataRead. Invoked when all data for the current request has been read. Annotations @Override

onAllDataRead

back to summary

public void onAllDataRead()

Implements jakarta.servlet.ReadListener.onAllDataRead.

Doc from jakarta.servlet.ReadListener.onAllDataRead.

Invoked when all data for the current request has been read.

Annotations

@Override

onDataAvailable back to summary

onDataAvailable	back to summary
public void onDataAvailable() Implements jakarta.servlet.ReadListener.onDataAvailable. Doc from jakarta.servlet.ReadListener.onDataAvailable. When an instance of the `ReadListener` is registered with a `ServletInputStream`, this method will be invoked by the container the first time when it is possible to read data. Subsequently the container will invoke this method if and only if the `jakarta.servlet.ServletInputStream#isReady()` method has been called and has returned a value of `false` and data has subsequently become available to read. Annotations @Override

public void onDataAvailable()

Implements jakarta.servlet.ReadListener.onDataAvailable.

Doc from jakarta.servlet.ReadListener.onDataAvailable.

When an instance of the ReadListener is registered with a ServletInputStream, this method will be invoked by the container the first time when it is possible to read data. Subsequently the container will invoke this method if and only if the jakarta.servlet.ServletInputStream#isReady() method has been called and has returned a value of false and data has subsequently become available to read.

Annotations

@Override

onError	back to summary
public void onError(Throwable t) Implements jakarta.servlet.ReadListener.onError. Doc from jakarta.servlet.ReadListener.onError. Invoked when an error occurs processing the request. Parameters t:Throwable the throwable to indicate why the read operation failed Annotations @Override

onError

back to summary

public void onError(Throwable t)

Implements jakarta.servlet.ReadListener.onError.

Doc from jakarta.servlet.ReadListener.onError.

Invoked when an error occurs processing the request.

Parameters

t:Throwable: the throwable to indicate why the read operation failed

Annotations

@Override

preInit back to summary

preInit	back to summary
public void preInit(WebSocketEngine.UpgradeInfo upgradeInfo, Writer writer, boolean authenticated) Sets the required information before `init(WebConnection)` is invoked. Parameters upgradeInfo:WebSocketEngine.UpgradeInfo The WebSocket UpgradeInfo. writer:Writer The Tyrus SPI Writer. authenticated:boolean Whether the authentication has been used.

public void preInit(WebSocketEngine.UpgradeInfo upgradeInfo, Writer writer, boolean authenticated)

Sets the required information before init(WebConnection) is invoked.

Parameters

upgradeInfo:WebSocketEngine.UpgradeInfo: The WebSocket UpgradeInfo.
writer:Writer: The Tyrus SPI Writer.
authenticated:boolean: Whether the authentication has been used.

sessionDestroyed back to summary

sessionDestroyed	back to summary
public void sessionDestroyed() Called when related `jakarta.servlet.http.HttpSession` is destroyed or invalidated. Implementation is required to call onClose() on server-side with corresponding close code (1008, see WebSocket spec 7.2) - only when there is an authorized user for this session.

public void sessionDestroyed()

Called when related jakarta.servlet.http.HttpSession is destroyed or invalidated.

Implementation is required to call onClose() on server-side with corresponding close code (1008, see WebSocket spec 7.2) - only when there is an authorized user for this session.

setIncomingBufferSize back to summary

setIncomingBufferSize	back to summary
public void setIncomingBufferSize(int incomingBufferSize) Override the default `FRAME_BUFFER_SIZE`. Parameters incomingBufferSize:int The new incoming frame buffer size value.

public void setIncomingBufferSize(int incomingBufferSize)

Override the default FRAME_BUFFER_SIZE.

Parameters

incomingBufferSize:int: The new incoming frame buffer size value.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class TyrusHttpUpgradeHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail