Module org.glassfish.hk2.core
Package com.sun.enterprise.module.common_impl

Class AbstractModulesRegistryImpl

java.lang.Object
com.sun.enterprise.module.common_impl.AbstractModulesRegistryImpl
All Implemented Interfaces:
ModuleChangeListener, ModulesRegistry
Direct Known Subclasses:
ModulesRegistryImpl
public abstract class AbstractModulesRegistryImpl extends Object implements ModulesRegistry
The Modules Registry maintains the registry of all available module. TODO: concurrency bug in the acess of the repositories field.
Author:
Jerome Dochez, Sanjeeb.Sahoo@Sun.COM

  • Field Details

    • parent

      protected final ModulesRegistry parent
      ModulesRegistry can form a tree structure by using this pointer. It works in a way similar to the classloader tree. Modules defined in the parent are visible to children.

    • modules

      protected final ConcurrentMap<ModuleId,HK2Module> modules

    • repositories

      protected final Map<Integer,Repository> repositories

    • providers

      protected final Map<String,HK2Module> providers
      Service provider class names and which modules they are in.

      This is used for the classloader punch-in hack — to work nicely with classic service loader implementation, we need to be able to allow any modules to see these classes.

  • Constructor Details

    • AbstractModulesRegistryImpl

      protected AbstractModulesRegistryImpl(ModulesRegistry parent)

  • Method Details

    • newServiceLocator

      public org.glassfish.hk2.api.ServiceLocator newServiceLocator() throws org.glassfish.hk2.api.MultiException
      Creates an uninitialized ServiceLocator
      Specified by:
      newServiceLocator in interface ModulesRegistry
      Throws:
      org.glassfish.hk2.api.MultiException

    • newServiceLocator

      public org.glassfish.hk2.api.ServiceLocator newServiceLocator(org.glassfish.hk2.api.ServiceLocator parent) throws org.glassfish.hk2.api.MultiException
      Create a new ServiceLocator optionally providing a parent Services
      Specified by:
      newServiceLocator in interface ModulesRegistry
      Throws:
      org.glassfish.hk2.api.MultiException

    • initializeServiceLocator

      protected void initializeServiceLocator(org.glassfish.hk2.api.ServiceLocator serviceLocator) throws org.glassfish.hk2.api.MultiException
      Throws:
      org.glassfish.hk2.api.MultiException

    • populateServiceLocator

      public void populateServiceLocator(String name, org.glassfish.hk2.api.ServiceLocator serviceLocator, List<org.glassfish.hk2.api.PopulatorPostProcessor> postProcessors) throws org.glassfish.hk2.api.MultiException
      Creates a ServiceLocator from all the modules in this registry
      Specified by:
      populateServiceLocator in interface ModulesRegistry
      Parameters:
      name - Determines which descriptors are loaded.
      postProcessors -
      serviceLocator - Habitat to initialize, null if it should be created
      Throws:
      org.glassfish.hk2.api.MultiException

    • populateConfig

      public void populateConfig(org.glassfish.hk2.api.ServiceLocator serviceLocator)
      Specified by:
      populateConfig in interface ModulesRegistry

    • createServiceLocator

      public org.glassfish.hk2.api.ServiceLocator createServiceLocator(org.glassfish.hk2.api.ServiceLocator parent, String name, List<org.glassfish.hk2.api.PopulatorPostProcessor> postProcessors) throws org.glassfish.hk2.api.MultiException
      Description copied from interface: ModulesRegistry
      Creates a ServiceLocator with the provided parent.
      Specified by:
      createServiceLocator in interface ModulesRegistry
      Returns:
      Throws:
      org.glassfish.hk2.api.MultiException

    • createServiceLocator

      public org.glassfish.hk2.api.ServiceLocator createServiceLocator(String name) throws org.glassfish.hk2.api.MultiException
      Description copied from interface: ModulesRegistry
      Creates a ServiceLocator from all the modules in this registry Cal;ling this method has the same effect of calling ModulesRegistry.newServiceLocator() followed by {@link #populateServiceLocator(String, org.glassfish.hk2.api.ServiceLocator, java.util.List}.
      Specified by:
      createServiceLocator in interface ModulesRegistry
      Parameters:
      name - Determines which inhabitants descriptors are loaded. (so that different parallel habitats can be created over the same modules registry.)
      Throws:
      org.glassfish.hk2.api.MultiException

    • createServiceLocator

      public org.glassfish.hk2.api.ServiceLocator createServiceLocator() throws org.glassfish.hk2.api.MultiException
      Description copied from interface: ModulesRegistry
      Creates the default ServiceLocator from all the modules in this registry Calling this method has the same effect of calling {@link #createServiceLocator("default")}
      Specified by:
      createServiceLocator in interface ModulesRegistry
      Throws:
      org.glassfish.hk2.api.MultiException

    • parseInhabitants

      protected abstract List<org.glassfish.hk2.api.ActiveDescriptor> parseInhabitants(HK2Module module, String name, org.glassfish.hk2.api.ServiceLocator serviceLocator, List<org.glassfish.hk2.api.PopulatorPostProcessor> postProcessors) throws IOException, BootException
      Throws:
      IOException
      BootException

    • addRepository

      public void addRepository(Repository repository, int weight)
      Add a new Repository to this registry. From now on the repository will be used to procure requested module not yet registered in this registry instance. Repository can be searched in a particular order (to accomodate performance requirements like looking at local repositories first), a search order (1 to 100) can be specified when adding a repository to the registry (1 is highest priority).
      Specified by:
      addRepository in interface ModulesRegistry
      Parameters:
      repository - new repository to attach to this registry
      weight - int value from 1 to 100 to specify the search order

    • addRepository

      public void addRepository(Repository repository)
      Add a new Repository to this registry. From now on the repository will be used to procure requested nodule not registered in this instance.
      Specified by:
      addRepository in interface ModulesRegistry
      Parameters:
      repository - new repository to attach to this registry

    • removeRepository

      public void removeRepository(String name)
      Remove a repository from the list of attached repositories to this instances. After this call, the Repository name will not be used to procure missing modules any longer
      Specified by:
      removeRepository in interface ModulesRegistry
      Parameters:
      name - name of the repository to remove

    • getRepository

      public Repository getRepository(String name)
      Get a repository from the list of attached repositories
      Specified by:
      getRepository in interface ModulesRegistry
      Parameters:
      name - name of the repository to return
      Returns:
      the repository or null if not found

    • makeModuleFor

      public HK2Module makeModuleFor(String name, String version) throws ResolveError
      Returns the HK2Module instance giving a name and version constraints.
      Specified by:
      makeModuleFor in interface ModulesRegistry
      Parameters:
      name - the module name
      version - the module version.
      Returns:
      the module instance or null if none can be found
      Throws:
      ResolveError - if the module dependencies cannot be resolved

    • makeModuleFor

      public HK2Module makeModuleFor(String name, String version, boolean resolve) throws ResolveError
      Description copied from interface: ModulesRegistry
      Returns the HK2Module instance giving a name and version constraints.
      Specified by:
      makeModuleFor in interface ModulesRegistry
      Parameters:
      name - the module name
      version - the module version. Caller should specify a correct version.
      resolve - should the module be resolved or not
      Returns:
      the module instance or null if none can be found
      Throws:
      ResolveError - if the module dependencies cannot be resolved

    • makeModuleFor

      public HK2Module makeModuleFor(String packageName) throws ResolveError
      Find and return a loaded HK2Module that has the package name in its list of exported interfaces.
      Specified by:
      makeModuleFor in interface ModulesRegistry
      Parameters:
      packageName - the requested implementation package name.
      Returns:
      the HK2Module instance implementing the package name or null if not found.
      Throws:
      ResolveError - if the module dependencies cannot be resolved

    • loadFromRepository

      protected HK2Module loadFromRepository(String name, String version)

    • newModule

      protected abstract HK2Module newModule(ModuleDefinition moduleDef)
      Factory method for creating new instances of HK2Module.
      Parameters:
      moduleDef - module definition of the new module to be created
      Returns:
      a new HK2Module instance

    • add

      protected void add(HK2Module newModule)
      Add a new module to this registry. Once added, the module will be available through one of the getServiceImplementor methods.
      Parameters:
      newModule - the new module

    • remove

      public void remove(HK2Module module)
      Removes a module from the registry. The module will not be accessible from this registry after this method returns.

    • getAllServiceLocators

      protected Set<org.glassfish.hk2.api.ServiceLocator> getAllServiceLocators()

    • getModules

      public Collection<HK2Module> getModules()
      Returns the list of shared Modules registered in this instance.

      The returned list will not include the modules defined in the ancestor AbstractModulesRegistryImpls.

      Specified by:
      getModules in interface ModulesRegistry
      Returns:
      an umodifiable list of loaded modules

    • getModules

      public Collection<HK2Module> getModules(String moduleName)
      Description copied from interface: ModulesRegistry
      Returns the list of shared Modules registered in this instance whose name matches the given name

      The returned list will not include the modules defined in the ancestor ModulesRegistrys.

      Specified by:
      getModules in interface ModulesRegistry
      Returns:
      an umodifiable list of loaded modules having names that match the given name

    • changed

      public void changed(HK2Module service)
      Modules can notify their registry that they have changed (classes, resources,etc...). Registries are requested to take appropriate action to make the new module available.
      Specified by:
      changed in interface ModuleChangeListener

    • add

      public HK2Module add(ModuleDefinition info) throws ResolveError
      Registers a new DefaultModuleDefinition in this registry. Using this module definition, the registry will be capable of created shared and private HK2Module instances.
      Specified by:
      add in interface ModulesRegistry
      Throws:
      ResolveError

    • add

      public HK2Module add(ModuleDefinition info, boolean resolve) throws ResolveError
      Description copied from interface: ModulesRegistry
      Registers a new DefaultModuleDefinition in this registry. Using this module definition, the registry will be capable of created shared and private HK2Module instances.
      Specified by:
      add in interface ModulesRegistry
      Parameters:
      info - ModuleDefinition representing the new module content
      resolve - should the new module be resolved or not
      Throws:
      ResolveError

    • print

      public void print(Logger logger)
      Print a Registry dump to the logger
      Specified by:
      print in interface ModulesRegistry
      Parameters:
      logger - the logger to dump on

    • getProvidersClass

      public <T> Iterable<Class<? extends T>> getProvidersClass(Class<T> serviceClass)
      Specified by:
      getProvidersClass in interface ModulesRegistry

    • getModulesProvider

      public Iterable<HK2Module> getModulesProvider(Class serviceClass)
      Returns a collection of HK2Module containing at least one implementation of the passed service interface class.
      Specified by:
      getModulesProvider in interface ModulesRegistry
      Parameters:
      serviceClass - the service interface class
      Returns:
      a collection of module

    • registerRunningService

      public <T> void registerRunningService(Class<T> serviceClass, T provider)
      Registers a running service, this is useful when other components need to have access to a provider of a service without having to create a new instance and initialize it.
      Specified by:
      registerRunningService in interface ModulesRegistry
      Parameters:
      serviceClass - the service interface
      provider - the provider of that service.

    • unregisterRunningService

      public <T> boolean unregisterRunningService(Class<T> serviceClass, T provider)
      Removes a running service, this is useful when a service instance is no longer available as a provider of a service.
      Specified by:
      unregisterRunningService in interface ModulesRegistry

    • getRunningServices

      public <T> List<T> getRunningServices(Class<T> serviceClass)
      Returns all running services implementation of the passed service interface
      Specified by:
      getRunningServices in interface ModulesRegistry
      Parameters:
      serviceClass - the service interface
      Returns:
      the list of providers of that service.

    • getProvidingModule

      public HK2Module getProvidingModule(String providerClassName)
      Description copied from interface: ModulesRegistry
      Gets the HK2Module that provides the provider of the given name.
      Specified by:
      getProvidingModule in interface ModulesRegistry

    • dumpState

      public void dumpState(PrintStream writer)
      Specified by:
      dumpState in interface ModulesRegistry