io.neba.core.resourcemodels.registration

Class ModelRegistry

java.lang.Object

io.neba.core.resourcemodels.registration.ModelRegistry

@Service
public class ModelRegistry
extends Object

Contains model sources associated to mappable types and the corresponding logic to lookup these relationships.

Author:

Olaf Otto

Constructor Summary

Constructors

Constructor and Description
ModelRegistry()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(String[] types, OsgiBeanSource<?> source) Adds the type[] -&t; model relationship to the registry.
List<OsgiBeanSource<?>>	getBeanSources()
Map<String,Collection<OsgiBeanSource<?>>>	getTypeMappings()
Collection<LookupResult>	lookupAllModels(org.apache.sling.api.resource.Resource resource) Finds the all models for the given Resource, i.e.
Collection<LookupResult>	lookupMostSpecificModels(org.apache.sling.api.resource.Resource resource) Finds the most specific models for the given Resource, i.e.
Collection<LookupResult>	lookupMostSpecificModels(org.apache.sling.api.resource.Resource resource, Class<?> targetType) Finds the most specific models for the given resource which are assignable to the target type.
Collection<LookupResult>	lookupMostSpecificModels(org.apache.sling.api.resource.Resource resource, String beanName) Finds the most specific models for the given Resource.
void	removeInvalidReferences() Checks whether the sources of all resource models are still valid.
void	removeResourceModels(org.osgi.framework.Bundle bundle) Removes all resource models originating from the given bundle from this registry.
void	shutdown() Clears the registry upon shutdown.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelRegistry

public ModelRegistry()

Method Detail

lookupMostSpecificModels

public Collection<LookupResult> lookupMostSpecificModels(org.apache.sling.api.resource.Resource resource,
                                                String beanName)

Finds the most specific models for the given Resource. The model's bean name must match the provided bean name.

Parameters:

resource - must not be null.

beanName - must not be null.

Returns:

the resolved models, or null if no such models exist.

lookupMostSpecificModels

public Collection<LookupResult> lookupMostSpecificModels(org.apache.sling.api.resource.Resource resource)

Finds the most specific models for the given Resource, i.e. the first model(s) found when traversing the resource's mappable hierarchy.

Parameters:

resource - must not be null.

Returns:

the model sources, or null if no models exist for the resource.

lookupAllModels

public Collection<LookupResult> lookupAllModels(org.apache.sling.api.resource.Resource resource)

Finds the all models for the given Resource, i.e. the all model(s) found when traversing the resource's mappable hierarchy.

Parameters:

resource - must not be null.

Returns:

the model sources, or null if no models exist for the resource.

lookupMostSpecificModels

public Collection<LookupResult> lookupMostSpecificModels(org.apache.sling.api.resource.Resource resource,
                                                Class<?> targetType)

Finds the most specific models for the given resource which are assignable to the target type.

Parameters:

resource - must not be null.

targetType - must not be null.

Returns:

the sources of the models, or null if no such model exists.

shutdown

@PreDestroy
public void shutdown()

Clears the registry upon shutdown.

removeResourceModels

public void removeResourceModels(org.osgi.framework.Bundle bundle)

Removes all resource models originating from the given bundle from this registry.

Parameters:

bundle - must not be null.

getBeanSources

public List<OsgiBeanSource<?>> getBeanSources()

Returns:

a shallow copy of all registered sources for models, never null but rather an empty list.

add

public void add(String[] types,
       OsgiBeanSource<?> source)

Adds the type[] -&t; model relationship to the registry.

Parameters:

types - must not be null.

source - must not be null.

getTypeMappings

public Map<String,Collection<OsgiBeanSource<?>>> getTypeMappings()

Returns:

all type -> model mappings.

removeInvalidReferences

@Scheduled(fixedRate=30000L)
public void removeInvalidReferences()

Checks whether the sources of all resource models are still valid. If not, the corresponding model(s) are removed from the registry.