org.mule.runtime.module.service.ServiceProviderResolutionHelper Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */

package org.mule.runtime.module.service;

import org.mule.runtime.api.service.Service;
import org.mule.runtime.api.service.ServiceDefinition;
import org.mule.runtime.api.service.ServiceProvider;

import java.util.Collection;
import java.util.List;

/**
 * Utility interface used on the {@link ServiceProvider} resolution process.
 */
public interface ServiceProviderResolutionHelper {

  /**
   * Injects the required service dependencies in the given {@link ServiceProvider}
   *
   * @param serviceProvider service provider to be injected. Non null.
   * @param resolvedServices services which are available to be injected into the service provider. Non null.
   * @throws ServiceResolutionError in case a given service cannot be injected or there is a missing service dependency.
   */
  void injectInstance(ServiceProvider serviceProvider, Collection resolvedServices)
      throws ServiceResolutionError;

  /**
   * Lists the service dependencies for a given {@link ServiceProvider}
   * 
   * A service dependency is the class of any field of the service provider class which is annotated with @Inject.
   * 
   * Only service classes are able to be injected, if a non service class is found then the discovery process must fail with
   * {@link IllegalArgumentException}.
   *
   * @param serviceProvider
   * @return a non null list containing the required service classes that must be injected.
   */
  List> findServiceDependencies(ServiceProvider serviceProvider);
}