io.vertx.rxjava.ext.web.handler.sockjs.SockJSHandler Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014 Red Hat, Inc.
 *
 * Red Hat 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 io.vertx.rxjava.ext.web.handler.sockjs;

import java.util.Map;
import rx.Observable;
import io.vertx.rxjava.core.Vertx;
import io.vertx.rxjava.ext.web.Router;
import io.vertx.rxjava.ext.web.RoutingContext;
import io.vertx.core.Handler;
import io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions;
import io.vertx.ext.web.handler.sockjs.BridgeOptions;

/**
 *
 * A handler that allows you to handle SockJS connections from clients.
 * 
 * We currently support version 0.3.3 of the SockJS protocol, which can be found in
 * this tag:
 *
 * 
 * NOTE: This class has been automatically generated from the {@link io.vertx.ext.web.handler.sockjs.SockJSHandler original} non RX-ified interface using Vert.x codegen.
 */

public class SockJSHandler implements Handler {

  final io.vertx.ext.web.handler.sockjs.SockJSHandler delegate;

  public SockJSHandler(io.vertx.ext.web.handler.sockjs.SockJSHandler delegate) {
    this.delegate = delegate;
  }

  public Object getDelegate() {
    return delegate;
  }

  public void handle(RoutingContext arg0) { 
    delegate.handle((io.vertx.ext.web.RoutingContext)arg0.getDelegate());
  }

  /**
   * Create a SockJS handler
   * @param vertx the Vert.x instance
   * @return the handler
   */
  public static SockJSHandler create(Vertx vertx) { 
    SockJSHandler ret = SockJSHandler.newInstance(io.vertx.ext.web.handler.sockjs.SockJSHandler.create((io.vertx.core.Vertx)vertx.getDelegate()));
    return ret;
  }

  /**
   * Create a SockJS handler
   * @param vertx the Vert.x instance
   * @param options options to configure the handler
   * @return the handler
   */
  public static SockJSHandler create(Vertx vertx, SockJSHandlerOptions options) { 
    SockJSHandler ret = SockJSHandler.newInstance(io.vertx.ext.web.handler.sockjs.SockJSHandler.create((io.vertx.core.Vertx)vertx.getDelegate(), options));
    return ret;
  }

  /**
   * Install SockJS test applications on a router - used when running the SockJS test suite
   * @param router the router to install on
   * @param vertx the Vert.x instance
   */
  public static void installTestApplications(Router router, Vertx vertx) { 
    io.vertx.ext.web.handler.sockjs.SockJSHandler.installTestApplications((io.vertx.ext.web.Router)router.getDelegate(), (io.vertx.core.Vertx)vertx.getDelegate());
  }

  /**
   * Set a SockJS socket handler. This handler will be called with a SockJS socket whenever a SockJS connection
   * is made from a client
   * @param handler the handler
   * @return a reference to this, so the API can be used fluently
   */
  public SockJSHandler socketHandler(Handler handler) { 
    delegate.socketHandler(new Handler() {
      public void handle(io.vertx.ext.web.handler.sockjs.SockJSSocket event) {
        handler.handle(SockJSSocket.newInstance(event));
      }
    });
    return this;
  }

  /**
   * Bridge the SockJS handler to the Vert.x event bus. This basically installs a built-in SockJS socket handler
   * which takes SockJS traffic and bridges it to the event bus, thus allowing you to extend the server-side
   * Vert.x event bus to browsers
   * @param bridgeOptions options to configure the bridge with
   * @return a reference to this, so the API can be used fluently
   */
  public SockJSHandler bridge(BridgeOptions bridgeOptions) { 
    delegate.bridge(bridgeOptions);
    return this;
  }

  /**
   * Like {@link io.vertx.rxjava.ext.web.handler.sockjs.SockJSHandler#bridge} but specifying a handler
   * that will receive bridge events.
   * @param bridgeOptions options to configure the bridge with
   * @param bridgeEventHandler handler to receive bridge events
   * @return a reference to this, so the API can be used fluently
   */
  public SockJSHandler bridge(BridgeOptions bridgeOptions, Handler bridgeEventHandler) { 
    delegate.bridge(bridgeOptions, new Handler() {
      public void handle(io.vertx.ext.web.handler.sockjs.BridgeEvent event) {
        bridgeEventHandler.handle(BridgeEvent.newInstance(event));
      }
    });
    return this;
  }


  public static SockJSHandler newInstance(io.vertx.ext.web.handler.sockjs.SockJSHandler arg) {
    return arg != null ? new SockJSHandler(arg) : null;
  }
}