/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.tomcat.util.net;
import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.channels.AsynchronousByteChannel;
import java.nio.channels.AsynchronousSocketChannel;
import java.nio.channels.ClosedChannelException;
import java.nio.channels.CompletionHandler;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
/**
* Base class for a SocketChannel wrapper used by the endpoint. This way, logic for an SSL socket channel remains the
* same as for a non SSL, making sure we don't need to code for any exception cases.
*/
public class Nio2Channel implements AsynchronousByteChannel {
protected static final ByteBuffer emptyBuf = ByteBuffer.allocate(0);
protected final SocketBufferHandler bufHandler;
protected AsynchronousSocketChannel sc = null;
protected SocketWrapperBase<Nio2Channel> socketWrapper = null;
public Nio2Channel(SocketBufferHandler bufHandler) {
this.bufHandler = bufHandler;
}
/**
* Reset the channel.
*
* @param channel The new async channel to associate with this NIO2 channel
* @param socketWrapper The new socket to associate with this NIO2 channel
*
* @throws IOException If a problem was encountered resetting the channel
*/
public void reset(AsynchronousSocketChannel channel, SocketWrapperBase<Nio2Channel> socketWrapper)
throws IOException {
this.sc = channel;
this.socketWrapper = socketWrapper;
bufHandler.reset();
}
/**
* Free the channel memory
*/
public void free() {
bufHandler.free();
}
SocketWrapperBase<Nio2Channel> getSocketWrapper() {
return socketWrapper;
}
/**
* Closes this channel.
*
* @throws IOException If an I/O error occurs
*/
@Override
public void close() throws IOException {
sc.close();
}
/**
* Close the connection.
*
* @param force Should the underlying socket be forcibly closed?
*
* @throws IOException If closing the secure channel fails.
*/
public void close(boolean force) throws IOException {
if (isOpen() || force) {
close();
}
}
/**
* Tells whether or not this channel is open.
*
* @return <code>true</code> if, and only if, this channel is open
*/
@Override
public boolean isOpen() {
return sc.isOpen();
}
public SocketBufferHandler getBufHandler() {
return bufHandler;
}
public AsynchronousSocketChannel getIOChannel() {
return sc;
}
public boolean isClosing() {
return false;
}
public boolean isHandshakeComplete() {
return true;
}
/**
* Performs SSL handshake hence is a no-op for the non-secure implementation.
*
* @return Always returns zero
*
* @throws IOException Never for non-secure channel
*/
public int handshake() throws IOException {
return 0;
}
@Override
public String toString() {
return super.toString() + ":" + sc;
}
@Override
public Future<Integer> read(ByteBuffer dst) {
return sc.read(dst);
}
@Override
public <A> void read(ByteBuffer dst, A attachment, CompletionHandler<Integer,? super A> handler) {
read(dst, 0L, TimeUnit.MILLISECONDS, attachment, handler);
}
public <A> void read(ByteBuffer dst, long timeout, TimeUnit unit, A attachment,
CompletionHandler<Integer,? super A> handler) {
sc.read(dst, timeout, unit, attachment, handler);
}
public <A> void read(ByteBuffer[] dsts, int offset, int length, long timeout, TimeUnit unit, A attachment,
CompletionHandler<Long,? super A> handler) {
sc.read(dsts, offset, length, timeout, unit, attachment, handler);
}
@Override
public Future<Integer> write(ByteBuffer src) {
return sc.write(src);
}
@Override
public <A> void write(ByteBuffer src, A attachment, CompletionHandler<Integer,? super A> handler) {
write(src, 0L, TimeUnit.MILLISECONDS, attachment, handler);
}
public <A> void write(ByteBuffer src, long timeout, TimeUnit unit, A attachment,
CompletionHandler<Integer,? super A> handler) {
sc.write(src, timeout, unit, attachment, handler);
}
public <A> void write(ByteBuffer[] srcs, int offset, int length, long timeout, TimeUnit unit, A attachment,
CompletionHandler<Long,? super A> handler) {
sc.write(srcs, offset, length, timeout, unit, attachment, handler);
}
private static final Future<Boolean> DONE = new Future<>() {
@Override
public boolean cancel(boolean mayInterruptIfRunning) {
return false;
}
@Override
public boolean isCancelled() {
return false;
}
@Override
public boolean isDone() {
return true;
}
@Override
public Boolean get() throws InterruptedException, ExecutionException {
return Boolean.TRUE;
}
@Override
public Boolean get(long timeout, TimeUnit unit)
throws InterruptedException, ExecutionException, TimeoutException {
return Boolean.TRUE;
}
};
public Future<Boolean> flush() {
return DONE;
}
private ApplicationBufferHandler appReadBufHandler;
public void setAppReadBufHandler(ApplicationBufferHandler handler) {
this.appReadBufHandler = handler;
}
protected ApplicationBufferHandler getAppReadBufHandler() {
return appReadBufHandler;
}
private static final Future<Integer> DONE_INT = new Future<>() {
@Override
public boolean cancel(boolean mayInterruptIfRunning) {
return false;
}
@Override
public boolean isCancelled() {
return false;
}
@Override
public boolean isDone() {
return true;
}
@Override
public Integer get() throws InterruptedException, ExecutionException {
return Integer.valueOf(-1);
}
@Override
public Integer get(long timeout, TimeUnit unit)
throws InterruptedException, ExecutionException, TimeoutException {
return Integer.valueOf(-1);
}
};
static final Nio2Channel CLOSED_NIO2_CHANNEL = new Nio2Channel(SocketBufferHandler.EMPTY) {
@Override
public void close() throws IOException {
}
@Override
public boolean isOpen() {
return false;
}
@Override
public void reset(AsynchronousSocketChannel channel, SocketWrapperBase<Nio2Channel> socket) throws IOException {
}
@Override
public void free() {
}
@Override
protected ApplicationBufferHandler getAppReadBufHandler() {
return ApplicationBufferHandler.EMPTY;
}
@Override
public void setAppReadBufHandler(ApplicationBufferHandler handler) {
}
@Override
public Future<Integer> read(ByteBuffer dst) {
return DONE_INT;
}
@Override
public <A> void read(ByteBuffer dst, long timeout, TimeUnit unit, A attachment,
CompletionHandler<Integer,? super A> handler) {
handler.failed(new ClosedChannelException(), attachment);
}
@Override
public <A> void read(ByteBuffer[] dsts, int offset, int length, long timeout, TimeUnit unit, A attachment,
CompletionHandler<Long,? super A> handler) {
handler.failed(new ClosedChannelException(), attachment);
}
@Override
public Future<Integer> write(ByteBuffer src) {
return DONE_INT;
}
@Override
public <A> void write(ByteBuffer src, long timeout, TimeUnit unit, A attachment,
CompletionHandler<Integer,? super A> handler) {
handler.failed(new ClosedChannelException(), attachment);
}
@Override
public <A> void write(ByteBuffer[] srcs, int offset, int length, long timeout, TimeUnit unit, A attachment,
CompletionHandler<Long,? super A> handler) {
handler.failed(new ClosedChannelException(), attachment);
}
@Override
public String toString() {
return "Closed Nio2Channel";
}
};
}