NettyWSTransport.java

/*
 * 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.activemq.transport.amqp.client.transport;

import java.io.IOException;
import java.net.URI;
import java.nio.charset.StandardCharsets;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import io.netty.buffer.ByteBuf;
import io.netty.channel.Channel;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandlerAdapter;
import io.netty.channel.ChannelPipeline;
import io.netty.handler.codec.http.DefaultHttpHeaders;
import io.netty.handler.codec.http.FullHttpResponse;
import io.netty.handler.codec.http.HttpClientCodec;
import io.netty.handler.codec.http.HttpObjectAggregator;
import io.netty.handler.codec.http.websocketx.BinaryWebSocketFrame;
import io.netty.handler.codec.http.websocketx.CloseWebSocketFrame;
import io.netty.handler.codec.http.websocketx.PingWebSocketFrame;
import io.netty.handler.codec.http.websocketx.PongWebSocketFrame;
import io.netty.handler.codec.http.websocketx.TextWebSocketFrame;
import io.netty.handler.codec.http.websocketx.WebSocketClientHandshaker;
import io.netty.handler.codec.http.websocketx.WebSocketClientHandshakerFactory;
import io.netty.handler.codec.http.websocketx.WebSocketFrame;
import io.netty.handler.codec.http.websocketx.WebSocketVersion;

/**
 * Transport for communicating over WebSockets
 */
public class NettyWSTransport extends NettyTcpTransport {

   private static final Logger LOG = LoggerFactory.getLogger(NettyWSTransport.class);

   private static final String AMQP_SUB_PROTOCOL = "amqp";

   /**
    * Create a new transport instance
    *
    * @param remoteLocation
    *        the URI that defines the remote resource to connect to.
    * @param options
    *        the transport options used to configure the socket connection.
    */
   public NettyWSTransport(URI remoteLocation, NettyTransportOptions options) {
      this(null, remoteLocation, options);
   }

   /**
    * Create a new transport instance
    *
    * @param listener
    *        the TransportListener that will receive events from this Transport.
    * @param remoteLocation
    *        the URI that defines the remote resource to connect to.
    * @param options
    *        the transport options used to configure the socket connection.
    */
   public NettyWSTransport(NettyTransportListener listener, URI remoteLocation, NettyTransportOptions options) {
      super(listener, remoteLocation, options);
   }

   @Override
   public void send(ByteBuf output) throws IOException {
      checkConnected();
      int length = output.readableBytes();
      if (length == 0) {
         return;
      }

      LOG.trace("Attempted write of: {} bytes", length);

      channel.writeAndFlush(new BinaryWebSocketFrame(output));
   }

   @Override
   protected ChannelInboundHandlerAdapter createChannelHandler() {
      return new NettyWebSocketTransportHandler();
   }

   @Override
   protected void addAdditionalHandlers(ChannelPipeline pipeline) {
      pipeline.addLast(new HttpClientCodec());
      pipeline.addLast(new HttpObjectAggregator(8192));
   }

   @Override
   protected void handleConnected(Channel channel) throws Exception {
      LOG.trace("Channel has become active, awaiting WebSocket handshake! Channel is {}", channel);
   }

   // ----- Handle connection events -----------------------------------------//

   private class NettyWebSocketTransportHandler extends NettyDefaultHandler<Object> {

      private final WebSocketClientHandshaker handshaker;

      NettyWebSocketTransportHandler() {
         handshaker = WebSocketClientHandshakerFactory.newHandshaker(getRemoteLocation(), WebSocketVersion.V13, AMQP_SUB_PROTOCOL, true,
            new DefaultHttpHeaders());
      }

      @Override
      public void channelActive(ChannelHandlerContext context) throws Exception {
         handshaker.handshake(context.channel());

         super.channelActive(context);
      }

      @Override
      protected void channelRead0(ChannelHandlerContext ctx, Object message) throws Exception {
         LOG.trace("New data read: incoming: {}", message);

         Channel ch = ctx.channel();
         if (!handshaker.isHandshakeComplete()) {
            handshaker.finishHandshake(ch, (FullHttpResponse) message);
            LOG.trace("WebSocket Client connected! {}", ctx.channel());
            // Now trigger super processing as we are really connected.
            NettyWSTransport.super.handleConnected(ch);
            return;
         }

         // We shouldn't get this since we handle the handshake previously.
         if (message instanceof FullHttpResponse) {
            FullHttpResponse response = (FullHttpResponse) message;
            throw new IllegalStateException(
               "Unexpected FullHttpResponse (getStatus=" + response.status() + ", content=" + response.content().toString(StandardCharsets.UTF_8) + ')');
         }

         WebSocketFrame frame = (WebSocketFrame) message;
         if (frame instanceof TextWebSocketFrame) {
            TextWebSocketFrame textFrame = (TextWebSocketFrame) frame;
            LOG.warn("WebSocket Client received message: " + textFrame.text());
            ctx.fireExceptionCaught(new IOException("Received invalid frame over WebSocket."));
         } else if (frame instanceof BinaryWebSocketFrame) {
            BinaryWebSocketFrame binaryFrame = (BinaryWebSocketFrame) frame;
            LOG.trace("WebSocket Client received data: {} bytes", binaryFrame.content().readableBytes());
            listener.onData(binaryFrame.content());
         } else if (frame instanceof PingWebSocketFrame) {
            LOG.trace("WebSocket Client received ping, response with pong");
            ch.write(new PongWebSocketFrame(frame.content()));
         } else if (frame instanceof CloseWebSocketFrame) {
            LOG.trace("WebSocket Client received closing");
            ch.close();
         }
      }
   }
}