org.hippoecm.hst.util

Class ContentBeanUtils

java.lang.Object

org.hippoecm.hst.util.ContentBeanUtils

public class ContentBeanUtils
extends Object

Note most of the utilities in this class rely on that the HstRequestContext is available via a thread local via RequestContextProvider.get(). This is the case when this utility is used in the context of HST request processing. If you only include the hst-content-beans dependency to a project, the utility method in this class do not function

Method Summary

Modifier and Type	Method and Description
static HstQuery	createIncomingBeansQuery(HippoDocumentBean bean, HippoBean scope, int depth, Class<? extends HippoBean> beanMappingClass, boolean includeSubTypes) Returns a HstQuery for incoming beans (incoming beans within scope scope).
static HstQuery	createIncomingBeansQuery(HippoDocumentBean bean, HippoBean scope, int depth, ObjectConverter converter, Class<? extends HippoBean> beanMappingClass, boolean includeSubTypes) Deprecated. since 7.9.0 : objectConverter not used any more. use createIncomingBeansQuery(HippoDocumentBean, HippoBean, int, Class, boolean) instead
static HstQuery	createIncomingBeansQuery(HippoDocumentBean bean, HippoBean scope, List<String> linkPaths, Class<? extends HippoBean> beanMappingClass, boolean includeSubTypes) Returns a HstQuery for incoming beans (incoming beans within scope scope).
static HstQuery	createIncomingBeansQuery(HippoDocumentBean bean, HippoBean scope, List<String> linkPaths, ObjectConverter converter, Class<? extends HippoBean> beanMappingClass, boolean includeSubTypes) Deprecated. since 7.9.0 : objectConverter not used any more. use createIncomingBeansQuery(HippoDocumentBean, HippoBean, List, Class, boolean) instead
static HstQuery	createIncomingBeansQuery(HippoDocumentBean bean, HippoBean scope, String linkPath, Class<? extends HippoBean> beanMappingClass, boolean includeSubTypes) Returns a HstQuery for incoming beans (incoming beans within scope scope).
static HstQuery	createIncomingBeansQuery(HippoDocumentBean bean, HippoBean scope, String linkPath, ObjectConverter converter, Class<? extends HippoBean> beanMappingClass, boolean includeSubTypes) Deprecated. since 7.9.0 : objectConverter not used any more. use createIncomingBeansQuery(HippoDocumentBean, HippoBean, String, Class, boolean) instead
static javax.jcr.Session	getDisposableSession(HstRequestContext requestContext, String sessionIdentifier) This method tries to get a Session from a disposable pool which is identified by disposablePoolIdentifier or a Session from a security delegate If sessionIdentifier is empty or null an HstComponentException will be thrown.
static <T extends HippoBean> T	getFacetedNavigationResultDocument(HstQuery query, Class<T> beanMappingClass) Tries to return a bean that is located in a faceted navigation tree below a result set.
static <T extends HippoBean> T	getFacetedNavigationResultDocument(HstQuery query, String relPath, Class<T> beanMappingClass) Tries to return a bean that is located in a faceted navigation tree below a result set.
static <T extends HippoBean> T	getFacetedNavigationResultDocument(HstQuery query, String absBasePath, String relPath, Class<T> beanMappingClass) Tries to return a bean that is located in a faceted navigation tree below a result set.
static <T extends HippoBean> T	getFacetedNavigationResultDocument(String query, Class<T> beanMappingClass) Tries to return a bean that is located in a faceted navigation tree below a result set.
static <T extends HippoBean> T	getFacetedNavigationResultDocument(String query, String relPath, Class<T> beanMappingClass) Tries to return a bean that is located in a faceted navigation tree below a result set.
static <T extends HippoBean> T	getFacetedNavigationResultDocument(String query, String absBasePath, String relPath, Class<T> beanMappingClass) Tries to return a bean that is located in a faceted navigation tree below a result set.
static HippoFacetNavigationBean	getFacetNavigationBean(HstQuery query) Same as getFacetNavigationBean(String) only now instead of a String query we pass in a HstQuery
static HippoFacetNavigationBean	getFacetNavigationBean(HstQuery query, String relPath) Same as getFacetNavigationBean(HstQuery) only now instead of having the faceted navigation node from the ResolvedSiteMapItem we add a relPath where it should be found
static HippoFacetNavigationBean	getFacetNavigationBean(HstQuery query, String absBasePath, String relPath) Same as getFacetNavigationBean(HstQuery) only now instead of having the faceted navigation node from the ResolvedSiteMapItem we add absBasePath and relPath where it should be found
static HippoFacetNavigationBean	getFacetNavigationBean(String query)
static HippoFacetNavigationBean	getFacetNavigationBean(String relPath, String query)
static HippoFacetNavigationBean	getFacetNavigationBean(String absBasePath, String relPath, String query) Returns the HippoFacetNavigationBean for absBasePath, relPath and accounted for the free text query.
static <T extends HippoBean> List<T>	getIncomingBeans(HstQuery query, Class<? extends HippoBean> beanMappingClass) Returns a list of beans of type T (the same type as beanMappingClass) that have a (facet)link to the HippoDocumentBean bean.
static javax.jcr.Session	getPreviewCmsQuerySession(HstRequestContext requestContext, String sessionIdentifier)
static boolean	isBeanType(Object bean, String typeName) Determines if the class or interface represented by this content bean object is either the same as, or is a subclass of, the class or interface represented by the specified fully qualified class name parameter.

