info.magnolia.rest

Class RestJerseyDispatcherServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.glassfish.jersey.servlet.ServletContainer

info.magnolia.rest.RestJerseyDispatcherServlet

All Implemented Interfaces:

info.magnolia.event.EventHandler, EndpointDefinitionRegistryEventHandler, Serializable, javax.servlet.Filter, javax.servlet.Servlet, javax.servlet.ServletConfig, org.glassfish.jersey.server.spi.Container

public class RestJerseyDispatcherServlet
extends org.glassfish.jersey.servlet.ServletContainer
implements EndpointDefinitionRegistryEventHandler

Custom Jersey Dispatcher which handles endpoint registrations.

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.glassfish.jersey.server.spi.Container

DEFAULT_HTTP_PORT, DEFAULT_HTTPS_PORT

Constructor Summary

Constructors

Constructor and Description
RestJerseyDispatcherServlet(RestIntegrationModule restIntegrationModule, EndpointDefinitionRegistry endpointRegistry, info.magnolia.event.EventBus systemEventBus, info.magnolia.objectfactory.ComponentProvider componentProvider)

Method Summary

Modifier and Type	Method and Description
void	destroy()
protected String	getBasePath(String endpointReferenceId) Extract base path from preference id and definition path.
void	init(org.glassfish.jersey.servlet.WebConfig webConfig)
protected Object	instantiateEndpoint(EndpointDefinition endpointDefinition)
void	onEndpointRegistered(EndpointDefinitionRegistryEvent event) Called when an endpoint definition has been added to the registry.
void	onEndpointReregistered(EndpointDefinitionRegistryEvent event) Called when an endpoint definition has been changed.
void	onEndpointUnregistered(EndpointDefinitionRegistryEvent event) Called when an endpoint definition has been removed.
protected Object	registerEndpoint(info.magnolia.config.registry.DefinitionProvider<EndpointDefinition> provider, org.glassfish.jersey.server.ResourceConfig config)
protected void	unregisterEndpoint(String endpointReferenceId)

Methods inherited from class org.glassfish.jersey.servlet.ServletContainer

doFilter, doFilter, getApplicationHandler, getConfiguration, getServletContext, getStaticContentPattern, getWebComponent, init, init, reload, reload, service, service, service

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

RestJerseyDispatcherServlet

@Inject
public RestJerseyDispatcherServlet(RestIntegrationModule restIntegrationModule,
                                           EndpointDefinitionRegistry endpointRegistry,
                                           @Named(value="system")
                                           info.magnolia.event.EventBus systemEventBus,
                                           info.magnolia.objectfactory.ComponentProvider componentProvider)

Method Detail

init

public void init(org.glassfish.jersey.servlet.WebConfig webConfig)
          throws javax.servlet.ServletException

Overrides:

init in class org.glassfish.jersey.servlet.ServletContainer

Throws:

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class org.glassfish.jersey.servlet.ServletContainer

onEndpointRegistered

public void onEndpointRegistered(EndpointDefinitionRegistryEvent event)

Description copied from interface: EndpointDefinitionRegistryEventHandler

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

Specified by:

onEndpointRegistered in interface EndpointDefinitionRegistryEventHandler

onEndpointReregistered

public void onEndpointReregistered(EndpointDefinitionRegistryEvent event)

Description copied from interface: EndpointDefinitionRegistryEventHandler

Called when an endpoint definition has been changed.

Specified by:

onEndpointReregistered in interface EndpointDefinitionRegistryEventHandler

onEndpointUnregistered

public void onEndpointUnregistered(EndpointDefinitionRegistryEvent event)

Description copied from interface: EndpointDefinitionRegistryEventHandler

Called when an endpoint definition has been removed. The event contains only the name of the endpoint.

Specified by:

onEndpointUnregistered in interface EndpointDefinitionRegistryEventHandler

registerEndpoint

protected Object registerEndpoint(info.magnolia.config.registry.DefinitionProvider<EndpointDefinition> provider,
                                  org.glassfish.jersey.server.ResourceConfig config)

unregisterEndpoint

protected void unregisterEndpoint(String endpointReferenceId)

instantiateEndpoint

protected Object instantiateEndpoint(EndpointDefinition endpointDefinition)

getBasePath

protected String getBasePath(String endpointReferenceId)

Extract base path from preference id and definition path. Only applicable for DynamicPath annotated endpoint class. Convention: /module_name/restEndpoints/p1/p2/p3/def_v1.yaml -> {context}/p1/p2/p3/def/v1 /module_name/restEndpoints/p1/p2/p3/defv1.yaml -> {context}/p1/p2/p3/defv1 /module_name/restEndpoints/def_v1.yaml -> {context}/def/v1 /module_name/restEndpoints/defv1.yaml -> {context}/defv1

Returns:

base path