A B C D E G I N O R S T U V

A

AbstractEndpoint<D extends EndpointDefinition> - Class in info.magnolia.rest

Convenience class for rest endpoints.

AbstractEndpoint(D) - Constructor for class info.magnolia.rest.AbstractEndpoint

addDecorator(DefinitionDecorator<EndpointDefinition>) - Method in class info.magnolia.rest.registry.EndpointDefinitionRegistry

AdditionalProviderDefinition - Interface in info.magnolia.rest.provider

Additional provider that can be registered with RestDispatcherServlet.

B

buildReferenceId() - Method in class info.magnolia.rest.registry.EndpointDefinitionRegistry.RelativePathMetadataBuilder

C

ConfiguredAdditionalProviderDefinition - Class in info.magnolia.rest.provider

Additional provider that can be registered with RestDispatcherServlet.

ConfiguredAdditionalProviderDefinition() - Constructor for class info.magnolia.rest.provider.ConfiguredAdditionalProviderDefinition

ConfiguredEndpointDefinition - Class in info.magnolia.rest.registry

Configured endpoint definition.

ConfiguredEndpointDefinition() - Constructor for class info.magnolia.rest.registry.ConfiguredEndpointDefinition

ConfiguredEndpointDefinitionManager - Class in info.magnolia.rest.registry

Deprecated.

since 2.0, replaced by RegistryBasedObservingManager, within JcrConfigurationSource

ConfiguredEndpointDefinitionManager() - Constructor for class info.magnolia.rest.registry.ConfiguredEndpointDefinitionManager

Deprecated.

ConfiguredEndpointDefinitionProvider - Class in info.magnolia.rest.registry

Deprecated.

since 2.0 use DefinitionProvider instead.

ConfiguredEndpointDefinitionProvider(String, Node) - Constructor for class info.magnolia.rest.registry.ConfiguredEndpointDefinitionProvider

Deprecated.

configureDeployment(ResteasyDeployment) - Method in class info.magnolia.rest.RestDispatcherServlet

createBootstrap(ServletConfig) - Method in class info.magnolia.rest.RestDispatcherServlet

D

destroy() - Method in class info.magnolia.rest.RestDispatcherServlet

destroy() - Method in class info.magnolia.rest.RestJerseyDispatcherServlet

dispatch(EndpointDefinitionRegistryEventHandler) - Method in class info.magnolia.rest.registry.EndpointDefinitionRegistryEvent

DynamicPath - Annotation Type in info.magnolia.rest

Identifies REST endpoints for which Magnolia computes the endpoint base-path from config, dynamically at runtime.

E

EndpointDefinition - Interface in info.magnolia.rest

Definition of a REST endpoint.

EndpointDefinitionProvider - Interface in info.magnolia.rest.registry

Deprecated.

since 2.0 use DefinitionProvider instead.

EndpointDefinitionRegistry - Class in info.magnolia.rest.registry

Registry for REST endpoint definitions.

EndpointDefinitionRegistry(ModuleRegistry, EventBus) - Constructor for class info.magnolia.rest.registry.EndpointDefinitionRegistry

EndpointDefinitionRegistry(EventBus) - Constructor for class info.magnolia.rest.registry.EndpointDefinitionRegistry

Deprecated.

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

EndpointDefinitionRegistry.RelativePathMetadataBuilder - Class in info.magnolia.rest.registry

This DefinitionMetadataBuilder generates referenceId from the relative-location only.

EndpointDefinitionRegistryEvent - Class in info.magnolia.rest.registry

Event fired by EndpointDefinitionRegistry when endpoint definitions are added, removed or changed.

EndpointDefinitionRegistryEvent(EndpointDefinitionRegistryEventType, DefinitionProvider<EndpointDefinition>) - Constructor for class info.magnolia.rest.registry.EndpointDefinitionRegistryEvent

EndpointDefinitionRegistryEvent(EndpointDefinitionRegistryEventType, String) - Constructor for class info.magnolia.rest.registry.EndpointDefinitionRegistryEvent

EndpointDefinitionRegistryEvent(EndpointDefinitionRegistryEventType, EndpointDefinition) - Constructor for class info.magnolia.rest.registry.EndpointDefinitionRegistryEvent

Deprecated.

