org.apache.tapestry5.ioc.internal
Class RegistryImpl

java.lang.Object
  org.apache.tapestry5.ioc.internal.RegistryImpl

All Implemented Interfaces:

InternalRegistry, ServiceProxyProvider, ObjectLocator, OperationTracker, Registry, RegistryShutdownHub

public class RegistryImpl
extends Object
implements Registry, InternalRegistry, ServiceProxyProvider

Constructor Summary

RegistryImpl(Collection<ModuleDef> moduleDefs, ClassFactory classFactory, PlasticProxyFactory proxyFactory, LoggerSource loggerSource)
Constructs the registry from a set of module definitions and other resources.

Method Summary

void	addRegistryShutdownListener(RegistryShutdownListener listener) Adds a listener for eventual notification.
void	addRegistryShutdownListener(Runnable listener) Adds a listener for eventual notification when the registry shuts down.
void	addRegistryWillShutdownListener(Runnable listener) Adds a listener for eventual notification.
<T> T	autobuild(Class<T> clazz) Autobuilds a class by finding the public constructor with the most parameters.
<T> T	autobuild(String description, Class<T> clazz) Preferred version of ObjectLocator.autobuild(Class) that tracks the operation using OperationTracker.invoke(String, Invokable).
void	cleanupThread() Invoked at the end of a request to discard any thread-specific information accumulated during the current request.
String	expandSymbols(String input) Given an input string that may contain symbols, returns the string with any and all symbols fully expanded.
List<ServiceAdvisor>	findAdvisorsForService(ServiceDef3 serviceDef) Searches for advisors for a particular service, returning them in order of application.
List<ServiceDecorator>	findDecoratorsForService(ServiceDef3 serviceDef) Searches for decorators for a particular service.
<K,V> Map<K,V>	getMappedConfiguration(ServiceDef3 serviceDef, Class<K> keyType, Class<V> objectType) Builds up a map of key/value pairs by invoking service contribution methods that target the service (from any module, unless the service is private).
Set<Class>	getMarkerAnnotations() Returns a Set of Annotation classes that are used as service markers.
<T> T	getObject(Class<T> objectType, AnnotationProvider annotationProvider) Obtains an object indirectly, using the MasterObjectProvider service.
<T> T	getObject(Class<T> objectType, AnnotationProvider annotationProvider, ObjectLocator locator, Module localModule) As with ObjectLocator.getObject(Class, org.apache.tapestry5.ioc.AnnotationProvider), but handles the Local annotation.
<T> List<T>	getOrderedConfiguration(ServiceDef3 serviceDef, Class<T> objectType) Builds up an ordered collection by invoking service contributor methods that target the service (from any module, unless the service is private).
<T> T	getService(Class<T> serviceInterface) Locates a service given a service interface and (optionally) some marker annotation types.
<T> T	getService(Class<T> serviceInterface, Class<? extends Annotation>... markerTypes) Locates a service given a service interface and (optionally) some marker annotation types.
<T> T	getService(String serviceId, Class<T> serviceInterface) Obtains a service via its unique service id.
ServiceLifecycle2	getServiceLifecycle(String scope) Returns a service lifecycle by service scope name.
org.slf4j.Logger	getServiceLogger(String serviceId) Returns a logger for the service, which consists of the Module's log name suffixed with a period and the service id.
<T> Collection<T>	getUnorderedConfiguration(ServiceDef3 serviceDef, Class<T> objectType) Builds up an unordered collection by invoking service contributor methods that target the service (from any module, unless the service is private).
<T> T	invoke(String description, Invokable<T> operation) Executes the operation, returning its value.
ClassFab	newClass(Class serviceInterface) Convieience for creating a new ClassFab instance using a ClassFactory.
void	performRegistryStartup() It's not unreasonable for an eagerly-loaded service to decide to start a thread, at which point we raise issues about improper publishing of the Registry instance from the RegistryImpl constructor.
Object	provideServiceProxy(String serviceId) Look up the service and return it's proxy.
<T> T	proxy(Class<T> interfaceClass, Class<? extends T> implementationClass) Creates a proxy.
<T> T	proxy(Class<T> interfaceClass, Class<? extends T> implementationClass, ObjectLocator locator) Creates a just-in-time (and possibly, live reloading) proxy for the indicated class and interface, using the provided locator to autobuild the implementationClass (when necessary).
void	run(String description, Runnable operation) Executes the operation.
void	shutdown() Shuts down a Registry instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RegistryImpl

