org.hippoecm.hst.jaxrs.services

Class AbstractResource

java.lang.Object

org.hippoecm.hst.jaxrs.services.AbstractResource

Direct Known Subclasses:

AbstractContentResource

public abstract class AbstractResource
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	HST_MOUNT_REL_PREFIX
static String	HST_REST_RELATIONS_BASE_URI
static String	MOUNT_ALIAS_ASSETS
static String	MOUNT_ALIAS_GALLERY
static String	MOUNT_ALIAS_REST
static String	MOUNT_ALIAS_SITE

Constructor Summary

Constructors

Constructor and Description
AbstractResource()

Method Summary

Modifier and Type	Method and Description
protected String	deleteHippoBean(javax.servlet.http.HttpServletRequest servletRequest, HippoBean hippoBean) Deletes the content node mapped to the provided HippoBean
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
protected HippoBean	getChildBeanByRelPathOrPrimaryNodeType(HippoBean hippoBean, String relPath, String primaryNodeType) Looks up a child HippoBean for the provided HippoBean.
ContentRewriter<String>	getContentRewriter()
protected String	getHstQualifiedLinkRel(String simpleRel) Creates an URL that can be used to specify the relation type for a link such as <link href="http://localhost:8080/site/" rel="http://www.onehippo.org/cms7/hst/rest/relations/mount:site" title="Home Page"/>
HstQueryManager	getHstQueryManager(HstRequestContext requestContext)
HstQueryManager	getHstQueryManager(javax.jcr.Session session, HstRequestContext requestContext)
protected String	getLinkMountRelation(String mountName) Creates an URL that can be used to specify the relation type for a link such as <link href="http://localhost:8080/site/" rel="http://www.onehippo.org/cms7/hst/rest/relations/mount:site" title="Home Page"/>
HippoFolderBean	getMountContentBaseBean(HstRequestContext requestContext)
protected Link	getMountLink(HstRequestContext requestContext, HippoBean hippoBean, String mountAliasName, String subPath) Creates a link to the provided HippoBean, exposed over the mount identified by the alias mountAliasName.
protected Link	getNodeLink(HstRequestContext requestContext, HippoBean hippoBean) Creates a link to the provided HippoBean, exposed over the rest mount.
ObjectConverter	getObjectConverter(HstRequestContext requestContext)
protected javax.jcr.Session	getPersistableSession(HstRequestContext requestContext) Creates a persistable JCR session with the default credentials
protected javax.jcr.Session	getPersistableSession(HstRequestContext requestContext, javax.jcr.Credentials credentials) Creates a persistable JCR session with provided credentials.
protected ObjectBeanPersistenceManager	getPersistenceManager(HstRequestContext requestContext) Creates and returns a persistence manager with the default session of the requestContext.
protected ObjectBeanPersistenceManager	getPersistenceManager(HstRequestContext requestContext, javax.jcr.Session persistableSession) Creates and returns a persistence manager with the specified session.
protected String	getQualifiedLinkRel(String simpleRel) Creates an URL that can be used to specify the relation type for a link such as <link href="http://localhost:8080/site/" rel="http://www.onehippo.org/cms7/hst/rest/relations/mount:site" title="Home Page"/>
protected String	getQualifiedLinkRel(String iri, String simpleRel) Creates an URL that can be used to specify the relation type for a link such as <link href="http://localhost:8080/site/" rel="http://www.onehippo.org/cms7/hst/rest/relations/mount:site" title="Home Page"/>
protected HippoBean	getRequestContentBean(HstRequestContext requestContext) Returns the content HippoBean for the current request.
protected <T extends HippoBean> T	getRequestContentBean(HstRequestContext requestContext, Class<T> beanMappingClass) Returns the content HippoBean of type T for the current request.
protected HstRequestContext	getRequestContext(javax.servlet.http.HttpServletRequest servletRequest)
protected Link	getRestLink(HstRequestContext requestContext, HippoBean hippoBean, String subPath) Creates a link to the provided HippoBean, exposed over the rest mount.
String	getRestRelationsBaseUri()
protected Link	getSiteLink(HstRequestContext requestContext, HippoBean hippoBean) Creates a link to the provided HippoBean, exposed over the site mount.
boolean	isPageLinksExternal()
void	setAnnotatedClasses(List<Class<? extends HippoBean>> annotatedClasses)
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
void	setContentRewriter(ContentRewriter<String> contentRewriter)
void	setHstQueryManagerFactory(HstQueryManagerFactory hstQueryManagerFactory) Deprecated. since 2.28.00 not used any more. If custom object converter is needed, inject a custom hst query manager in the HstRequestContext. 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	setPageLinksExternal(boolean pageLinksExternal)
void	setRestRelationsBaseUri(String restRelationsBaseUri)

Methods inherited from class java.lang.Object

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

Field Detail

MOUNT_ALIAS_REST

public static final String MOUNT_ALIAS_REST

See Also:

Constant Field Values

MOUNT_ALIAS_SITE

