2 * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.netconf.sal.streams.websockets;
11 import com.google.common.base.Preconditions;
12 import io.netty.bootstrap.ServerBootstrap;
13 import io.netty.channel.Channel;
14 import io.netty.channel.EventLoopGroup;
15 import io.netty.channel.nio.NioEventLoopGroup;
16 import io.netty.channel.socket.nio.NioServerSocketChannel;
17 import org.opendaylight.netconf.sal.streams.listeners.Notificator;
18 import org.slf4j.Logger;
19 import org.slf4j.LoggerFactory;
22 * {@link WebSocketServer} is the singleton responsible for starting and stopping the
25 public class WebSocketServer implements Runnable {
27 private static final Logger LOG = LoggerFactory.getLogger(WebSocketServer.class);
29 private static final String DEFAULT_ADDRESS = "0.0.0.0";
31 private static WebSocketServer instance = null;
33 private final String address;
34 private final int port;
36 private EventLoopGroup bossGroup;
37 private EventLoopGroup workerGroup;
40 private WebSocketServer(final String address, final int port) {
41 this.address = address;
46 * Create singleton instance of {@link WebSocketServer}.
48 * @param port TCP port used for this server
49 * @return instance of {@link WebSocketServer}
51 private static WebSocketServer createInstance(final int port) {
52 instance = createInstance(DEFAULT_ADDRESS, port);
56 public static WebSocketServer createInstance(final String address, final int port) {
57 Preconditions.checkState(instance == null, "createInstance() has already been called");
58 Preconditions.checkNotNull(address, "Address cannot be null.");
59 Preconditions.checkArgument(port >= 1024, "Privileged port (below 1024) is not allowed");
61 instance = new WebSocketServer(address, port);
66 * Get the websocket of TCP port.
68 * @return websocket TCP port
70 public int getPort() {
75 * Get instance of {@link WebSocketServer} created by {@link #createInstance(int)}.
77 * @return instance of {@link WebSocketServer}
79 public static WebSocketServer getInstance() {
80 Preconditions.checkNotNull(instance, "createInstance() must be called prior to getInstance()");
85 * Get instance of {@link WebSocketServer} created by {@link #createInstance(int)}.
86 * If an instance doesnt exist create one with the provided fallback port.
88 * @return instance of {@link WebSocketServer}
90 public static WebSocketServer getInstance(final int fallbackPort) {
91 if (instance != null) {
95 LOG.warn("No instance for WebSocketServer found, creating one with a fallback port: {}", fallbackPort);
96 return createInstance(fallbackPort);
100 * Destroy the existing instance.
102 public static void destroyInstance() {
103 Preconditions.checkState(instance != null, "createInstance() must be called prior to destroyInstance()");
111 bossGroup = new NioEventLoopGroup();
112 workerGroup = new NioEventLoopGroup();
114 final ServerBootstrap serverBootstrap = new ServerBootstrap();
115 serverBootstrap.group(bossGroup, workerGroup).channel(NioServerSocketChannel.class)
116 .childHandler(new WebSocketServerInitializer());
118 final Channel channel = serverBootstrap.bind(address, port).sync().channel();
119 LOG.info("Web socket server started at address {}, port {}.", address, port);
121 channel.closeFuture().sync();
122 } catch (final InterruptedException e) {
123 LOG.error("Web socket server encountered an error during startup attempt on port {}", port, e);
130 * Stops the web socket server and removes all listeners.
132 private void stop() {
133 LOG.info("Stopping the web socket server instance on port {}", port);
134 Notificator.removeAllListeners();
135 if (bossGroup != null) {
136 bossGroup.shutdownGracefully();
139 if (workerGroup != null) {
140 workerGroup.shutdownGracefully();