public RegistryImpl(Collection<ModuleDef> moduleDefs,
                    ClassFactory classFactory,
                    PlasticProxyFactory proxyFactory,
                    LoggerSource loggerSource)

Constructs the registry from a set of module definitions and other resources.

Parameters:

moduleDefs - defines the modules (and builders, decorators, etc., within)

classFactory - TODO

proxyFactory - TODO

loggerSource - used to obtain Logger instances

Method Detail

performRegistryStartup

public void performRegistryStartup()

It's not unreasonable for an eagerly-loaded service to decide to start a thread, at which point we raise issues about improper publishing of the Registry instance from the RegistryImpl constructor. Moving eager loading of services out to its own method should ensure thread safety.

Specified by:

performRegistryStartup in interface Registry

getServiceLogger

public org.slf4j.Logger getServiceLogger(String serviceId)

Description copied from interface: InternalRegistry

Returns a logger for the service, which consists of the Module's log name suffixed with a period and the service id.

Specified by:

getServiceLogger in interface InternalRegistry

Returns:

the logger for the service

shutdown

public void shutdown()

Description copied from interface: Registry

Shuts down a Registry instance. Notifies all listeners that the registry has shutdown. Further method invocations on the Registry are no longer allowed, and the Registry instance should be discarded.

Specified by:

shutdown in interface Registry

See Also:

RegistryShutdownHub, RegistryShutdownListener

getService

public <T> T getService(String serviceId,
                        Class<T> serviceInterface)

Description copied from interface: ObjectLocator

Obtains a service via its unique service id. Returns the service's proxy. The service proxy implements the same interface as the actual service, and is used to instantiate the actual service only as needed (this is transparent to the application).

Specified by:

getService in interface ObjectLocator

Parameters:

serviceId - unique Service id used to locate the service object (may contain symbols, which will be expanded), case is ignored

serviceInterface - the interface implemented by the service (or an interface extended by the service interface)

Returns:

the service instance

cleanupThread

public void cleanupThread()

Description copied from interface: Registry

Invoked at the end of a request to discard any thread-specific information accumulated during the current request.

Specified by:

cleanupThread in interface Registry

See Also:

PerthreadManager, ThreadCleanupListener

getUnorderedConfiguration

public <T> Collection<T> getUnorderedConfiguration(ServiceDef3 serviceDef,
                                                   Class<T> objectType)

Description copied from interface: InternalRegistry

Builds up an unordered collection by invoking service contributor methods that target the service (from any module, unless the service is private).

Specified by:

getUnorderedConfiguration in interface InternalRegistry

Parameters:

serviceDef - defines the service for which configuration data is being assembled

objectType - identifies the type of object allowed into the collection

Returns:

the final collection

getOrderedConfiguration

public <T> List<T> getOrderedConfiguration(ServiceDef3 serviceDef,
                                           Class<T> objectType)

Description copied from interface: InternalRegistry

Builds up an ordered collection by invoking service contributor methods that target the service (from any module, unless the service is private). Once all values have been added (each with an id, and pre/post constraints), the values are ordered, null values dropped, and the final sorted list is returned.

Specified by:

getOrderedConfiguration in interface InternalRegistry

Parameters:

serviceDef - defines the service for which configuration data is being assembled

objectType - identifies the type of object allowed into the collection

Returns:

the final ordered list

getMappedConfiguration

public <K,V> Map<K,V> getMappedConfiguration(ServiceDef3 serviceDef,
                                             Class<K> keyType,
                                             Class<V> objectType)

Description copied from interface: InternalRegistry

Builds up a map of key/value pairs by invoking service contribution methods that target the service (from any module, unless the service is private). Values and keys may not be null. Invalid values (keys or values that are the wrong type, or duplicate keys) result in warnings and are ignored.

Specified by:

getMappedConfiguration in interface InternalRegistry

Parameters:

serviceDef - defines the service for which configuration data is being assembled

