org.hippoecm.hst.jaxrs

Class AbstractJaxrsService

java.lang.Object

org.hippoecm.hst.jaxrs.AbstractJaxrsService

All Implemented Interfaces:

JAXRSService

Direct Known Subclasses:

CXFJaxrsService

public abstract class AbstractJaxrsService
extends Object
implements JAXRSService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractJaxrsService.PathsAdjustedHttpServletRequestWrapper
protected static class	AbstractJaxrsService.ServletConfigImpl

Field Summary

Fields inherited from interface org.hippoecm.hst.jaxrs.JAXRSService

REQUEST_CONTENT_PATH_KEY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractJaxrsService(String serviceName, Map<String,String> jaxrsConfigParameters)

Method Summary

Modifier and Type	Method and Description
void	destroy()
protected List<Class<? extends HippoBean>>	getAnnotatedClasses(HstRequestContext requestContext) Deprecated. since 2.28.00 not used any more. If custom annotated classes are needed, inject a custom object converter in the HstRequestContext through ContentBeansTool. This method does not do anything any more
String	getAnnotatedClassesResourcePath() Deprecated. since 2.28.00 not used any more. If custom annotated classes are needed, inject a custom object converter in the HstRequestContext through ContentBeansTool. This method does not do anything any more
protected javax.jcr.Node	getContentNode(javax.jcr.Session session, String path)
protected abstract String	getJaxrsPathInfo(HstRequestContext requestContext, javax.servlet.http.HttpServletRequest request) Concrete implementations must implement this method to get the jaxrs pathInfo.
protected javax.servlet.http.HttpServletRequest	getJaxrsRequest(HstRequestContext requestContext, javax.servlet.http.HttpServletRequest request)
protected javax.servlet.ServletConfig	getJaxrsServletConfig(javax.servlet.ServletContext servletContext)
protected String	getJaxrsServletPath(HstRequestContext requestContext)
protected String	getMountContentPath(HstRequestContext requestContext)
protected ObjectConverter	getObjectConverter(HstRequestContext requestContext)
HippoBean	getRequestContentBean(HstRequestContext requestContext) Returns the content HippoBean for the current request.
<T extends HippoBean> T	getRequestContentBean(HstRequestContext requestContext, Class<T> beanMappingClass) Returns the content HippoBean of type T for the current request.
String	getServletPath()
HippoFolderBean	getSiteContentBaseBean(HstRequestContext requestContext)
void	initialize()
abstract void	invoke(HstRequestContext requestContext, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	setAnnotatedClasses(List<Class<? extends HippoBean>> annotatedClasses) Deprecated. since 2.28.00 not used any more. If custom annotated classes are needed, inject a custom object converter in the HstRequestContext through ContentBeansTool. This method does not do anything any more
void	setAnnotatedClassesResourcePath(String annotatedClassesResourcePath) Deprecated. since 2.28.00 not used any more. If custom annotated classes are needed, inject a custom object converter in the HstRequestContext through ContentBeansTool. This method does not do anything any more
void	setObjectConverter(ObjectConverter objectConverter) Deprecated. since 2.28.00 not used any more. If custom object converter is needed, inject a custom object converter in the HstRequestContext through ContentBeansTool. This method does not do anything any more
void	setServletPath(String servletPath)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractJaxrsService

protected AbstractJaxrsService(String serviceName,
                               Map<String,String> jaxrsConfigParameters)

Method Detail

getServletPath

public String getServletPath()

setServletPath

public void setServletPath(String servletPath)

getAnnotatedClassesResourcePath

@Deprecated
public String getAnnotatedClassesResourcePath()

Deprecated. since 2.28.00 not used any more. If custom annotated classes are needed, inject a custom object converter in the HstRequestContext through ContentBeansTool. This method does not do anything any more

setAnnotatedClassesResourcePath

@Deprecated
public void setAnnotatedClassesResourcePath(String annotatedClassesResourcePath)

Deprecated. since 2.28.00 not used any more. If custom annotated classes are needed, inject a custom object converter in the HstRequestContext through ContentBeansTool. This method does not do anything any more

setAnnotatedClasses

@Deprecated
public void setAnnotatedClasses(List<Class<? extends HippoBean>> annotatedClasses)

Deprecated. since 2.28.00 not used any more. If custom annotated classes are needed, inject a custom object converter in the HstRequestContext through ContentBeansTool. This method does not do anything any more

setObjectConverter

@Deprecated
public void setObjectConverter(ObjectConverter objectConverter)

Deprecated. since 2.28.00 not used any more. If custom object converter is needed, inject a custom object converter in the HstRequestContext through ContentBeansTool. This method does not do anything any more

getAnnotatedClasses

@Deprecated
protected List<Class<? extends HippoBean>> getAnnotatedClasses(HstRequestContext requestContext)

Deprecated. since 2.28.00 not used any more. If custom annotated classes are needed, inject a custom object converter in the HstRequestContext through ContentBeansTool. This method does not do anything any more

getObjectConverter

protected ObjectConverter getObjectConverter(HstRequestContext requestContext)

initialize

public void initialize()
                throws ContainerException

Specified by:

initialize in interface JAXRSService

Throws:

ContainerException

invoke

public abstract void invoke(HstRequestContext requestContext,
                            javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response)
                     throws ContainerException

Specified by:

invoke in interface JAXRSService

Throws:

ContainerException

destroy

public void destroy()

Specified by:

destroy in interface JAXRSService

getJaxrsServletConfig

protected javax.servlet.ServletConfig getJaxrsServletConfig(javax.servlet.ServletContext servletContext)

getJaxrsServletPath

protected String getJaxrsServletPath(HstRequestContext requestContext)
                              throws ContainerException

Throws:

ContainerException

getJaxrsPathInfo

protected abstract String getJaxrsPathInfo(HstRequestContext requestContext,
                                           javax.servlet.http.HttpServletRequest request)
                                    throws ContainerException

Concrete implementations must implement this method to get the jaxrs pathInfo. This one is most likely different than HstRequestContext#getBaseURL()#getPathInfo() because the baseURL has a pathInfo which has been stripped from matrix parameters

Parameters:

requestContext -

request -

Returns:

Throws:

ContainerException

getJaxrsRequest

protected javax.servlet.http.HttpServletRequest getJaxrsRequest(HstRequestContext requestContext,
                                                                javax.servlet.http.HttpServletRequest request)
                                                         throws ContainerException

Throws:

ContainerException

getMountContentPath

protected String getMountContentPath(HstRequestContext requestContext)

getContentNode

protected javax.jcr.Node getContentNode(javax.jcr.Session session,
                                        String path)
                                 throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getRequestContentBean

public <T extends HippoBean> T getRequestContentBean(HstRequestContext requestContext,
                                                     Class<T> beanMappingClass)

Returns the content HippoBean of type T for the current request. If there cannot be found a bean of type beanMappingClass for the relative content path of the resolved sitemap item, null is returned. If there is no resolved sitemap item, null is returned.

Type Parameters:

T -

Parameters:

requestContext -

beanMappingClass -

Returns:

a bean of type T and null if there cannot be found a content bean for the requestContext or when the bean is not of type beanMappingClass

getRequestContentBean

public HippoBean getRequestContentBean(HstRequestContext requestContext)

Returns the content HippoBean for the current request.

Parameters:

requestContext -

Returns:

the HippoBean where the relative contentpath of the sitemap item points to or null when not found, or no relative content path is present, or no resolved sitemap item

getSiteContentBaseBean

public HippoFolderBean getSiteContentBaseBean(HstRequestContext requestContext)

Parameters:

requestContext -

Returns:

the siteContentBaseBean if it can be found and null otherwise