Methods inherited from class java.lang.Object

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

Method Detail

isBeanType

public static boolean isBeanType(Object bean,
                                 String typeName)

Determines if the class or interface represented by this content bean object is either the same as, or is a subclass of, the class or interface represented by the specified fully qualified class name parameter. It returns true if so; otherwise it returns false.

Parameters:

bean - content bean object

typeName - fully qualified class name or simple class name

Returns:

createIncomingBeansQuery

@Deprecated
public static HstQuery createIncomingBeansQuery(HippoDocumentBean bean,
                                                            HippoBean scope,
                                                            String linkPath,
                                                            ObjectConverter converter,
                                                            Class<? extends HippoBean> beanMappingClass,
                                                            boolean includeSubTypes)
                                                     throws QueryException

Deprecated. since 7.9.0 : objectConverter not used any more. use createIncomingBeansQuery(HippoDocumentBean, HippoBean, String, Class, boolean) instead

Throws:

QueryException

createIncomingBeansQuery

public static HstQuery createIncomingBeansQuery(HippoDocumentBean bean,
                                                HippoBean scope,
                                                String linkPath,
                                                Class<? extends HippoBean> beanMappingClass,
                                                boolean includeSubTypes)
                                         throws QueryException

Returns a HstQuery for incoming beans (incoming beans within scope scope). You can add filters and ordering to the query before executing it You need to add a linkPath: this is that path, that the incoming beans use to link to the HippoDocumentBean bean. For example, with 'myproject:link/@hippo:docbase' or even 'wildcard/@hippo:docbase' or 'wildcard/wildcard/@hippo:docbase' where wildcard = *

Parameters:

bean - The HippoDocumentBean that you have, and for which you want to find the other beans that have a link to it (incoming beans)

scope - the scope (hierarchical location) to search below for 'incoming beans'

linkPath - the path where the 'incoming beans' have there link (mirror) stored, for example at myns:links/@hippo:docbase

beanMappingClass - the type the 'incoming beans' should be of

includeSubTypes - true when subtypes of beanMappingClass should be included in the result

Returns:

a HstQuery that contains the constraints for 'incoming beans' to your bean

Throws:

QueryException

createIncomingBeansQuery

@Deprecated
public static HstQuery createIncomingBeansQuery(HippoDocumentBean bean,
                                                            HippoBean scope,
                                                            int depth,
                                                            ObjectConverter converter,
                                                            Class<? extends HippoBean> beanMappingClass,
                                                            boolean includeSubTypes)
                                                     throws QueryException

Deprecated. since 7.9.0 : objectConverter not used any more. use createIncomingBeansQuery(HippoDocumentBean, HippoBean, int, Class, boolean) instead

Throws:

QueryException

createIncomingBeansQuery

