io.baratine.service.Services Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 1998-2015 Caucho Technology -- all rights reserved
 *
 * This file is part of Baratine(TM)(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.service;

import java.util.concurrent.Executor;
import java.util.function.Supplier;

import io.baratine.inject.Key;
import io.baratine.spi.ServiceManagerProvider;

/**
 * Management for Baratine services.
 * 
 * 
 * @Inject ServiceManager _manager;
 * ...
 *  //Create a new local service
 *  MyActor actor = _manager.service(new MyActorImpl())
 *                          .as(MyActor.class);
 *  
 *  //Bind a service that is available for remote calls with a given interface
 *  MySub sub = _manager.newService(new MySubImpl())
 *                      .address("/sub")
 *                      .as(MySub.class);
 * 
 */
public interface Services
{
  /**
   * Returns the current ServiceManager
   */
  static Services current()
  {
    return ServiceManagerProvider.current().currentManager();
  }

  /**
   * Creates a new ServiceManager for using Baratine embedded in another
   * application.
   * 
   * 
   * manager = ServiceManager.manager()
   *                         .start();
   * 
   */
  static Services.ServicesBuilder newManager()
  {
    return ServiceManagerProvider.current().newManager();
  }

  /**
   * Looks up a service from a particular address.
   *
   * @param address the address to lookup
   * @return an ServiceRef
   */
  ServiceRef service(String address);
  
   T service(Class api);
  
   T service(Class api, String id);
  
  /**
   * Creates a new service programmatically.
   * 
   * 
   * services.newService(myServiceImpl)
   *         .ref();
   * 
   * 
   * @param serviceImpl the service implementation.
   * @return builder for fluent dsl
   */
   ServiceRef.ServiceBuilder newService(T serviceImpl);
  
   ServiceRef.ServiceBuilder newService(Class type);
  
   ServiceRef.ServiceBuilder newService(Class type, 
                                           Supplier supplier);

  
  /**
   * The pod/cluster node for this manager.
   */
  ServiceNode node();
  
  public interface ServicesBuilder
  {
    /**
     * Scans META-INF/services for built-in services.
     */
    ServicesBuilder autoServices(boolean isAutoServices);
    
     ServiceRef.ServiceBuilder service(Class type);
    
     ServiceRef.ServiceBuilder service(Key key, Class type);
    
     ServiceRef.ServiceBuilder service(Class type, 
                                          Supplier supplier);
    
    /**
     * Sets an executor factory for context-dependent integration.
     * 
     * When a Baratine service is called outside of Baratine, the result
     * callback is executed in the caller's context.
     * 
     * @param factory the supplied factory for thread execution context
     */
    ServicesBuilder systemExecutor(Supplier factory);
    
    Services get();
    
    Services start();
  }
}