io.baratine.web.Web Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
A reactive Java web server.
There is a newer version: 1.0.1
/*
 * Copyright (c) 1998-2015 Caucho Technology -- all rights reserved
 *
 * This file is part of Baratine(TM)
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Baratine is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Baratine is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Baratine; if not, write to the
 *
 *   Free Software Foundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 *
 * @author Scott Ferguson
 */

package io.baratine.web;

import java.util.Objects;
import java.util.function.Supplier;

import io.baratine.inject.InjectManager;
import io.baratine.inject.Key;
import io.baratine.service.ServiceRef;
import io.baratine.service.ServiceRef.ServiceBuilder;
import io.baratine.spi.WebServerProvider;
import io.baratine.web.websocket.WebSocketBuilder;

/**
 * Web provides static methods to build a web server in a main() class.
 * 
 * 
 * import static io.baratine.web.Web.*;
 * 
 * public class MyMain
 * {
 *   public static void main(String []argv)
 *   {
 *     get("/test", req->req.ok("hello, world"));
 *     
 *     start();
 *   }
 * }
 * 
 * 
 * @see RequestWeb
 */
public interface Web
{
  //
  // webserver
  //
  
  static WebServerBuilder port(int port)
  {
    return builder().port(port);
  }
  
  //
  // routing
  //
  
  static WebServerBuilder include(Class type)
  {
    return builder().include(type);
  }
  
  //
  // view
  //
  
  static  WebServerBuilder view(ViewWeb view)
  {
    return builder().view(view);
  }
  
  static  WebServerBuilder view(Class> view)
  {
    return builder().view(view);
  }
  
  //
  // configuration
  //
  static WebServerBuilder scan(Class type)
  {
    return builder().scan(type);
  }

  static WebServerBuilder autoconf(String []args)
  {
    return builder().autoconf(args);
  }

  static WebServerBuilder args(String []args)
  {
    return builder().args(args);
  }

  static WebServerBuilder property(String name, String value)
  {
    Objects.requireNonNull(name);
    Objects.requireNonNull(value);
    
    return builder().property(name, value);
  }
  
  //
  // injection
  //
  
  static  InjectManager.BindingBuilder bind(Class type)
  {
    Objects.requireNonNull(type);
    
    return builder().bind(type);
  }
  
  static  InjectManager.BindingBuilder bind(Key key)
  {
    Objects.requireNonNull(key);
    
    return builder().bind(key);
  }
  
  //
  // services
  //
  
  static  ServiceBuilder service(Supplier supplier)
  {
    Objects.requireNonNull(supplier);
    
    //return BaratineWebProvider.builder().service(supplier);
    return null;
  }
  
  static ServiceRef.ServiceBuilder service(Class serviceClass)
  {
    Objects.requireNonNull(serviceClass);
    
    return builder().service(serviceClass);
  }
  
  //
  // routes
  //
  
  static WebResourceBuilder delete(String path)
  {
    return builder().delete(path);
  }
  
  static WebResourceBuilder get(String path)
  {
    return builder().get(path);
  }
  
  static WebResourceBuilder options(String path)
  {
    return builder().options(path);
  }
  
  static WebResourceBuilder patch(String path)
  {
    return builder().patch(path);
  }
  
  static WebResourceBuilder post(String path)
  {
    return builder().post(path);
  }
  
  static WebResourceBuilder put(String path)
  {
    return builder().put(path);
  }
  
  static WebResourceBuilder trace(String path)
  {
    return builder().trace(path);
  }
  
  static WebResourceBuilder route(String path)
  {
    return builder().route(path);
  }
  
  static WebSocketBuilder websocket(String path)
  {
    return builder().websocket(path);
  }
  
  //
  // lifecycle
  //
  
  static WebServer start()
  {
    return builder().start();
  }
  
  static void go()
  {
    builder().go();
  }
  
  static void join()
  {
    builder().join();
  }
  
  static WebServerBuilder builder()
  {
    return WebServerProvider.current().webBuilder();
  }
}