public static HstQuery createIncomingBeansQuery(HippoDocumentBean bean,
                                                HippoBean scope,
                                                int depth,
                                                Class<? extends HippoBean> beanMappingClass,
                                                boolean includeSubTypes)
                                         throws QueryException

Returns a HstQuery for incoming beans (incoming beans within scope scope). You can add filters and ordering to the query before executing it You need to add a depth: this is the maximum depth, that the incoming beans use to link to the HippoDocumentBean bean. For example, with 'myproject:link/@hippo:docbase' is depth 1, 'myproject:somecompound/myproject:link/@hippo:docbase' is depth 2

Parameters:

bean - The HippoDocumentBean that you have, and for which you want to find the other beans that have a link to it (incoming beans)

scope - the scope (hierarchical location) to search below for 'incoming beans'

depth - the depth until which the links below the HippoDocuments you want to find can be. Maximum depth is 4, when larger, a QueryException is thrown

beanMappingClass - the type the 'incoming beans' should be of

includeSubTypes - true when subtypes of beanMappingClass should be included in the result

Returns:

a HstQuery that contains the constraints for 'incoming beans' to your bean

Throws:

QueryException - when depth is larger than 4

createIncomingBeansQuery

@Deprecated
public static HstQuery createIncomingBeansQuery(HippoDocumentBean bean,
                                                            HippoBean scope,
                                                            List<String> linkPaths,
                                                            ObjectConverter converter,
                                                            Class<? extends HippoBean> beanMappingClass,
                                                            boolean includeSubTypes)
                                                     throws QueryException

Deprecated. since 7.9.0 : objectConverter not used any more. use createIncomingBeansQuery(HippoDocumentBean, HippoBean, List, Class, boolean) instead

Throws:

QueryException

createIncomingBeansQuery

public static HstQuery createIncomingBeansQuery(HippoDocumentBean bean,
                                                HippoBean scope,
                                                List<String> linkPaths,
                                                Class<? extends HippoBean> beanMappingClass,
                                                boolean includeSubTypes)
                                         throws QueryException

Returns a HstQuery for incoming beans (incoming beans within scope scope). You can add filters and ordering to the query before executing it You need to add linkPaths: these are the paths, that the incoming beans use to link to the HippoDocumentBean bean. For example, with 'myproject:link/@hippo:docbase' or even 'wildcard/@hippo:docbase' or 'wildcard/wildcard/@hippo:docbase' where wildcard = *

Parameters:

bean - The HippoDocumentBean that you have, and for which you want to find the other beans that have a link to it (incoming beans)

scope - the scope (hierarchical location) to search below for 'incoming beans'

linkPaths - the paths where the 'incoming beans' have there link (mirror) stored, for example at {myns:links/@hippo:docbase, myns:alsolinks/@hippo:docbase }

beanMappingClass - the type the 'incoming beans' should be of

includeSubTypes - true when subtypes of beanMappingClass should be included in the result

Returns:

a HstQuery that contains the constraints for 'incoming beans' to your bean

Throws:

QueryException

getIncomingBeans

public static <T extends HippoBean> List<T> getIncomingBeans(HstQuery query,
                                                             Class<? extends HippoBean> beanMappingClass)
                                                      throws QueryException

Returns a list of beans of type T (the same type as beanMappingClass) that have a (facet)link to the HippoDocumentBean bean. If no incoming beans are found, an empty list will be returned.

Throws:

QueryException

getFacetNavigationBean

public static HippoFacetNavigationBean getFacetNavigationBean(String absBasePath,
                                                              String relPath,
                                                              String query)
                                                       throws HstComponentException

Returns the HippoFacetNavigationBean for absBasePath, relPath and accounted for the free text query. When query is null or empty, the HippoFacetNavigationBean without free text search is returned. Else, a HippoFacetNavigationBean with free text search is returned. If the HippoFacetNavigationBean does not exist in the faceted navigation tree in combination with the free text search, null is returned.

The relPath is relative to absBasePath and must not start with a /

If some exception happens, a HstComponentException is thrown

Parameters:

