Package org.apache.tomcat.util.net
Class SecureNio2Channel
- java.lang.Object
-
- org.apache.tomcat.util.net.Nio2Channel
-
- org.apache.tomcat.util.net.SecureNio2Channel
-
- All Implemented Interfaces:
Closeable,AutoCloseable,AsynchronousByteChannel,AsynchronousChannel,Channel
public class SecureNio2Channel extends Nio2Channel
Implementation of a secure socket channel for NIO2.
-
-
Field Summary
Fields Modifier and Type Field Description protected booleanclosedprotected booleanclosingprotected Nio2Endpointendpointprotected ByteBuffernetInBufferprotected ByteBuffernetOutBufferprotected booleansniCompleteprotected SSLEnginesslEngine-
Fields inherited from class org.apache.tomcat.util.net.Nio2Channel
bufHandler, emptyBuf, sc, socketWrapper
-
-
Constructor Summary
Constructors Constructor Description SecureNio2Channel(SocketBufferHandler bufHandler, Nio2Endpoint endpoint)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()Sends an SSL close message, will not physically close the connection here.
To close the connection, you could do something likevoidclose(boolean force)Close the connection.Future<Boolean>flush()Flush the channel.voidfree()Free the channel memoryByteBuffergetEmptyBuf()SSLEnginegetSslEngine()SSLSupportgetSSLSupport()inthandshake()Performs SSL handshake, non blocking, but performs NEED_TASK on the same thread.protected inthandshakeInternal(boolean async)protected SSLEngineResulthandshakeUnwrap()Perform handshake unwrapprotected SSLEngineResulthandshakeWrap()Performs the WRAP functionbooleanisClosing()booleanisHandshakeComplete()Future<Integer>read(ByteBuffer dst)Reads a sequence of bytes from this channel into the given buffer.<A> voidread(ByteBuffer[] dsts, int offset, int length, long timeout, TimeUnit unit, A attachment, CompletionHandler<Long,? super A> handler)<A> voidread(ByteBuffer dst, long timeout, TimeUnit unit, A attachment, CompletionHandler<Integer,? super A> handler)voidrehandshake()Force a blocking handshake to take place for this key.voidreset(AsynchronousSocketChannel channel, SocketWrapperBase<Nio2Channel> socket)Reset the channel.protected SSLEngineResult.HandshakeStatustasks()Executes all the tasks needed on the same thread.Future<Integer>write(ByteBuffer src)Writes a sequence of bytes to this channel from the given buffer.<A> voidwrite(ByteBuffer[] srcs, int offset, int length, long timeout, TimeUnit unit, A attachment, CompletionHandler<Long,? super A> handler)<A> voidwrite(ByteBuffer src, long timeout, TimeUnit unit, A attachment, CompletionHandler<Integer,? super A> handler)-
Methods inherited from class org.apache.tomcat.util.net.Nio2Channel
getAppReadBufHandler, getBufHandler, getIOChannel, isOpen, read, setAppReadBufHandler, toString, write
-
-
-
-
Field Detail
-
endpoint
protected final Nio2Endpoint endpoint
-
netInBuffer
protected ByteBuffer netInBuffer
-
netOutBuffer
protected ByteBuffer netOutBuffer
-
sslEngine
protected SSLEngine sslEngine
-
sniComplete
protected volatile boolean sniComplete
-
closed
protected boolean closed
-
closing
protected boolean closing
-
-
Constructor Detail
-
SecureNio2Channel
public SecureNio2Channel(SocketBufferHandler bufHandler, Nio2Endpoint endpoint)
-
-
Method Detail
-
reset
public void reset(AsynchronousSocketChannel channel, SocketWrapperBase<Nio2Channel> socket) throws IOException
Description copied from class:Nio2ChannelReset the channel.- Overrides:
resetin classNio2Channel- Parameters:
channel- The new async channel to associate with this NIO2 channelsocket- The new socket to associate with this NIO2 channel- Throws:
IOException- If a problem was encountered resetting the channel
-
free
public void free()
Description copied from class:Nio2ChannelFree the channel memory- Overrides:
freein classNio2Channel
-
flush
public Future<Boolean> flush()
Flush the channel.- Overrides:
flushin classNio2Channel- Returns:
trueif the network buffer has been flushed out and is empty elsefalse(as a future)
-
handshake
public int handshake() throws IOExceptionPerforms SSL handshake, non blocking, but performs NEED_TASK on the same thread. Hence, you should never call this method using your Acceptor thread, as you would slow down your system significantly.The return for this operation is 0 if the handshake is complete and a positive value if it is not complete. In the event of a positive value coming back, the appropriate read/write will already have been called with an appropriate CompletionHandler.
- Overrides:
handshakein classNio2Channel- Returns:
- 0 if hand shake is complete, negative if the socket needs to close and positive if the handshake is incomplete
- Throws:
IOException- if an error occurs during the handshake
-
handshakeInternal
protected int handshakeInternal(boolean async) throws IOException- Throws:
IOException
-
rehandshake
public void rehandshake() throws IOExceptionForce a blocking handshake to take place for this key. This requires that both network and application buffers have been emptied out prior to this call taking place, or a IOException will be thrown.- Throws:
IOException- - if an IO exception occurs or if application or network buffers contain dataSocketTimeoutException- - if a socket operation timed out
-
tasks
protected SSLEngineResult.HandshakeStatus tasks()
Executes all the tasks needed on the same thread.- Returns:
- the status
-
handshakeWrap
protected SSLEngineResult handshakeWrap() throws IOException
Performs the WRAP function- Returns:
- the result
- Throws:
IOException- An IO error occurred
-
handshakeUnwrap
protected SSLEngineResult handshakeUnwrap() throws IOException
Perform handshake unwrap- Returns:
- the result
- Throws:
IOException- An IO error occurred
-
getSSLSupport
public SSLSupport getSSLSupport()
-
close
public void close() throws IOExceptionSends an SSL close message, will not physically close the connection here.
To close the connection, you could do something likeclose(); while (isOpen() && !myTimeoutFunction()) Thread.sleep(25); if ( isOpen() ) close(true); //forces a close if you timed out- Specified by:
closein interfaceAsynchronousChannel- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceChannel- Specified by:
closein interfaceCloseable- Overrides:
closein classNio2Channel- Throws:
IOException- if an I/O error occursIOException- if there is data on the outgoing network buffer and we are unable to flush it
-
close
public void close(boolean force) throws IOExceptionDescription copied from class:Nio2ChannelClose the connection.- Overrides:
closein classNio2Channel- Parameters:
force- Should the underlying socket be forcibly closed?- Throws:
IOException- If closing the secure channel fails.
-
read
public Future<Integer> read(ByteBuffer dst)
Reads a sequence of bytes from this channel into the given buffer.- Specified by:
readin interfaceAsynchronousByteChannel- Overrides:
readin classNio2Channel- Parameters:
dst- The buffer into which bytes are to be transferred- Returns:
- The number of bytes read, possibly zero, or
-1if the channel has reached end-of-stream - Throws:
IllegalStateException- if the handshake was not completed
-
write
public Future<Integer> write(ByteBuffer src)
Writes a sequence of bytes to this channel from the given buffer.- Specified by:
writein interfaceAsynchronousByteChannel- Overrides:
writein classNio2Channel- Parameters:
src- The buffer from which bytes are to be retrieved- Returns:
- The number of bytes written, possibly zero
-
read
public <A> void read(ByteBuffer dst, long timeout, TimeUnit unit, A attachment, CompletionHandler<Integer,? super A> handler)
- Overrides:
readin classNio2Channel
-
read
public <A> void read(ByteBuffer[] dsts, int offset, int length, long timeout, TimeUnit unit, A attachment, CompletionHandler<Long,? super A> handler)
- Overrides:
readin classNio2Channel
-
write
public <A> void write(ByteBuffer src, long timeout, TimeUnit unit, A attachment, CompletionHandler<Integer,? super A> handler)
- Overrides:
writein classNio2Channel
-
write
public <A> void write(ByteBuffer[] srcs, int offset, int length, long timeout, TimeUnit unit, A attachment, CompletionHandler<Long,? super A> handler)
- Overrides:
writein classNio2Channel
-
isHandshakeComplete
public boolean isHandshakeComplete()
- Overrides:
isHandshakeCompletein classNio2Channel
-
isClosing
public boolean isClosing()
- Overrides:
isClosingin classNio2Channel
-
getSslEngine
public SSLEngine getSslEngine()
-
getEmptyBuf
public ByteBuffer getEmptyBuf()
-
-