org.apache.sshd.netty.NettyIoConnector Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sshd-netty Show documentation
There is a newer version: 2.13.2
/*
 * 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.sshd.netty;

import java.net.SocketAddress;

import org.apache.sshd.common.AttributeRepository;
import org.apache.sshd.common.future.DefaultSshFuture;
import org.apache.sshd.common.io.IoConnectFuture;
import org.apache.sshd.common.io.IoConnector;
import org.apache.sshd.common.io.IoHandler;
import org.apache.sshd.common.io.IoServiceEventListener;
import org.apache.sshd.common.io.IoSession;

import io.netty.bootstrap.Bootstrap;
import io.netty.channel.Channel;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelOption;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.group.DefaultChannelGroup;
import io.netty.channel.socket.SocketChannel;
import io.netty.channel.socket.nio.NioSocketChannel;
import io.netty.handler.logging.LogLevel;
import io.netty.handler.logging.LoggingHandler;
import io.netty.util.concurrent.GlobalEventExecutor;

/**
 * The Netty based IoConnector implementation.
 *
 * @author Apache MINA SSHD Project
 */
public class NettyIoConnector extends NettyIoService implements IoConnector {
    protected final Bootstrap bootstrap = new Bootstrap();

    public NettyIoConnector(NettyIoServiceFactory factory, IoHandler handler) {
        super(factory, handler);

        channelGroup = new DefaultChannelGroup("sshd-connector-channels", GlobalEventExecutor.INSTANCE);
        bootstrap.group(factory.eventLoopGroup)
            .channel(NioSocketChannel.class)
            .option(ChannelOption.SO_BACKLOG, 100)  // TODO make this configurable
            .handler(new ChannelInitializer() {
                @Override
                @SuppressWarnings("synthetic-access")
                protected void initChannel(SocketChannel ch) throws Exception {
                    IoServiceEventListener listener = getIoServiceEventListener();
                    SocketAddress local = ch.localAddress();
                    SocketAddress remote = ch.remoteAddress();
                    AttributeRepository context = ch.hasAttr(CONTEXT_KEY)
                        ? ch.attr(CONTEXT_KEY).get()
                        : null;
                    try {
                        if (listener != null) {
                            try {
                                listener.connectionEstablished(NettyIoConnector.this, local, context, remote);
                            } catch (Exception e) {
                                ch.close();
                                throw e;
                            }
                        }

                        @SuppressWarnings("resource")
                        NettyIoSession session = new NettyIoSession(NettyIoConnector.this, handler, null);
                        if (context != null) {
                            session.setAttribute(AttributeRepository.class, context);
                        }

                        ChannelPipeline p = ch.pipeline();
                        p.addLast(new LoggingHandler(LogLevel.INFO));   // TODO make this configurable
                        p.addLast(session.adapter);
                    } catch (Exception e) {
                        if (listener != null) {
                            try {
                                listener.abortEstablishedConnection(NettyIoConnector.this, local, context, remote, e);
                            } catch (Exception exc) {
                                if (log.isDebugEnabled()) {
                                    log.debug("initChannel(" + ch + ") listener=" + listener + " ignoring abort event exception", exc);
                                }
                            }
                        }

                        throw e;
                    }
                }
            });
    }

    @Override
    public IoConnectFuture connect(SocketAddress address, AttributeRepository context, SocketAddress localAddress) {
        boolean debugEnabled = log.isDebugEnabled();
        if (debugEnabled) {
            log.debug("Connecting to {}", address);
        }

        IoConnectFuture future = new DefaultIoConnectFuture(address, null);
        ChannelFuture chf;
        if (localAddress != null) {
            chf = bootstrap.connect(address, localAddress);
        } else {
            chf = bootstrap.connect(address);
        }
        Channel channel = chf.channel();
        channel.attr(CONNECT_FUTURE_KEY).set(future);
        if (context != null) {
            channel.attr(CONTEXT_KEY).set(context);
        }

        chf.addListener(cf -> {
            Throwable t = chf.cause();
            if (t != null) {
                future.setException(t);
            } else if (chf.isCancelled()) {
                future.cancel();
            }
        });
        return future;
    }

    public static class DefaultIoConnectFuture extends DefaultSshFuture implements IoConnectFuture {
        public DefaultIoConnectFuture(Object id, Object lock) {
            super(id, lock);
        }

        @Override
        public IoSession getSession() {
            Object v = getValue();
            return (v instanceof IoSession) ? (IoSession) v : null;
        }

        @Override
        public Throwable getException() {
            Object v = getValue();
            return (v instanceof Throwable) ? (Throwable) v : null;
        }

        @Override
        public boolean isConnected() {
            Object v = getValue();
            return v instanceof IoSession;
        }

        @Override
        public void setSession(IoSession session) {
            setValue(session);
        }

        @Override
        public void setException(Throwable exception) {
            setValue(exception);
        }
    }
}