absBasePath - the absolute path (starting with /) from where to get the faceted navigation bean for relPath and query. The absBasePath is NOT allowed to point to or to a descendant of a faceted navigation node

relPath - the relative path to the faceted navigation node (thus not start with a '/') and is relative to the site content base path

query - the free text query that should be accounted for for this facNavBean, can be null in case of no query

Returns:

Throws:

HstComponentException

getFacetNavigationBean

public static HippoFacetNavigationBean getFacetNavigationBean(String relPath,
                                                              String query)
                                                       throws HstComponentException

Throws:

HstComponentException

See Also:

#getFacetNavigationBean(String, String, String)} with absBasePath as "/"+ requestContext.getSiteContentBasePath();

getFacetNavigationBean

public static HippoFacetNavigationBean getFacetNavigationBean(String query)
                                                       throws HstComponentException

Throws:

HstComponentException

See Also:

#getFacetNavigationBean(String, String, String)} with absBasePath as "/"+ requestContext.getSiteContentBasePath() and relPath as requestContext.getResolvedSiteMapItem().getRelativeContentPath()

getFacetNavigationBean

public static HippoFacetNavigationBean getFacetNavigationBean(HstQuery query)
                                                       throws HstComponentException

Same as getFacetNavigationBean(String) only now instead of a String query we pass in a HstQuery

Throws:

HstComponentException

See Also:

#getFacetNavigationBean(String)}

getFacetNavigationBean

public static HippoFacetNavigationBean getFacetNavigationBean(HstQuery query,
                                                              String relPath)
                                                       throws HstComponentException

Same as getFacetNavigationBean(HstQuery) only now instead of having the faceted navigation node from the ResolvedSiteMapItem we add a relPath where it should be found

Parameters:

query - a HstQuery object

relPath - the relative path from site base content to the faceted navigation node, which must not start with a / and is relative to the site content base path

Returns:

the HippoFacetNavigationBean accounted for this query and relPath and null if we could not find the HippoFacetNavigationBean when the query is applied

Throws:

HstComponentException

See Also:

#getFacetNavigationBean(String)}

getFacetNavigationBean

public static HippoFacetNavigationBean getFacetNavigationBean(HstQuery query,
                                                              String absBasePath,
                                                              String relPath)
                                                       throws HstComponentException

Same as getFacetNavigationBean(HstQuery) only now instead of having the faceted navigation node from the ResolvedSiteMapItem we add absBasePath and relPath where it should be found

Parameters:

query - a HstQuery object

absBasePath - the absolute path (starting with /) from where to get the faceted navigation bean for relPath and query. The absBasePath is NOT allowed to point to or to a descendant of a faceted navigation node

relPath - the relative path from absBasePath to the faceted navigation node, which must not start with a / and is relative to the site content base path

Returns:

the HippoFacetNavigationBean accounted for this query and relPath and null if we could not find the HippoFacetNavigationBean when the query is applied

Throws:

HstComponentException

See Also:

#getFacetNavigationBean(String)}

getFacetedNavigationResultDocument

public static <T extends HippoBean> T getFacetedNavigationResultDocument(String query,
                                                                         String absBasePath,
                                                                         String relPath,
                                                                         Class<T> beanMappingClass)

Tries to return a bean that is located in a faceted navigation tree below a result set. When it cannot be found, or the bean is not of type beanMappingClass, null will be returned.

Type Parameters:

T -

Parameters:

query - the free text search as String that is used for this faceted navigation. The query should already have been processed by SearchInputParsingUtils.parse(String, boolean) if necessary.

absBasePath - the absolute path (starting with /) from where to get the faceted navigation bean for relPath and query. The absBasePath is NOT allowed to point to or to a descendant of a faceted navigation node

relPath - the relative path from absBasePath to the faceted navigation node, which must not start with a / and is relative to the site content base path

beanMappingClass - the class T must be of

Returns:

The faceted navigation result document of type T and null if it cannot be found or is not of type T

getFacetedNavigationResultDocument

public static <T extends HippoBean> T getFacetedNavigationResultDocument(String query,
                                                                         String relPath,
                                                                         Class<T> beanMappingClass)

