info.magnolia.ui.api.app.registry
Class AppDescriptorRegistry

java.lang.Object
  info.magnolia.ui.api.app.registry.AppDescriptorRegistry

@Singleton
public class AppDescriptorRegistry
extends Object

The central registry for AppDescriptors. Fires AppRegistryEvent when the registry changes.

See Also:

AppDescriptor, AppDescriptorProvider, AppRegistryEvent

Constructor Summary

AppDescriptorRegistry(info.magnolia.event.EventBus systemEventBus)

Method Summary

AppDescriptor	getAppDescriptor(String name)
Collection<AppDescriptor>	getAppDescriptors()
boolean	isAppDescriptorRegistered(String name)
void	register(AppDescriptorProvider provider)
void	unregister(String name)
Set<String>	unregisterAndRegister(Collection<String> namesToUnregister, Collection<AppDescriptorProvider> providersToRegister)

Methods inherited from class java.lang.Object

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

Constructor Detail

AppDescriptorRegistry

@Inject
public AppDescriptorRegistry(@Named(value="system")
                                    info.magnolia.event.EventBus systemEventBus)

Method Detail

getAppDescriptor

public AppDescriptor getAppDescriptor(String name)
                               throws info.magnolia.registry.RegistrationException

Throws:

info.magnolia.registry.RegistrationException

isAppDescriptorRegistered

public boolean isAppDescriptorRegistered(String name)

getAppDescriptors

public Collection<AppDescriptor> getAppDescriptors()

Returns:

all AppDescriptors - in case of errors it'll just deliver the ones that are properly registered and logs error's for the others.

register

public void register(AppDescriptorProvider provider)
              throws info.magnolia.registry.RegistrationException

Throws:

info.magnolia.registry.RegistrationException

unregister

public void unregister(String name)
                throws info.magnolia.registry.RegistrationException

Throws:

info.magnolia.registry.RegistrationException

unregisterAndRegister

public Set<String> unregisterAndRegister(Collection<String> namesToUnregister,
                                         Collection<AppDescriptorProvider> providersToRegister)
                                  throws info.magnolia.registry.RegistrationException

Throws:

info.magnolia.registry.RegistrationException