public static final String MOUNT_ALIAS_SITE

See Also:

Constant Field Values

MOUNT_ALIAS_GALLERY

public static final String MOUNT_ALIAS_GALLERY

See Also:

Constant Field Values

MOUNT_ALIAS_ASSETS

public static final String MOUNT_ALIAS_ASSETS

See Also:

Constant Field Values

HST_REST_RELATIONS_BASE_URI

public static final String HST_REST_RELATIONS_BASE_URI

See Also:

Constant Field Values

HST_MOUNT_REL_PREFIX

public static final String HST_MOUNT_REL_PREFIX

See Also:

Constant Field Values

Constructor Detail

AbstractResource

public AbstractResource()

Method Detail

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

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

getAnnotatedClasses

@Deprecated
public 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

setAnnotatedClasses

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

getObjectConverter

public ObjectConverter getObjectConverter(HstRequestContext requestContext)

Returns:

a ObjectConverter instance. Note that this instance is shared between multiple threads.

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

getHstQueryManager

public HstQueryManager getHstQueryManager(HstRequestContext requestContext)

Returns:

the query manager backed by the session returned by HstRequestContext.getSession() of the provided requestContext

getHstQueryManager

public HstQueryManager getHstQueryManager(javax.jcr.Session session,
                                          HstRequestContext requestContext)

Returns:

the query manager backed by the provided session

setHstQueryManagerFactory

@Deprecated
public void setHstQueryManagerFactory(HstQueryManagerFactory hstQueryManagerFactory)

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

getRestRelationsBaseUri

public String getRestRelationsBaseUri()

setRestRelationsBaseUri

public void setRestRelationsBaseUri(String restRelationsBaseUri)

isPageLinksExternal

public boolean isPageLinksExternal()

setPageLinksExternal

public void setPageLinksExternal(boolean pageLinksExternal)

getContentRewriter

public ContentRewriter<String> getContentRewriter()

setContentRewriter

public void setContentRewriter(ContentRewriter<String> contentRewriter)

getPersistenceManager

protected ObjectBeanPersistenceManager getPersistenceManager(HstRequestContext requestContext)
                                                      throws javax.jcr.RepositoryException

Creates and returns a persistence manager with the default session of the requestContext.

Note: when the operation is annotated with Persistable, the default session of the requestContext should already be a persistable (writable) session.

Parameters:

requestContext -

Returns:

Throws:

javax.jcr.RepositoryException

getPersistenceManager

protected ObjectBeanPersistenceManager getPersistenceManager(HstRequestContext requestContext,
                                                             javax.jcr.Session persistableSession)
                                                      throws javax.jcr.RepositoryException

Creates and returns a persistence manager with the specified session.

Parameters:

requestContext -

persistableSession -

Returns:

Throws:

javax.jcr.RepositoryException

getRequestContext

protected HstRequestContext getRequestContext(javax.servlet.http.HttpServletRequest servletRequest)

Returns:

the HstRequestContext for the provided servletRequest

getRequestContentBean

protected <T extends HippoBean> T getRequestContentBean(HstRequestContext requestContext,
                                                        Class<T> beanMappingClass)
                                                 throws ObjectBeanManagerException

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 a ObjectBeanManagerException is thrown If there is no resolved sitemap item, null is returned.

Type Parameters:

T -

Parameters:

requestContext -

beanMappingClass -

Returns:

a bean of type T

Throws:

ObjectBeanManagerException - when there cannot be returned a bean

getRequestContentBean

protected HippoBean getRequestContentBean(HstRequestContext requestContext)
                                   throws ObjectBeanManagerException

Returns the content HippoBean for the current request.

Parameters:

requestContext -

Returns:

the HippoBean where the relative contentpath of the sitemap item points to

Throws:

ObjectBeanManagerException - when there cannot be returned a bean

getMountContentBaseBean

public HippoFolderBean getMountContentBaseBean(HstRequestContext requestContext)
                                        throws ObjectBeanManagerException

Parameters:

requestContext -

Returns:

HippoFolderBean the mountContentBaseBean

Throws:

ObjectBeanManagerException - when there cannot be returned a site content base bean

deleteHippoBean

protected String deleteHippoBean(javax.servlet.http.HttpServletRequest servletRequest,
                                 HippoBean hippoBean)
                          throws javax.jcr.RepositoryException,
                                 ObjectBeanPersistenceException

Deletes the content node mapped to the provided HippoBean

Parameters:

servletRequest -

hippoBean - the bean which mapped data should be deleted

Returns:

the path of the content node mapped to this bean before deletion

Throws:

javax.jcr.RepositoryException

ObjectBeanPersistenceException

getChildBeanByRelPathOrPrimaryNodeType

protected HippoBean getChildBeanByRelPathOrPrimaryNodeType(HippoBean hippoBean,
                                                           String relPath,
                                                           String primaryNodeType)