keyType - identifies the type of key object allowed into the map

objectType - identifies the type of value object allowed into the map

Returns:

the final ordered list

getService

public <T> T getService(Class<T> serviceInterface)

Description copied from interface: ObjectLocator

Locates a service given a service interface and (optionally) some marker annotation types. A single service must implement the service interface (which * can be hard to guarantee) and by marked by all the marker types. The search takes into account inheritance of the service interface (not the service implementation), which may result in a failure due to extra matches.

Specified by:

getService in interface ObjectLocator

Parameters:

serviceInterface - the interface the service implements

Returns:

the service's proxy

See Also:

Marker

getService

public <T> T getService(Class<T> serviceInterface,
                        Class<? extends Annotation>... markerTypes)

Description copied from interface: ObjectLocator

Locates a service given a service interface and (optionally) some marker annotation types. A single service must implement the service interface (which * can be hard to guarantee) and by marked by all the marker types. The search takes into account inheritance of the service interface (not the service implementation), which may result in a failure due to extra matches. The ability to specify marker annotation types was added in 5.3

Specified by:

getService in interface ObjectLocator

Parameters:

serviceInterface - the interface the service implements

markerTypes - Markers used to select a specific service that implements the interface

Returns:

the service's proxy

See Also:

Marker

getServiceLifecycle

public ServiceLifecycle2 getServiceLifecycle(String scope)

Description copied from interface: InternalRegistry

Returns a service lifecycle by service scope name.

Specified by:

getServiceLifecycle in interface InternalRegistry

Parameters:

scope - the name of the service scope (case insensitive)

Returns:

the lifecycle corresponding to the scope

findDecoratorsForService

public List<ServiceDecorator> findDecoratorsForService(ServiceDef3 serviceDef)

Description copied from interface: InternalRegistry

Searches for decorators for a particular service. The resulting DecoratorDef s are ordered, then converted into ServiceDecorators.

Specified by:

findDecoratorsForService in interface InternalRegistry

findAdvisorsForService

public List<ServiceAdvisor> findAdvisorsForService(ServiceDef3 serviceDef)

Description copied from interface: InternalRegistry

Searches for advisors for a particular service, returning them in order of application.

Specified by:

findAdvisorsForService in interface InternalRegistry

newClass

public ClassFab newClass(Class serviceInterface)

Description copied from interface: InternalRegistry

Convieience for creating a new ClassFab instance using a ClassFactory.

Specified by:

newClass in interface InternalRegistry

Parameters:

serviceInterface - the interface to be implemented by the provided class

getObject

public <T> T getObject(Class<T> objectType,
                       AnnotationProvider annotationProvider,
                       ObjectLocator locator,
                       Module localModule)

Description copied from interface: InternalRegistry

As with ObjectLocator.getObject(Class, org.apache.tapestry5.ioc.AnnotationProvider), but handles the Local annotation.

Specified by:

getObject in interface InternalRegistry

Parameters:

objectType - type of object o be injected

annotationProvider - access to annotations at point of injection

locator - used to resolve any subsequent injections

localModule - module to limit services to, if Local annotaton present

Returns:

the service or object

getObject

public <T> T getObject(Class<T> objectType,
                       AnnotationProvider annotationProvider)

Description copied from interface: ObjectLocator

Obtains an object indirectly, using the MasterObjectProvider service.

Specified by:

getObject in interface ObjectLocator

Parameters:

objectType - the type of object to be returned

annotationProvider - provides access to annotations on the field or parameter for which a value is to be obtained, which may be utilized in selecting an appropriate object, use null when annotations are not available (in which case, selection will be based only on the object type)

Returns:

the requested object

See Also:

ObjectProvider

addRegistryShutdownListener

public void addRegistryShutdownListener(RegistryShutdownListener listener)

Description copied from interface: RegistryShutdownHub

Adds a listener for eventual notification.

Specified by:

addRegistryShutdownListener in interface RegistryShutdownHub

addRegistryShutdownListener

public void addRegistryShutdownListener(Runnable listener)

Description copied from interface: RegistryShutdownHub

Adds a listener for eventual notification when the registry shuts down. Runtime exceptions thrown by the listener will be logged and ignored.