since 2.0, use EndpointDefinitionRegistryEvent.EndpointDefinitionRegistryEvent(EndpointDefinitionRegistryEventType, DefinitionProvider)

EndpointDefinitionRegistryEventHandler - Interface in info.magnolia.rest.registry

Event handler for endpoint registrations.

EndpointDefinitionRegistryEventType - Enum in info.magnolia.rest.registry

Enumeration of events fired by EndpointDefinitionRegistry.

ErrorContainer() - Constructor for class info.magnolia.rest.RestError.ErrorContainer

ErrorContainer(String, String) - Constructor for class info.magnolia.rest.RestError.ErrorContainer

G

getAdditionalProviders() - Method in class info.magnolia.rest.RestIntegrationModule

getAllEndpointDefinitions() - Method in class info.magnolia.rest.registry.EndpointDefinitionRegistry

Deprecated.

since 2.0 use AbstractRegistry.getAllDefinitions() instead.

getApplication() - Method in class info.magnolia.rest.RestDispatcherServlet

getBasePath(String) - Method in class info.magnolia.rest.RestDispatcherServlet

Extract base path from preference id and definition path.

getBasePath(String) - Method in class info.magnolia.rest.RestJerseyDispatcherServlet

Extract base path from preference id and definition path.

getCode() - Method in class info.magnolia.rest.RestError.ErrorContainer

getEndpointDefinition() - Method in class info.magnolia.rest.AbstractEndpoint

getEndpointDefinition() - Method in class info.magnolia.rest.registry.ConfiguredEndpointDefinitionProvider

Deprecated.

getEndpointDefinition() - Method in interface info.magnolia.rest.registry.EndpointDefinitionProvider

Deprecated.

getEndpointDefinition(String) - Method in class info.magnolia.rest.registry.EndpointDefinitionRegistry

Deprecated.

since 2.0 use AbstractRegistry.getProvider(String) instead.

getEndpointDefinition() - Method in class info.magnolia.rest.registry.EndpointDefinitionRegistryEvent

Deprecated.

since 2.0, use EndpointDefinitionRegistryEvent.getEndpointDefinitionProvider()

getEndpointDefinitionProvider() - Method in class info.magnolia.rest.registry.EndpointDefinitionRegistryEvent

getEndpointName() - Method in class info.magnolia.rest.registry.EndpointDefinitionRegistryEvent

getEndpointPath() - Method in interface info.magnolia.rest.EndpointDefinition

getEndpointPath() - Method in class info.magnolia.rest.registry.ConfiguredEndpointDefinition

getErrorContainer() - Method in class info.magnolia.rest.RestError

getExtraInstallTasks(InstallContext) - Method in class info.magnolia.rest.setup.RestIntegrationModuleVersionHandler

getImplementationClass() - Method in interface info.magnolia.rest.EndpointDefinition

getImplementationClass() - Method in class info.magnolia.rest.registry.ConfiguredEndpointDefinition

getMessage() - Method in class info.magnolia.rest.RestError.ErrorContainer

getName() - Method in interface info.magnolia.rest.EndpointDefinition

getName() - Method in class info.magnolia.rest.registry.ConfiguredEndpointDefinition

getName() - Method in class info.magnolia.rest.registry.ConfiguredEndpointDefinitionProvider

Deprecated.

getName() - Method in interface info.magnolia.rest.registry.EndpointDefinitionProvider

Deprecated.

getProviderClass() - Method in interface info.magnolia.rest.provider.AdditionalProviderDefinition

getProviderClass() - Method in class info.magnolia.rest.provider.ConfiguredAdditionalProviderDefinition

getServletConfig() - Method in class info.magnolia.rest.RestDispatcherServlet

getType() - Method in class info.magnolia.rest.registry.EndpointDefinitionRegistryEvent

I

info.magnolia.rest - package info.magnolia.rest

info.magnolia.rest.provider - package info.magnolia.rest.provider

info.magnolia.rest.registry - package info.magnolia.rest.registry

info.magnolia.rest.setup - package info.magnolia.rest.setup

init(ServletConfig) - Method in class info.magnolia.rest.RestDispatcherServlet

init(WebConfig) - Method in class info.magnolia.rest.RestJerseyDispatcherServlet

