info.magnolia.rest.registry

Class EndpointDefinitionRegistry

java.lang.Object

info.magnolia.config.registry.AbstractRegistry<EndpointDefinition>

info.magnolia.rest.registry.EndpointDefinitionRegistry

All Implemented Interfaces:

info.magnolia.config.registry.DefinitionReferenceIdResolver, info.magnolia.config.registry.Registry<EndpointDefinition>

@Singleton
public class EndpointDefinitionRegistry
extends info.magnolia.config.registry.AbstractRegistry<EndpointDefinition>

Registry for REST endpoint definitions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EndpointDefinitionRegistry.RelativePathMetadataBuilder This DefinitionMetadataBuilder generates referenceId from the relative-location only.

Nested classes/interfaces inherited from interface info.magnolia.config.registry.Registry

info.magnolia.config.registry.Registry.InvalidDefinitionException, info.magnolia.config.registry.Registry.NoSuchDefinitionException

Constructor Summary

Constructors

Constructor and Description
EndpointDefinitionRegistry(info.magnolia.event.EventBus systemEventBus) Deprecated. since 2.0 use EndpointDefinitionRegistry(ModuleRegistry, EventBus) instead.
EndpointDefinitionRegistry(info.magnolia.module.ModuleRegistry moduleRegistry, info.magnolia.event.EventBus systemEventBus)

Method Summary

Modifier and Type	Method and Description
void	addDecorator(info.magnolia.config.registry.decoration.DefinitionDecorator<EndpointDefinition> decorator)
Collection<EndpointDefinition>	getAllEndpointDefinitions() Deprecated. since 2.0 use AbstractRegistry.getAllDefinitions() instead.
EndpointDefinition	getEndpointDefinition(String name) Deprecated. since 2.0 use AbstractRegistry.getProvider(String) instead.
boolean	isEndpointDefinitionRegistered(String name) Deprecated. since 2.0 use standard registry APIs instead (AbstractRegistry.getProvider(String) and DefinitionProvider.isValid()).
info.magnolia.config.registry.DefinitionMetadataBuilder	newMetadataBuilder()
protected info.magnolia.config.registry.DefinitionProvider<EndpointDefinition>	onRegister(info.magnolia.config.registry.DefinitionProvider<EndpointDefinition> provider)
void	register(info.magnolia.config.registry.DefinitionProvider<EndpointDefinition> provider)
void	removeDecorator(info.magnolia.config.registry.decoration.DefinitionDecorator<EndpointDefinition> decorator)
info.magnolia.config.registry.DefinitionType	type()
Set<info.magnolia.config.registry.DefinitionMetadata>	unregisterAndRegister(Collection<info.magnolia.config.registry.DefinitionMetadata> toRemoveIds, Collection<info.magnolia.config.registry.DefinitionProvider<EndpointDefinition>> definitionProviders)
Set<String>	unregisterAndRegister(Set<String> registeredNames, List<EndpointDefinitionProvider> providers) Deprecated. since 2.0 use unregisterAndRegister(Collection, Collection) instead.

Methods inherited from class info.magnolia.config.registry.AbstractRegistry

getAllDefinitions, getAllMetadata, getAllProviders, getDecoratedDefinitionProvider, getProvider, getProvider, getReferenceId, getRegistryMap, query, start

Methods inherited from class java.lang.Object

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

Constructor Detail

EndpointDefinitionRegistry

@Inject
public EndpointDefinitionRegistry(info.magnolia.module.ModuleRegistry moduleRegistry,
                                          @Named(value="system")
                                          info.magnolia.event.EventBus systemEventBus)

EndpointDefinitionRegistry

@Deprecated
public EndpointDefinitionRegistry(@Named(value="system")
                                              info.magnolia.event.EventBus systemEventBus)

Deprecated. since 2.0 use EndpointDefinitionRegistry(ModuleRegistry, EventBus) instead.

Method Detail

type

public info.magnolia.config.registry.DefinitionType type()

newMetadataBuilder

public info.magnolia.config.registry.DefinitionMetadataBuilder newMetadataBuilder()

register

public void register(info.magnolia.config.registry.DefinitionProvider<EndpointDefinition> provider)

Specified by:

register in interface info.magnolia.config.registry.Registry<EndpointDefinition>

Overrides:

register in class info.magnolia.config.registry.AbstractRegistry<EndpointDefinition>

onRegister

protected info.magnolia.config.registry.DefinitionProvider<EndpointDefinition> onRegister(info.magnolia.config.registry.DefinitionProvider<EndpointDefinition> provider)

Overrides:

onRegister in class info.magnolia.config.registry.AbstractRegistry<EndpointDefinition>

unregisterAndRegister

public Set<info.magnolia.config.registry.DefinitionMetadata> unregisterAndRegister(Collection<info.magnolia.config.registry.DefinitionMetadata> toRemoveIds,
                                                                                   Collection<info.magnolia.config.registry.DefinitionProvider<EndpointDefinition>> definitionProviders)

Specified by:

unregisterAndRegister in interface info.magnolia.config.registry.Registry<EndpointDefinition>

Overrides:

unregisterAndRegister in class info.magnolia.config.registry.AbstractRegistry<EndpointDefinition>

addDecorator

public void addDecorator(info.magnolia.config.registry.decoration.DefinitionDecorator<EndpointDefinition> decorator)

Specified by:

addDecorator in interface info.magnolia.config.registry.Registry<EndpointDefinition>

Overrides:

addDecorator in class info.magnolia.config.registry.AbstractRegistry<EndpointDefinition>

removeDecorator

public void removeDecorator(info.magnolia.config.registry.decoration.DefinitionDecorator<EndpointDefinition> decorator)

Specified by:

removeDecorator in interface info.magnolia.config.registry.Registry<EndpointDefinition>

Overrides:

removeDecorator in class info.magnolia.config.registry.AbstractRegistry<EndpointDefinition>

getEndpointDefinition

@Deprecated
public EndpointDefinition getEndpointDefinition(String name)
                                                     throws info.magnolia.registry.RegistrationException

Deprecated. since 2.0 use AbstractRegistry.getProvider(String) instead.

Throws:

info.magnolia.registry.RegistrationException

unregisterAndRegister

@Deprecated
public Set<String> unregisterAndRegister(Set<String> registeredNames,
                                                     List<EndpointDefinitionProvider> providers)

Deprecated. since 2.0 use unregisterAndRegister(Collection, Collection) instead.

isEndpointDefinitionRegistered

@Deprecated
public boolean isEndpointDefinitionRegistered(String name)

Deprecated. since 2.0 use standard registry APIs instead (AbstractRegistry.getProvider(String) and DefinitionProvider.isValid()).

getAllEndpointDefinitions

@Deprecated
public Collection<EndpointDefinition> getAllEndpointDefinitions()

Deprecated. since 2.0 use AbstractRegistry.getAllDefinitions() instead.