Tries to return a bean that is located in a faceted navigation tree below a result set. When it cannot be found, or the bean is not of type beanMappingClass, null will be returned.

Type Parameters:

T -

Parameters:

query - the free text search as String that is used for this faceted navigation. The query should already have been processed by SearchInputParsingUtils.parse(String, boolean) if necessary.

relPath - the relative path from site base content to the faceted navigation node, which must not start with a / and is relative to the site content base path

beanMappingClass - the class T must be of

Returns:

The faceted navigation result document of type T and null if it cannot be found or is not of type T

getFacetedNavigationResultDocument

public static <T extends HippoBean> T getFacetedNavigationResultDocument(String query,
                                                                         Class<T> beanMappingClass)

Tries to return a bean that is located in a faceted navigation tree below a result set. When it cannot be found, or the bean is not of type beanMappingClass, null will be returned.

Type Parameters:

T -

Parameters:

query - the free text search as String that is used for this faceted navigation

beanMappingClass - the class T must be of

Returns:

The faceted navigation result document of type T and null if it cannot be found or is not of type T

getFacetedNavigationResultDocument

public static <T extends HippoBean> T getFacetedNavigationResultDocument(HstQuery query,
                                                                         String absBasePath,
                                                                         String relPath,
                                                                         Class<T> beanMappingClass)

Tries to return a bean that is located in a faceted navigation tree below a result set. When it cannot be found, or the bean is not of type beanMappingClass, null will be returned.

Type Parameters:

T -

Parameters:

query - the free text search as HstQuery that is used for this faceted navigation

absBasePath - the absolute path (starting with /) from where to get the faceted navigation bean for relPath and query. The absBasePath is NOT allowed to point to or to a descendant of a faceted navigation node

relPath - the relative path from absBasePath to the faceted navigation node, which must not start with a / and is relative to the site content base path

beanMappingClass - the class T must be of

Returns:

The faceted navigation result document of type T and null if it cannot be found or is not of type T

getFacetedNavigationResultDocument

public static <T extends HippoBean> T getFacetedNavigationResultDocument(HstQuery query,
                                                                         String relPath,
                                                                         Class<T> beanMappingClass)

Tries to return a bean that is located in a faceted navigation tree below a result set. When it cannot be found, or the bean is not of type beanMappingClass, null will be returned.

Type Parameters:

T -

Parameters:

query - the free text search as HstQuery that is used for this faceted navigation

relPath - the relative path from site base content to the faceted navigation node, which must not start with a / and is relative to the site content base path

beanMappingClass - the class T must be of

Returns:

The faceted navigation result document of type T and null if it cannot be found or is not of type T

getFacetedNavigationResultDocument

public static <T extends HippoBean> T getFacetedNavigationResultDocument(HstQuery query,
                                                                         Class<T> beanMappingClass)

Tries to return a bean that is located in a faceted navigation tree below a result set. When it cannot be found, or the bean is not of type beanMappingClass, null will be returned.

Type Parameters:

T -

Parameters:

query - the free text search as HstQuery that is used for this faceted navigation

beanMappingClass - the class T must be of

Returns:

The faceted navigation result document of type T and null if it cannot be found or is not of type T

getDisposableSession

public static javax.jcr.Session getDisposableSession(HstRequestContext requestContext,
                                                     String sessionIdentifier)
                                              throws HstComponentException

This method tries to get a Session from a disposable pool which is identified by disposablePoolIdentifier or a Session from a security delegate

If sessionIdentifier is empty or null an HstComponentException will be thrown. If it is not possible to return a Session for the sessionIdentifier, for example because there is configured a MultipleRepositoryImpl instead of LazyMultipleRepositoryImpl, also a HstComponentException will be thrown.

Parameters:

requestContext - the hstRequest for this HstComponent

sessionIdentifier - the identifier for this disposable pool / session. It is not allowed to be empty or null

Returns:

a jcr Session from a disposable pool

Throws:

HstComponentException

getPreviewCmsQuerySession

public static javax.jcr.Session getPreviewCmsQuerySession(HstRequestContext requestContext,
                                                          String sessionIdentifier)
                                                   throws HstComponentException

Throws:

HstComponentException