Looks up a child HippoBean for the provided HippoBean. If relPath is not null or empty, a lookup using relPath is done. If relPath is null or empty, a lookup using primaryNodeType is done; if any child beans are found, the first is returned.

Parameters:

hippoBean -

relPath - the path identifying the child bean, see also HippoBean.getBean(String)

primaryNodeType - the primary node type used to search for child beans, see also HippoBean.getChildBeans(String)

Returns:

the child bean or null if not found

getQualifiedLinkRel

protected String getQualifiedLinkRel(String iri,
                                     String simpleRel)

Creates an URL that can be used to specify the relation type for a link such as <link href="http://localhost:8080/site/" rel="http://www.onehippo.org/cms7/hst/rest/relations/mount:site" title="Home Page"/>

Parameters:

iri - Internationalized Resource Identifier, e.g. "http://www.onehippo.org/cms7/hst/rest/relations"

simpleRel - relationship, e.g. "mount:site"

Returns:

the combination of iri and simpleRel

getQualifiedLinkRel

protected String getQualifiedLinkRel(String simpleRel)

Creates an URL that can be used to specify the relation type for a link such as <link href="http://localhost:8080/site/" rel="http://www.onehippo.org/cms7/hst/rest/relations/mount:site" title="Home Page"/>

Parameters:

simpleRel - relationship, e.g. "mount:site"

Returns:

the combination of getRestRelationsBaseUri() (which defaults to "http://www.onehippo.org/cms7/hst/rest/relations") and simpleRel

getHstQualifiedLinkRel

protected String getHstQualifiedLinkRel(String simpleRel)

Creates an URL that can be used to specify the relation type for a link such as <link href="http://localhost:8080/site/" rel="http://www.onehippo.org/cms7/hst/rest/relations/mount:site" title="Home Page"/>

Parameters:

simpleRel - relationship, e.g. "mount:site"

Returns:

the combination of HST_REST_RELATIONS_BASE_URI (which is defined as "http://www.onehippo.org/cms7/hst/rest/relations") and simpleRel

getLinkMountRelation

protected String getLinkMountRelation(String mountName)

Creates an URL that can be used to specify the relation type for a link such as <link href="http://localhost:8080/site/" rel="http://www.onehippo.org/cms7/hst/rest/relations/mount:site" title="Home Page"/>

Parameters:

mountName - mount name, e.g. "site"

Returns:

the combination of HST_MOUNT_REL_PREFIX (which is defined as "http://www.onehippo.org/cms7/hst/rest/relations/mount:") and mountName

getNodeLink

protected Link getNodeLink(HstRequestContext requestContext,
                           HippoBean hippoBean)

Creates a link to the provided HippoBean, exposed over the rest mount. If the bean is not exposed over the mount, a page not found link is returned.

Parameters:

requestContext -

hippoBean -

Returns:

getRestLink

protected Link getRestLink(HstRequestContext requestContext,
                           HippoBean hippoBean,
                           String subPath)

Creates a link to the provided HippoBean, exposed over the rest mount. If the bean is not exposed over the mount, a page not found link is returned.

Parameters:

requestContext -

hippoBean -

subPath - subPath appended to the link created for HippoBean, can be null

Returns:

getSiteLink

protected Link getSiteLink(HstRequestContext requestContext,
                           HippoBean hippoBean)

Creates a link to the provided HippoBean, exposed over the site mount. If the bean is not exposed over the mount, a page not found link is returned.

Parameters:

requestContext -

hippoBean -

Returns:

getMountLink

protected Link getMountLink(HstRequestContext requestContext,
                            HippoBean hippoBean,
                            String mountAliasName,
                            String subPath)

Creates a link to the provided HippoBean, exposed over the mount identified by the alias mountAliasName. If no mount is found with the provided mountAliasName, a link is created using the mount of the provided HstRequestContext. If the bean is not exposed over the mount, a page not found link is returned.

Parameters:

requestContext -

hippoBean -

mountAliasName - mount alias name, when null the mount with the alias site is used to create the link

subPath - subPath appended to the link created for HippoBean, can be null

Returns:

getPersistableSession

protected javax.jcr.Session getPersistableSession(HstRequestContext requestContext)
                                           throws javax.jcr.RepositoryException

Creates a persistable JCR session with the default credentials

Note: The client should invoke logout() method on the session after use.

Internally, Session.impersonate(Credentials) method will be used to create a persistable JCR session. The method is invoked on the session from the session pooling repository.

Parameters:

requestContext -

Returns:

Throws:

javax.jcr.RepositoryException

getPersistableSession

protected javax.jcr.Session getPersistableSession(HstRequestContext requestContext,
                                                  javax.jcr.Credentials credentials)
                                           throws javax.jcr.RepositoryException

Creates a persistable JCR session with provided credentials.

Note: The client should invoke logout() method on the session after use.

Internally, Session.impersonate(Credentials) method will be used to create a persistable JCR session. The method is invoked on the session from the session pooling repository.

Parameters:

requestContext -

Returns:

Throws:

javax.jcr.RepositoryException