Class TlsNioSocket

java.lang.Object

io.helidon.common.socket.NioSocket

io.helidon.common.socket.TlsNioSocket

All Implemented Interfaces:

HelidonSocket, SocketContext, Supplier<byte[]>

public final class TlsNioSocket
extends NioSocket

TLS NIO helidon socket.

Method Summary

Modifier and Type	Method	Description
static TlsNioSocket	client(SocketChannel delegate, SSLEngine sslEngine, String channelId)	Create a client TLS NIO socket.
void	close()	Close the underlying socket.
byte[]	get()
void	handshake()	Complete the initial TLS handshake.
void	idle()	Sets the socket to idle mode.
boolean	isConnected()	Check if socket is connected.
boolean	isSecure()	Whether the request is secure.
PeerInfo	localPeer()	Local peer information.
String	protocol()	Protocol that was negotiated.
boolean	protocolNegotiated()	Whether a protocol was negotiated by the socket (such as ALPN when using TLS).
PeerInfo	remotePeer()	Remote peer information.
static TlsNioSocket	server(SocketChannel delegate, SSLEngine sslEngine, String channelId, String serverChannelId)	Create a server TLS NIO socket.
static TlsNioSocket	server(SocketChannel delegate, SSLEngine sslEngine, String channelId, String serverChannelId, ByteBuffer replayNetData)	Create a server TLS NIO socket with already-read TLS network data to replay into the first unwrap.
void	write(BufferData buffer)	Write teh buffer to the underlying socket.

Methods inherited from class NioSocket

childSocketId, client, read, readNonBlocking, server, socketId, write

Modifier and Type	Method	Description
String	childSocketId()	Child socket id.
static NioSocket	client(SocketChannel delegate, String channelId)	Create a new client socket.
protected int	read(ByteBuffer buffer)	Read from the underlying socket/channel into the provided buffer.
protected int	readNonBlocking(ByteBuffer buffer)	Read from the underlying socket/channel in non-blocking mode.
static NioSocket	server(SocketChannel delegate, String channelId, String serverChannelId)	Create a new server socket.
String	socketId()	Main socket id.
protected int	write(ByteBuffer buffer)	Write to the underlying socket/channel from the provided buffer.

Methods inherited from class Object

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

Methods inherited from interface SocketContext

log, log

Modifier and Type	Method	Description
default void	log(System.Logger logger, System.Logger.Level level, String format, Object... variables)	Log a message with the current SocketContext.socketId() and SocketContext.childSocketId() to have consistent logs mappable to sockets.
default void	log(System.Logger logger, System.Logger.Level level, String format, Throwable t, Object... variables)	Log a message with the current SocketContext.socketId() and SocketContext.childSocketId() to have consistent logs mappable to sockets.

Method Details

server

public static TlsNioSocket server(SocketChannel delegate,
 SSLEngine sslEngine,
 String channelId,
 String serverChannelId)

Create a server TLS NIO socket.

Parameters:

delegate - underlying socket

sslEngine - SSL engine

channelId - connection channel id

serverChannelId - listener channel id

Returns:

a new TLS socket

server

public static TlsNioSocket server(SocketChannel delegate,
 SSLEngine sslEngine,
 String channelId,
 String serverChannelId,
 ByteBuffer replayNetData)

Create a server TLS NIO socket with already-read TLS network data to replay into the first unwrap. This is intended for server implementations that need to inspect TLS records before creating the engine.

Parameters:

delegate - underlying socket

sslEngine - SSL engine

channelId - connection channel id

serverChannelId - listener channel id

replayNetData - already-read TLS network data

Returns:

a new TLS socket

client

public static TlsNioSocket client(SocketChannel delegate,
 SSLEngine sslEngine,
 String channelId)

Create a client TLS NIO socket.

Parameters:

delegate - underlying socket

sslEngine - SSL engine

channelId - channel id

Returns:

a new TLS socket

remotePeer

public PeerInfo remotePeer()

Description copied from interface: SocketContext

Remote peer information.

Specified by:

remotePeer in interface SocketContext

Overrides:

remotePeer in class NioSocket

Returns:

peer info

localPeer

public PeerInfo localPeer()

Description copied from interface: SocketContext

Local peer information.

Specified by:

localPeer in interface SocketContext

Overrides:

localPeer in class NioSocket

Returns:

peer info

isSecure

public boolean isSecure()

Description copied from interface: SocketContext

Whether the request is secure.

Specified by:

isSecure in interface SocketContext

Overrides:

isSecure in class NioSocket

Returns:

whether secure

protocolNegotiated

public boolean protocolNegotiated()

Description copied from interface: HelidonSocket

Whether a protocol was negotiated by the socket (such as ALPN when using TLS).

Returns:

whether a protocol was negotiated

protocol

public String protocol()

Description copied from interface: HelidonSocket

Protocol that was negotiated.

Returns:

protocol name

get

public byte[] get()

Specified by:

get in interface Supplier<byte[]>

Overrides:

get in class NioSocket

write

public void write(BufferData buffer)

Description copied from interface: HelidonSocket

Write teh buffer to the underlying socket. This method blocks until all bytes are written.

Specified by:

write in interface HelidonSocket

Overrides:

write in class NioSocket

Parameters:

buffer - buffer to write

handshake

public void handshake()

Complete the initial TLS handshake.

close

public void close()

Description copied from interface: HelidonSocket

Close the underlying socket.

Specified by:

close in interface HelidonSocket

Overrides:

close in class NioSocket

idle

public void idle()

Description copied from interface: HelidonSocket

Sets the socket to idle mode. Idle mode expects no bytes coming over the socket but keeps reading exactly one byte in case connection is severed. Idle mode should be used in case of client side connection caching.

Specified by:

idle in interface HelidonSocket

Overrides:

idle in class NioSocket

isConnected

public boolean isConnected()

Description copied from interface: HelidonSocket

Check if socket is connected.

Specified by:

isConnected in interface HelidonSocket

Overrides:

isConnected in class NioSocket

Returns:

true if connected