instantiateEndpoint(EndpointDefinition) - Method in class info.magnolia.rest.RestDispatcherServlet

instantiateEndpoint(EndpointDefinition) - Method in class info.magnolia.rest.RestJerseyDispatcherServlet

isEnabled() - Method in interface info.magnolia.rest.EndpointDefinition

isEnabled() - Method in class info.magnolia.rest.registry.ConfiguredEndpointDefinition

isEndpointDefinitionRegistered(String) - Method in class info.magnolia.rest.registry.EndpointDefinitionRegistry

Deprecated.

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

N

newMetadataBuilder() - Method in class info.magnolia.rest.registry.EndpointDefinitionRegistry

O

onEndpointRegistered(EndpointDefinitionRegistryEvent) - Method in interface info.magnolia.rest.registry.EndpointDefinitionRegistryEventHandler

Called when an endpoint definition has been added to the registry.

onEndpointRegistered(EndpointDefinitionRegistryEvent) - Method in class info.magnolia.rest.RestDispatcherServlet

onEndpointRegistered(EndpointDefinitionRegistryEvent) - Method in class info.magnolia.rest.RestJerseyDispatcherServlet

onEndpointReregistered(EndpointDefinitionRegistryEvent) - Method in interface info.magnolia.rest.registry.EndpointDefinitionRegistryEventHandler

Called when an endpoint definition has been changed.

onEndpointReregistered(EndpointDefinitionRegistryEvent) - Method in class info.magnolia.rest.RestDispatcherServlet

onEndpointReregistered(EndpointDefinitionRegistryEvent) - Method in class info.magnolia.rest.RestJerseyDispatcherServlet

onEndpointUnregistered(EndpointDefinitionRegistryEvent) - Method in interface info.magnolia.rest.registry.EndpointDefinitionRegistryEventHandler

Called when an endpoint definition has been removed.

onEndpointUnregistered(EndpointDefinitionRegistryEvent) - Method in class info.magnolia.rest.RestDispatcherServlet

onEndpointUnregistered(EndpointDefinitionRegistryEvent) - Method in class info.magnolia.rest.RestJerseyDispatcherServlet

onRegister(DefinitionProvider<EndpointDefinition>) - Method in class info.magnolia.rest.registry.EndpointDefinitionRegistry

R

register(DefinitionProvider<EndpointDefinition>) - Method in class info.magnolia.rest.registry.EndpointDefinitionRegistry

registerEndpoint(EndpointDefinition) - Method in class info.magnolia.rest.RestDispatcherServlet

Allows an endpoint to be registered for the servlet without actually being in the registry.

registerEndpoint(DefinitionProvider<EndpointDefinition>) - Method in class info.magnolia.rest.RestDispatcherServlet

registerEndpoint(DefinitionProvider<EndpointDefinition>, ResourceConfig) - Method in class info.magnolia.rest.RestJerseyDispatcherServlet

RelativePathMetadataBuilder() - Constructor for class info.magnolia.rest.registry.EndpointDefinitionRegistry.RelativePathMetadataBuilder

reload(List<Node>) - Method in class info.magnolia.rest.registry.ConfiguredEndpointDefinitionManager

Deprecated.

removeDecorator(DefinitionDecorator<EndpointDefinition>) - Method in class info.magnolia.rest.registry.EndpointDefinitionRegistry

RepositoryExceptionMapper - Class in info.magnolia.rest

Repository exception mapper.

RepositoryExceptionMapper() - Constructor for class info.magnolia.rest.RepositoryExceptionMapper

REST_ENDPOINTS_CONFIG_NODE_NAME - Static variable in class info.magnolia.rest.registry.ConfiguredEndpointDefinitionManager

Deprecated.

RestDispatcherServlet - Class in info.magnolia.rest

Dispatcher of the rest requests to the dynamically registered endpoints.

RestDispatcherServlet(RestIntegrationModule, EndpointDefinitionRegistry, EventBus, ComponentProvider) - Constructor for class info.magnolia.rest.RestDispatcherServlet

RestDispatcherServlet(RestIntegrationModule, EndpointDefinitionRegistry, EventBus) - Constructor for class info.magnolia.rest.RestDispatcherServlet

Deprecated.

RestError - Class in info.magnolia.rest

