io.baratine.spi.ServiceManagerProvider 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.spi;

import java.lang.ref.SoftReference;
import java.util.ServiceLoader;
import java.util.WeakHashMap;

import io.baratine.inject.Injector.InjectorBuilder;
import io.baratine.service.Services;
import io.baratine.service.ServiceRef;
import io.baratine.stream.ResultStream;
import io.baratine.stream.ResultStreamBuilder;

/**
 * Provider for AMP services.
 * Normally services and actors do not need to access their underlying messages.
 * 
 * There may be some special circumstances for debugging, logging, auditing, security where a service might need to access
 * this information.
 * 
 * Example:
 * 
 *  * //Inside of a amp service
 * AmpProvider ampProvider = Amp.getProvider();
 * AmpMessage message = ampProvider.getCurrentMessage();
 * 
 * if (message.getType()==SEND) {
 *     //do something special
 * }
 * 
 * String securityToken = message.getHeaders().get("MY_SPECIAL_SECURITY_TOKEN");
 * 
 */

abstract public class ServiceManagerProvider implements AutoCloseable
{
  private static final WeakHashMap>
    _providerMap = new WeakHashMap<>();

  private static final ServiceManagerProvider _systemProvider;

  private ClassLoader _classLoader;
  
  public ServiceManagerProvider()
  {
    _classLoader = Thread.currentThread().getContextClassLoader();
  }

  public Services currentManager()
  {
    throw new UnsupportedOperationException(getClass().getName());
  }

  public Services.ServicesBuilder newManager()
  {
    throw new UnsupportedOperationException(getClass().getName());
  }

  /**
   * Given a service actor proxy, return a service reference.
   * @param serviceProxy service proxy
   * @return service reference
   */
  public ServiceRef toRef(Object serviceProxy)
  {
    throw new UnsupportedOperationException(getClass().getName());
  }

  public ServiceRef getCurrentServiceRef()
  {
    throw new UnsupportedOperationException(getClass().getName());
  }

  public Message getCurrentMessage()
  {
    throw new UnsupportedOperationException(getClass().getName());
  }

  public void flushOutbox()
  {
  }

  public boolean flushOutboxAndExecuteLast()
  {
    flushOutbox();
    
    return true;
  }

  public  ResultStreamBuilder newStream(ResultStream result)
  {
    throw new UnsupportedOperationException(getClass().getName());
  }
  /**
   * Gets the current ServiceManagerProvider for the system.
   *
   * @return instance of ServiceManagerProvider for the system.
   */
  public static ServiceManagerProvider current()
  {
    ServiceManagerProvider systemProvider = _systemProvider;
    
    if (systemProvider != null) {
      return systemProvider;
    }
    
    Thread thread = Thread.currentThread();
    ClassLoader loader = thread.getContextClassLoader();
    
    return getProvider(loader);
  }
  
  public void close()
  {
    synchronized (_providerMap) {
      _providerMap.remove(_classLoader);
    }
  }
  
  private static ServiceManagerProvider getProvider(ClassLoader loader)
  {
    synchronized (_providerMap) {
      SoftReference providerRef = _providerMap.get(loader);
      ServiceManagerProvider provider = null;

      if (providerRef != null) {
        provider = providerRef.get();
      }

      if (provider == null) {
        for (ServiceManagerProvider serviceProvider
              : ServiceLoader.load(ServiceManagerProvider.class, loader)) {
          provider = serviceProvider;
          break;
        }

        if (provider == null) {
          throw new UnsupportedOperationException(ServiceManagerProvider.class.getName()
                                                  + " has no available providers in " + loader);
        }

        _providerMap.put(loader, new SoftReference<>(provider));
      }

      return provider;
    }
  }

  public InjectorBuilder injectManager(ClassLoader classLoader)
  {
    throw new UnsupportedOperationException(getClass().getName());
  }
  
  static {
    ServiceManagerProvider systemProvider = null;
    
    try {
      systemProvider = getProvider(ServiceManagerProvider.class.getClassLoader());
    } catch (Throwable e) {
    }
    
    _systemProvider = systemProvider;
  }
}