Specified by:

addRegistryShutdownListener in interface RegistryShutdownHub

addRegistryWillShutdownListener

public void addRegistryWillShutdownListener(Runnable listener)

Description copied from interface: RegistryShutdownHub

Adds a listener for eventual notification. RegistryWillShutdownListeners are notified before any standard listeners, and before service proxies and other parts of the Registry are disabled. Runtime exceptions thrown by the listener will be logged and ignored.

Specified by:

addRegistryWillShutdownListener in interface RegistryShutdownHub

expandSymbols

public String expandSymbols(String input)

Description copied from interface: InternalRegistry

Given an input string that may contain symbols, returns the string with any and all symbols fully expanded.

Specified by:

expandSymbols in interface InternalRegistry

Returns:

expanded input

autobuild

public <T> T autobuild(String description,
                       Class<T> clazz)

Description copied from interface: ObjectLocator

Preferred version of ObjectLocator.autobuild(Class) that tracks the operation using OperationTracker.invoke(String, Invokable).

Specified by:

autobuild in interface ObjectLocator

Parameters:

description - description used with OperationTracker

clazz - the type of object to instantiate

Returns:

the instantiated instance

See Also:

MasterObjectProvider

autobuild

public <T> T autobuild(Class<T> clazz)

Description copied from interface: ObjectLocator

Autobuilds a class by finding the public constructor with the most parameters. Services and other resources or dependencies will be injected into the parameters of the constructor and into private fields marked with the Inject annotation. There are two cases: constructing a service implementation, and constructing an arbitrary object. In the former case, many service resources are also available for injection, not just dependencies or objects provided via MasterObjectProvider.provide(Class, AnnotationProvider, ObjectLocator, boolean).

Specified by:

autobuild in interface ObjectLocator

Parameters:

clazz - the type of object to instantiate

Returns:

the instantiated instance

See Also:

MasterObjectProvider

proxy

public <T> T proxy(Class<T> interfaceClass,
                   Class<? extends T> implementationClass)

Description copied from interface: ObjectLocator

Creates a proxy. The proxy will defer invocation of ObjectLocator.autobuild(Class) until just-in-time (that is, first method invocation). In a limited number of cases, it is necessary to use such a proxy to prevent service construction cycles, particularly when contributing (directly or indirectly) to the MasterObjectProvider (which is itself at the heart of autobuilding).

If the class file for the class is a file on the file system (not a file packaged in a JAR), then the proxy will autoreload: changing the class file will result in the new class being reloaded and re-instantiated (with dependencies).

Specified by:

proxy in interface ObjectLocator

Parameters:

interfaceClass - the interface implemented by the proxy

implementationClass - a concrete class that implements the interface

Returns:

a proxy

See Also:

ObjectLocator.autobuild(Class)

proxy

public <T> T proxy(Class<T> interfaceClass,
                   Class<? extends T> implementationClass,
                   ObjectLocator locator)

Description copied from interface: InternalRegistry

Creates a just-in-time (and possibly, live reloading) proxy for the indicated class and interface, using the provided locator to autobuild the implementationClass (when necessary).

Specified by:

proxy in interface InternalRegistry

provideServiceProxy

public Object provideServiceProxy(String serviceId)

Description copied from interface: ServiceProxyProvider

Look up the service and return it's proxy.

Specified by:

provideServiceProxy in interface ServiceProxyProvider

Parameters:

serviceId - the id of the service to obtain

Returns:

the service proxy

run

public void run(String description,
                Runnable operation)

Description copied from interface: OperationTracker

Executes the operation.

Specified by:

run in interface OperationTracker

Parameters:

description - used if there is an exception

operation - to execute

invoke

public <T> T invoke(String description,
                    Invokable<T> operation)

Description copied from interface: OperationTracker

Executes the operation, returning its value.

Specified by:

invoke in interface OperationTracker

Parameters:

description - used if there is an exception

operation - to invoke

Returns:

result of operation

getMarkerAnnotations

public Set<Class> getMarkerAnnotations()

Description copied from interface: InternalRegistry

Returns a Set of Annotation classes that are used as service markers.

Specified by:

getMarkerAnnotations in interface InternalRegistry