This class is an error response entity and created to mainly support for delivery endpoint.

RestError() - Constructor for class info.magnolia.rest.RestError

RestError(String, String) - Constructor for class info.magnolia.rest.RestError

RestError.ErrorContainer - Class in info.magnolia.rest

Error container.

RestExceptionMapper - Class in info.magnolia.rest

Maps exceptions encountered to response status codes.

RestExceptionMapper() - Constructor for class info.magnolia.rest.RestExceptionMapper

RestIntegrationModule - Class in info.magnolia.rest

The REST integration module binds JCR and YAML configuration sources to the EndpointDefinitionRegistry, as well as supports additional resteasy providers.

RestIntegrationModule(ConfigurationSourceFactory, EndpointDefinitionRegistry) - Constructor for class info.magnolia.rest.RestIntegrationModule

RestIntegrationModule(ConfiguredEndpointDefinitionManager) - Constructor for class info.magnolia.rest.RestIntegrationModule

Deprecated.

since 2.0 use RestIntegrationModule.RestIntegrationModule(ConfigurationSourceFactory, EndpointDefinitionRegistry) instead.

RestIntegrationModuleVersionHandler - Class in info.magnolia.rest.setup

Module version handler of RestIntegrationModule.

RestIntegrationModuleVersionHandler() - Constructor for class info.magnolia.rest.setup.RestIntegrationModuleVersionHandler

RestJerseyDispatcherServlet - Class in info.magnolia.rest

Custom Jersey Dispatcher which handles endpoint registrations.

RestJerseyDispatcherServlet(RestIntegrationModule, EndpointDefinitionRegistry, EventBus, ComponentProvider) - Constructor for class info.magnolia.rest.RestJerseyDispatcherServlet

RuntimeRepositoryExceptionMapper - Class in info.magnolia.rest

Runtime repository exception mapper.

RuntimeRepositoryExceptionMapper() - Constructor for class info.magnolia.rest.RuntimeRepositoryExceptionMapper

S

setAdditionalProviders(List<AdditionalProviderDefinition>) - Method in class info.magnolia.rest.RestIntegrationModule

setEnabled(boolean) - Method in class info.magnolia.rest.registry.ConfiguredEndpointDefinition

setEndpointPath(String) - Method in class info.magnolia.rest.registry.ConfiguredEndpointDefinition

setImplementationClass(Class<?>) - Method in class info.magnolia.rest.registry.ConfiguredEndpointDefinition

setName(String) - Method in class info.magnolia.rest.registry.ConfiguredEndpointDefinition

setProviderClass(Class<?>) - Method in class info.magnolia.rest.provider.ConfiguredAdditionalProviderDefinition

start() - Method in class info.magnolia.rest.registry.ConfiguredEndpointDefinitionManager

Deprecated.

start(ModuleLifecycleContext) - Method in class info.magnolia.rest.RestIntegrationModule

stop(ModuleLifecycleContext) - Method in class info.magnolia.rest.RestIntegrationModule

T

toResponse(RepositoryException) - Method in class info.magnolia.rest.RepositoryExceptionMapper

toResponse(Throwable) - Method in class info.magnolia.rest.RestExceptionMapper

toResponse(RuntimeRepositoryException) - Method in class info.magnolia.rest.RuntimeRepositoryExceptionMapper

type() - Method in class info.magnolia.rest.registry.EndpointDefinitionRegistry

U

unregisterAndRegister(Collection<DefinitionMetadata>, Collection<DefinitionProvider<EndpointDefinition>>) - Method in class info.magnolia.rest.registry.EndpointDefinitionRegistry

unregisterAndRegister(Set<String>, List<EndpointDefinitionProvider>) - Method in class info.magnolia.rest.registry.EndpointDefinitionRegistry

Deprecated.

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

unregisterEndpoint(String) - Method in class info.magnolia.rest.RestDispatcherServlet

unregisterEndpoint(String) - Method in class info.magnolia.rest.RestJerseyDispatcherServlet

V

valueOf(String) - Static method in enum info.magnolia.rest.registry.EndpointDefinitionRegistryEventType

Returns the enum constant of this type with the specified name.

values() - Static method in enum info.magnolia.rest.registry.EndpointDefinitionRegistryEventType

Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E G I N O R S T U V