com.adobe.cq.social.srp.internal

Class UGCCResourceProvider

java.lang.Object

com.adobe.cq.social.srp.internal.UGCCResourceProvider

All Implemented Interfaces:

CachingResourceProvider, SocialResourceProvider, ModifyingResourceProvider, QueriableResourceProvider, ResourceProvider

public class UGCCResourceProvider
extends java.lang.Object
implements CachingResourceProvider

A resource provider that can talk to a cloud.

Nested Class Summary

Nested classes/interfaces inherited from interface com.adobe.cq.social.srp.SocialResourceProvider

SocialResourceProvider.PrefetchPerResult

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	QUERY_MAX_LENGTH Max length for url that can be sent to AS.

Fields inherited from interface com.adobe.cq.social.srp.internal.CachingResourceProvider

INC

Fields inherited from interface com.adobe.cq.social.srp.SocialResourceProvider

JSRPQUERY, PARAM_BROWSER_LANGUAGE, PARAM_EXPECTED_LANGUAGE, PARAM_PAGE_LANGUAGE, PARAM_USER_PREFFERED_LANGUAGE, SOLRQUERY

Fields inherited from interface org.apache.sling.api.resource.QueriableResourceProvider

LANGUAGES

Fields inherited from interface org.apache.sling.api.resource.ResourceProvider

OWNS_ROOTS, RESOURCE_TYPE_SYNTHETIC, ROOTS, SERVICE_NAME, USE_RESOURCE_ACCESS_SECURITY

Constructor Summary

Constructors

Constructor and Description
UGCCResourceProvider(SocialDataService client, java.lang.String providerBase, Externalizer externalizer, CryptoSupport cryptoSupport, ProviderCache documentCache, CountCache allCountCache, CountCache visibleCountCache, AbstractCache<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Integer>>> facetCache, StringListCache stringListCache, AbstractSchemaMapper mapper, SRPConfigurationFactory srpConfigFactory) Creates a new Resource Provider.
UGCCResourceProvider(SocialDataService client, java.lang.String providerBase, Externalizer externalizer, CryptoSupport cryptoSupport, ProviderCache documentCache, CountCache allCountCache, CountCache visibleCountCache, AbstractCache<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Integer>>> facetCache, StringListCache stringListCache, AbstractSchemaMapper mapper, SRPConfigurationFactory srpConfigFactory, int maxPathLen) Creates a new Resource Provider.

Method Summary

Modifier and Type	Method and Description
void	clearCache() Clear the cache.
void	commit(ResourceResolver resourceResolver) Commit all transient changes: create, delete and updates
static java.lang.String	convertResourceTypeFilter(java.lang.String resourceTypeFilter) Convert resource filter query to Solr format.
java.util.Map<java.lang.String,java.lang.Long>	countChildren(java.util.List<Resource> parent, java.lang.String baseType, boolean visibleOnly) return counts of all children or filtered (visible) children (not hidden due to denied/flagged as hidden).
long	countChildren(Resource parent) return count of all children (one level).
long	countChildren(Resource parent, boolean visibleOnly) return count of all children or filtered (visible) children (not hidden due to denied/flagged as hidden).
long	countChildren(Resource parent, java.lang.String childType) return count of all children of specific type (one level).
long	countChildren(Resource parent, java.lang.String baseType, boolean visibleOnly) return count of all children or filtered (visible) children (not hidden due to denied/flagged as hidden).
Resource	create(ResourceResolver resourceResolver, java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> properties) Create a new resource at the given path.
void	decrement(Resource resource, java.lang.String property) Subtract one from the specified counter property.
void	delete(ResourceResolver resourceResolver, java.lang.String path) Delete the resource at the given path.
java.lang.String	facetRangeFieldHash(FacetRangeField rangeField) Hash a range field for use as cache key.
SocialResourceSearchResult<Resource>	find(ResourceResolver resolver, java.lang.String component, java.lang.String luceneQuery, java.util.List<SearchSortField> sortFields, int offset, int limit, boolean requiresTotal) Search in AS.
SocialResourceSearchResult<Resource>	find(ResourceResolver resolver, java.lang.String component, java.lang.String luceneQuery, java.util.List<SearchSortField> sortFields, int offset, int limit, boolean requiresTotal, java.lang.String fieldLanguage, java.util.Map<java.lang.String,java.lang.Object> signals) Return a result list of resources given a component and a query.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Integer>>	findFacetRanges(ResourceResolver resolver, java.util.List<FacetRangeField> rangeFields, java.lang.String resourceTypeFilter, java.lang.String componentFilter, int count) Search Collections findFacets for cloud storage resources.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Integer>>	findFacetRanges(ResourceResolver resolver, java.util.List<FacetRangeField> rangeFields, java.lang.String resourceTypeFilter, java.lang.String componentFilter, int count, boolean visibleOnly) Search Collections findFacets for cloud storage resources.
FacetSearchResult	findFacets(ResourceResolver resolver, java.util.List<java.lang.String> countFields, java.util.List<FacetRangeField> rangeFields, java.lang.String resourceTypeFilter, java.lang.String componentFilter, int count) Search Collections findFacets for cloud storage resources.
FacetSearchResult	findFacets(ResourceResolver resolver, java.util.List<java.lang.String> countFields, java.util.List<FacetRangeField> rangeFields, java.lang.String resourceTypeFilter, java.lang.String componentFilter, int count, boolean visibleOnly) Search Collections findFacets for cloud storage resources.
FacetSearchResult	findFacets(ResourceResolver resolver, java.util.List<java.lang.String> countFields, java.util.List<FacetRangeField> rangeFields, java.lang.String resourceTypeFilter, java.lang.String componentFilter, int count, boolean visibleOnly, boolean includeChidren) Search Collections findFacets for cloud storage resources.
SocialResourceSearchResult<java.util.Map<java.lang.String,java.lang.Object>>	findFacets(ResourceResolver resolver, java.util.List<java.lang.String> parentFilter, java.util.List<java.lang.String> fieldNames, java.util.List<FacetRangeField> facetRanges, java.lang.String scoredQueryString, int maxFacetCount, java.util.List<SearchSortField> sortFields, int offset, int pageSize) A faceted search function that can handle both range and non-range properties.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Integer>>	findFacets(ResourceResolver resolver, java.util.List<java.lang.String> fieldNames, java.lang.String resourceTypeFilter, java.lang.String componentFilter, int count) Search Collections findFacets for cloud storage resources.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Integer>>	findFacets(ResourceResolver resolver, java.util.List<java.lang.String> fieldNames, java.lang.String resourceTypeFilter, java.lang.String componentFilter, int count, boolean visibleOnly) Search Collections findFacets for cloud storage resources.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Integer>>	findFacets(ResourceResolver resolver, java.util.List<java.lang.String> fieldNames, java.lang.String resourceTypeFilter, java.lang.String componentFilter, int count, boolean visibleOnly, boolean includeChildren) Search Collections findFacets for cloud storage resources.
java.util.Iterator<Resource>	findResources(ResourceResolver resourceResolver, java.lang.String queryString, java.lang.String language) Searches for resources using the given query formulated in the given language.
java.lang.String	getASIPath() Get the repository path associated with this provider.
java.io.InputStream	getAttachmentInputStream(ResourceResolver resolver, java.lang.String path) Return an attachment resource as an InputStream.
int	getCommentIndex(java.lang.String path, java.lang.String baseType, ResourceResolver resourceResolver, java.lang.String commentToCheck, boolean visibleOnly) Get index of a given reply amongst all replies of a post.
java.lang.String	getContentType() Return the content type for pulling.
long	getCount(Resource resource, java.lang.String property) Return the value of the counter.
SocialResourceSearchResult<Resource>	getCountAndListChildren(java.lang.String path, java.lang.String baseType, ResourceResolver resourceResolver, int offset, int size, java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> sortBy, boolean visibleOnly) Get a count of the children of the resource at the path, filtered by child base type and visibility if requested.
java.lang.String	getJcrAclPath(java.lang.String path) Get the path that gives the permissions for the provided path.
java.util.List<java.lang.String>	getLanguages() Return a list of the languages that this provider can use to query resources.
ProviderMetaData	getMetaData() Gets details about the provider.
java.util.Iterator<Resource>	getMLTResults(ResourceResolver resolver, java.lang.String query, java.lang.String statusFilter, java.lang.String resourceTypeFilter, java.lang.String componentFilter, java.lang.String[] mltFields, int maxResults, int minTermFreq, int minDocFreq) Return a list of related posts, given a query.
java.util.Iterator<Resource>	getMLTResults(ResourceResolver resolver, java.lang.String query, java.lang.String statusFilter, java.lang.String resourceTypeFilter, java.lang.String componentFilter, java.lang.String mltField, int maxResults, int minTermFreq, int minDocFreq) Return a list of related posts, given a query.
Resource	getResource(ResourceResolver resourceResolver, javax.servlet.http.HttpServletRequest request, java.lang.String path) Deprecated. See getResource(ResourceResolver, String)
Resource	getResource(ResourceResolver resourceResolver, java.lang.String path) Returns a resource from this resource provider or null if the resource provider cannot find it.
java.util.Map<java.lang.String,Resource>	getResources(ResourceResolver resolver, java.util.List<java.lang.String> paths) Fetch a group of resources all managed by this resource provider
Resource	getResourceWithoutCheck(ResourceResolver resourceResolver, java.lang.String path) Skip checking the provider base when getting a "special" resource.
SocialDataService	getSocialDataService() Get the data service for this provider.
boolean	hasChanges(ResourceResolver resourceResolver) Are there any transient changes?
void	increment(Resource resource, java.lang.String property) Add one to the specified counter property.
void	incrementBy(Resource resource, java.util.Map<java.lang.String,java.lang.Long> incrementMap) Add an arbitrary increment to the specified properties.
void	incrementBy(Resource resource, java.lang.String property, java.lang.Long increment) Add an arbitrary increment to the specified counter property.
java.util.Iterator<Resource>	listChildren(Resource parent) Returns an Iterator of Resource objects loaded from the children of the given Resource.
java.util.Iterator<Resource>	listChildren(java.lang.String path, ResourceResolver resourceResolver, int offset, int size, java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> sortBy) Get a list of the children of the resource at the path.
java.util.Iterator<Resource>	listChildren(java.lang.String path, java.lang.String baseType, ResourceResolver resourceResolver, int offset, int size, java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> sortBy) Get a list of the children of the resource at the path.
java.util.Iterator<Resource>	listChildren(java.lang.String path, java.lang.String baseType, ResourceResolver resourceResolver, int offset, int size, java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> sortBy, boolean visibleOnly) Get a list of the children of the resource at the path.
Resource	move(ResourceResolver resolver, java.lang.String srcAbsPath, java.lang.String destAbsPath)
java.util.Iterator<ValueMap>	queryResources(ResourceResolver resourceResolver, java.lang.String query, java.lang.String language) Queries the storage using the given query formulated in the given language.
void	revert(ResourceResolver resourceResolver) Revert all transient changes: create, delete and updates.
void	setCloudConfig(Configuration cloudConfig) Deprecated. use setConfig
void	setConfig(SocialResourceConfiguration socialConfiguration) Set the config associated with this provider.
void	update(Resource resource) Mark that this resource has been updated.

Methods inherited from class java.lang.Object

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

Field Detail

QUERY_MAX_LENGTH

public static final java.lang.Integer QUERY_MAX_LENGTH

Max length for url that can be sent to AS. Don't know the exact number.

Constructor Detail

UGCCResourceProvider

public UGCCResourceProvider(SocialDataService client,
                            java.lang.String providerBase,
                            Externalizer externalizer,
                            CryptoSupport cryptoSupport,
                            ProviderCache documentCache,
                            CountCache allCountCache,
                            CountCache visibleCountCache,
                            AbstractCache<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Integer>>> facetCache,
                            StringListCache stringListCache,
                            AbstractSchemaMapper mapper,
                            SRPConfigurationFactory srpConfigFactory)

Creates a new Resource Provider.

Parameters:

client - Adobe Cloud Storage API Client

providerBase - Base location of the provider.

externalizer - Used to externalize urls stored in Adobe Cloud Storage

cryptoSupport - a CryptoSupport impl

documentCache - the cache for docs

visibleCountCache - the cache for visible counts

allCountCache - the cache for all counts

facetCache - the cache for facets

mapper - the schema mapper

stringListCache - StringListCache

srpConfigFactory - the configuration factory

UGCCResourceProvider

public UGCCResourceProvider(SocialDataService client,
                            java.lang.String providerBase,
                            Externalizer externalizer,
                            CryptoSupport cryptoSupport,
                            ProviderCache documentCache,
                            CountCache allCountCache,
                            CountCache visibleCountCache,
                            AbstractCache<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Integer>>> facetCache,
                            StringListCache stringListCache,
                            AbstractSchemaMapper mapper,
                            SRPConfigurationFactory srpConfigFactory,
                            int maxPathLen)

Creates a new Resource Provider.

Parameters:

client - Adobe Cloud Storage API Client

providerBase - Base location of the provider.

externalizer - Used to externalize urls stored in Adobe Cloud Storage

cryptoSupport - a CryptoSupport impl

documentCache - the cache for docs

visibleCountCache - the cache for visible counts

allCountCache - the cache for all counts

facetCache - the cache for facets

mapper - the schema mapper

stringListCache - StringListCache

srpConfigFactory - the configuration factory

maxPathLen - Used for token length

Method Detail

getResource

@Deprecated
public Resource getResource(ResourceResolver resourceResolver,
                                        javax.servlet.http.HttpServletRequest request,
                                        java.lang.String path)

Deprecated. See getResource(ResourceResolver, String)

Returns a resource from this resource provider or null if the resource provider cannot find it. The path should have one of the ResourceProvider.ROOTS strings as its prefix.

This method is called to resolve a resource for the given request. The properties of the request, such as request parameters, may be use to parameterize the resource resolution. An example of such parameterization is support for a JSR-311 style resource provider to support the parameterized URL patterns.

Specified by:

getResource in interface ResourceProvider

Parameters:

resourceResolver - The ResourceResolver to which the returned Resource is attached.

request - The request

path - The resource path

Returns:

null If this provider does not have a resource for the path.

getSocialDataService

public SocialDataService getSocialDataService()

Get the data service for this provider.

Returns:

the data service

getResource

public Resource getResource(ResourceResolver resourceResolver,
                            java.lang.String path)

Returns a resource from this resource provider or null if the resource provider cannot find it. The path should have one of the ResourceProvider.ROOTS strings as its prefix. The resource provider must not return cached instances for a resource as the resource resolver will update the resource metadata of the resource at the end of the resolution process and this metadata might be different depending on the full path of resource resolution passed into the resource resolver.

Specified by:

getResource in interface ResourceProvider

Parameters:

resourceResolver - The ResourceResolver to which the returned Resource is attached.

path - The full path of the resource.

Returns:

null If this provider does not have a resource for the path.

getResourceWithoutCheck

public Resource getResourceWithoutCheck(ResourceResolver resourceResolver,
                                        java.lang.String path)

Skip checking the provider base when getting a "special" resource.

Parameters:

resourceResolver - the resolver

path - the path

Returns:

the resource

create

public Resource create(ResourceResolver resourceResolver,
                       java.lang.String path,
                       java.util.Map<java.lang.String,java.lang.Object> properties)
                throws PersistenceException

Create a new resource at the given path. The new resource is put into the transient space of this provider until ModifyingResourceProvider.commit(ResourceResolver) is called. A resource provider should value ResourceResolver.PROPERTY_RESOURCE_TYPE to set the resource type of a resource.

Specified by:

create in interface ModifyingResourceProvider

Parameters:

resourceResolver - The current resource resolver.

path - The resource path.

properties - Optional properties

Returns:

The new resource.

Throws:

PersistenceException - If anything fails

delete

public void delete(ResourceResolver resourceResolver,
                   java.lang.String path)
            throws PersistenceException

Delete the resource at the given path. This change is kept in the transient space of this provider until ModifyingResourceProvider.commit(ResourceResolver) is called.

Specified by:

delete in interface ModifyingResourceProvider

Parameters:

resourceResolver - The current resource resolver.

path - The resource path.

Throws:

PersistenceException - If anything fails

revert

public void revert(ResourceResolver resourceResolver)

Revert all transient changes: create, delete and updates.

Specified by:

revert in interface ModifyingResourceProvider

Parameters:

resourceResolver - The current resource resolver.

commit

public void commit(ResourceResolver resourceResolver)
            throws PersistenceException

Commit all transient changes: create, delete and updates

Specified by:

commit in interface ModifyingResourceProvider

Parameters:

resourceResolver - The current resource resolver.

Throws:

PersistenceException - If anything fails

hasChanges

public boolean hasChanges(ResourceResolver resourceResolver)

Are there any transient changes?

Specified by:

hasChanges in interface ModifyingResourceProvider

Parameters:

resourceResolver - The current resource resolver.

Returns:

true if there are pending changes.

countChildren

public long countChildren(Resource parent)

return count of all children (one level).

Specified by:

countChildren in interface SocialResourceProvider

Parameters:

parent - the parent resource

Returns:

The all children count or the visible children count

countChildren

public long countChildren(Resource parent,
                          boolean visibleOnly)

return count of all children or filtered (visible) children (not hidden due to denied/flagged as hidden). One level of children only

Specified by:

countChildren in interface SocialResourceProvider

Parameters:

parent - the parent resource

visibleOnly - if true, count only the 'visible' children

Returns:

The all children count or the visible children count

countChildren

public long countChildren(Resource parent,
                          java.lang.String childType)

return count of all children of specific type (one level). Filtered by child base type.

Specified by:

countChildren in interface SocialResourceProvider

Parameters:

parent - the parent resource

childType - The social base type (SocialUtils.PN_BASETYPE value) of children to count (can be null/empty)

Returns:

The all children count or the visible children count

countChildren

public java.util.Map<java.lang.String,java.lang.Long> countChildren(java.util.List<Resource> parent,
                                                                    java.lang.String baseType,
                                                                    boolean visibleOnly)

Description copied from interface: SocialResourceProvider

return counts of all children or filtered (visible) children (not hidden due to denied/flagged as hidden). filter by the child base type. One level of children only

Specified by:

countChildren in interface SocialResourceProvider

Parameters:

parent - the parent resources

baseType - The social base type (SocialUtils.PN_BASETYPE value) of children to count (can be null/empty)

visibleOnly - if true, count only the 'visible' children

Returns:

The all children counts or the visible children counts

listChildren

public java.util.Iterator<Resource> listChildren(Resource parent)

Returns an Iterator of Resource objects loaded from the children of the given Resource. The returned Resource instances are attached to the same ResourceResolver as the given parent resource.

This method may be called for resource providers whose root path list contains a path such that the resource path is a prefix of the list entry. This allows for the enumeration of deeply nested provided resources for which no actual parent hierarchy exists.

The returned iterator may in turn contain resources which do not actually exist but are required to traverse the resource tree. Such resources SHOULD be SyntheticResource objects whose resource type MUST be set to ResourceProvider.RESOURCE_TYPE_SYNTHETIC. As with ResourceProvider.getResource(ResourceResolver, String) the returned Resource objects must not be cached objects.

Specified by:

listChildren in interface ResourceProvider

Parameters:

parent - The Resource whose children are requested.

Returns:

An Iterator of Resource objects or null if the resource provider has no children for the given resource.

listChildren

public java.util.Iterator<Resource> listChildren(java.lang.String path,
                                                 ResourceResolver resourceResolver,
                                                 int offset,
                                                 int size,
                                                 java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> sortBy)

Get a list of the children of the resource at the path.

Specified by:

listChildren in interface SocialResourceProvider

Parameters:

path - path to parent

resourceResolver - resolver to use

offset - offset to start at

size - number to return

sortBy - order to return children in

Returns:

iterator of the child resources

listChildren

public java.util.Iterator<Resource> listChildren(java.lang.String path,
                                                 java.lang.String baseType,
                                                 ResourceResolver resourceResolver,
                                                 int offset,
                                                 int size,
                                                 java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> sortBy)

Description copied from interface: SocialResourceProvider

Get a list of the children of the resource at the path. Filtered by child base type.

Specified by:

listChildren in interface SocialResourceProvider

Parameters:

path - path to parent

baseType - base type of children to return (SocialUtils.PN_BASETYPE value) can be null/empty

resourceResolver - resolver to use

offset - offset to start at

size - number to return

sortBy - order to return children in

Returns:

iterator of the child resources

findResources

public java.util.Iterator<Resource> findResources(ResourceResolver resourceResolver,
                                                  java.lang.String queryString,
                                                  java.lang.String language)

Searches for resources using the given query formulated in the given language.

The semantic meaning of the query and language depend on the actual implementation and storage used for the resources. For JCR repository being used as storage, the query and language parameters are used to create a JCR Query through the QueryManager. The result returned is then based on the NodeIterator provided by the query result.

Specified by:

findResources in interface QueriableResourceProvider

Parameters:

resourceResolver - The resource resolver

queryString - The query string to use to find the resources.

language - The language in which the query is formulated.

Returns:

An Iterator of Resource objects matching the query. If no resources match, null might be returned instead of an empty iterator.

queryResources

public java.util.Iterator<ValueMap> queryResources(ResourceResolver resourceResolver,
                                                   java.lang.String query,
                                                   java.lang.String language)

Queries the storage using the given query formulated in the given language.

The semantic meaning of the query and language depend on the actual implementation and storage used for the resources. For JCR repository being used as storage, the query and language parameters are used to create a JCR Query through the QueryManager. The result returned is then based on the RowIterator provided by the query result. The map returned for each row is indexed by the column name and the column value is the JCR Value object converted into the respective Java object, such as Boolean for a value of property type Boolean.

Specified by:

queryResources in interface QueriableResourceProvider

Parameters:

resourceResolver - The resource resolver

query - The query string to use to find the resources.

language - The language in which the query is formulated.

Returns:

An Iterator of Map instances providing access to the query result. If no resources match, null might be returned instead of an empty iterator.

update

public void update(Resource resource)

Mark that this resource has been updated.

Specified by:

update in interface CachingResourceProvider

Parameters:

resource - the updated resource

setCloudConfig

@Deprecated
public void setCloudConfig(Configuration cloudConfig)

Deprecated. use setConfig

Set the cloud config associated with this provider.

Parameters:

cloudConfig - the cloud config

setConfig

public void setConfig(SocialResourceConfiguration socialConfiguration)

Set the config associated with this provider.

Specified by:

setConfig in interface SocialResourceProvider

Parameters:

socialConfiguration - the SRP configuration

getASIPath

public java.lang.String getASIPath()

Get the repository path associated with this provider.

Specified by:

getASIPath in interface SocialResourceProvider

Returns:

the path

getMLTResults

public java.util.Iterator<Resource> getMLTResults(ResourceResolver resolver,
                                                  java.lang.String query,
                                                  java.lang.String statusFilter,
                                                  java.lang.String resourceTypeFilter,
                                                  java.lang.String componentFilter,
                                                  java.lang.String[] mltFields,
                                                  int maxResults,
                                                  int minTermFreq,
                                                  int minDocFreq)

Return a list of related posts, given a query.

Specified by:

getMLTResults in interface SocialResourceProvider

Parameters:

resolver - The resource resolver.

query - The string to search for.

statusFilter - The filter on the status.

resourceTypeFilter - The resource type to filter on.

componentFilter - The path of the component we want to search on.

mltFields - Resource properties to search on. NOTE: Only first one is used

maxResults - The maximum results returned.

minTermFreq - The frequency which terms will be ignored in the source doc

minDocFreq - The frequency at which words will be ignored which do not occur in at least this many docs.

Returns:

The list of matching documents. Or an empty list if no documents are found or the Solr server cannot be queried.

getJcrAclPath

public java.lang.String getJcrAclPath(java.lang.String path)

Get the path that gives the permissions for the provided path.

Parameters:

path - the provided path

Returns:

the path for ACL checking

convertResourceTypeFilter

public static java.lang.String convertResourceTypeFilter(java.lang.String resourceTypeFilter)

Convert resource filter query to Solr format.

Parameters:

resourceTypeFilter - the filter

Returns:

sorl format for the filter

getMLTResults

public java.util.Iterator<Resource> getMLTResults(ResourceResolver resolver,
                                                  java.lang.String query,
                                                  java.lang.String statusFilter,
                                                  java.lang.String resourceTypeFilter,
                                                  java.lang.String componentFilter,
                                                  java.lang.String mltField,
                                                  int maxResults,
                                                  int minTermFreq,
                                                  int minDocFreq)

Description copied from interface: SocialResourceProvider

Return a list of related posts, given a query.

Specified by:

getMLTResults in interface SocialResourceProvider

Parameters:

resolver - The resource resolver.

query - The string to search for.

statusFilter - The filter on the status.

resourceTypeFilter - The resource type to filter on.

componentFilter - The path of the component we want to search on.

mltField - Resource property to search on.

maxResults - The maximum results returned.

minTermFreq - The frequency which terms will be ignored in the source doc

minDocFreq - The frequency at which words will be ignored which do not occur in at least this many docs.

Returns:

The list of matching documents. Or an empty list if no documents are found or the Solr server c cannot be queried.

find

public SocialResourceSearchResult<Resource> find(ResourceResolver resolver,
                                                 java.lang.String component,
                                                 java.lang.String luceneQuery,
                                                 java.util.List<SearchSortField> sortFields,
                                                 int offset,
                                                 int limit,
                                                 boolean requiresTotal)

Search in AS.

Specified by:

find in interface SocialResourceProvider

Parameters:

resolver - resolver for permission checking

component - The component to filter on

luceneQuery - query

sortFields - sort fields

offset - offset to return results from

limit - maximum number of results to return

requiresTotal - true iff the total number of documents is required.

Returns:

the search result as resources, with the Solr hit count.

find

public SocialResourceSearchResult<Resource> find(ResourceResolver resolver,
                                                 java.lang.String component,
                                                 java.lang.String luceneQuery,
                                                 java.util.List<SearchSortField> sortFields,
                                                 int offset,
                                                 int limit,
                                                 boolean requiresTotal,
                                                 java.lang.String fieldLanguage,
                                                 java.util.Map<java.lang.String,java.lang.Object> signals)

Description copied from interface: SocialResourceProvider

Return a result list of resources given a component and a query.

Specified by:

find in interface SocialResourceProvider

Parameters:

resolver - The resource resolver.

component - The component for filtering on

luceneQuery - The lucene query

sortFields - fields to use in sort and sort direction

offset - starting offset to return results at

limit - maximum number of results to return

requiresTotal - true iff the total number of matches needs to be returned in the SocialResourceSearchResult

fieldLanguage - search will be queried against verbatim_fieldLanguage. This can be changed in the SOLR request handler.

signals - Map containing field names with a map of values, user preferred language, browser language, page language and user selected language in the search widget. These values are used by SOLR request handler to determine the language of query string.

Returns:

The matching documents.

findFacets

public SocialResourceSearchResult<java.util.Map<java.lang.String,java.lang.Object>> findFacets(ResourceResolver resolver,
                                                                                               java.util.List<java.lang.String> parentFilter,
                                                                                               java.util.List<java.lang.String> fieldNames,
                                                                                               java.util.List<FacetRangeField> facetRanges,
                                                                                               java.lang.String scoredQueryString,
                                                                                               int maxFacetCount,
                                                                                               java.util.List<SearchSortField> sortFields,
                                                                                               int offset,
                                                                                               int pageSize)

Description copied from interface: SocialResourceProvider

A faceted search function that can handle both range and non-range properties. It can return the first page of results that match both the scored and unscored query strings.

Specified by:

findFacets in interface SocialResourceProvider

Parameters:

resolver - ResourceResolver for current search permissions

parentFilter - the paths to the parents (probably components) being searched

fieldNames - the non-range properties that should be faceted

facetRanges - the range properties that should be faceted

scoredQueryString - the query string that should be used wrt scoring the results.

maxFacetCount - the number of facets to return for each of the properties being faceted

sortFields - the sort criteria for the returned results

offset - which page to return

pageSize - the size of the page (0 if only facets should be returned)

Returns:

SocialResourceSearchResult.

findFacets

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Integer>> findFacets(ResourceResolver resolver,
                                                                                                    java.util.List<java.lang.String> fieldNames,
                                                                                                    java.lang.String resourceTypeFilter,
                                                                                                    java.lang.String componentFilter,
                                                                                                    int count)

Description copied from interface: SocialResourceProvider

Search Collections findFacets for cloud storage resources.

Specified by:

findFacets in interface SocialResourceProvider

Parameters:

resolver - ResourceResolver for current search permissions

fieldNames - Fields for which facet counts wanted

resourceTypeFilter - Resource type filter

componentFilter - Component filter

count - maximum results to return

Returns:

Map containing field names with a map of values and counts for each field

findFacets

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Integer>> findFacets(ResourceResolver resolver,
                                                                                                    java.util.List<java.lang.String> fieldNames,
                                                                                                    java.lang.String resourceTypeFilter,
                                                                                                    java.lang.String componentFilter,
                                                                                                    int count,
                                                                                                    boolean visibleOnly)

Description copied from interface: SocialResourceProvider

Search Collections findFacets for cloud storage resources.

Specified by:

findFacets in interface SocialResourceProvider

Parameters:

resolver - ResourceResolver for current search permissions

fieldNames - Fields for which facet counts wanted

resourceTypeFilter - Resource type filter

componentFilter - Component filter

count - maximum results to return

visibleOnly - whether to filter by visibility

Returns:

Map containing field names with a map of values and counts for each field

findFacets

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Integer>> findFacets(ResourceResolver resolver,
                                                                                                    java.util.List<java.lang.String> fieldNames,
                                                                                                    java.lang.String resourceTypeFilter,
                                                                                                    java.lang.String componentFilter,
                                                                                                    int count,
                                                                                                    boolean visibleOnly,
                                                                                                    boolean includeChildren)

Description copied from interface: SocialResourceProvider

Search Collections findFacets for cloud storage resources.

Specified by:

findFacets in interface SocialResourceProvider

Parameters:

resolver - ResourceResolver for current search permissions

fieldNames - Fields for which facet counts wanted

resourceTypeFilter - Resource type filter

componentFilter - Component filter

count - maximum results to return

visibleOnly - whether to filter by visibility

includeChildren - Include subpaths for search

Returns:

Map containing field names with a map of values and counts for each field

findFacetRanges

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Integer>> findFacetRanges(ResourceResolver resolver,
                                                                                                         java.util.List<FacetRangeField> rangeFields,
                                                                                                         java.lang.String resourceTypeFilter,
                                                                                                         java.lang.String componentFilter,
                                                                                                         int count)

Description copied from interface: SocialResourceProvider

Search Collections findFacets for cloud storage resources.

Specified by:

findFacetRanges in interface SocialResourceProvider

Parameters:

resolver - ResourceResolver for current search permissions

rangeFields - Fields for which facet range counts wanted

resourceTypeFilter - Resource type filter

componentFilter - Component filter

count - maximum results to return

Returns:

Map containing field names with a map of values and counts for each field

findFacetRanges

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Integer>> findFacetRanges(ResourceResolver resolver,
                                                                                                         java.util.List<FacetRangeField> rangeFields,
                                                                                                         java.lang.String resourceTypeFilter,
                                                                                                         java.lang.String componentFilter,
                                                                                                         int count,
                                                                                                         boolean visibleOnly)

Description copied from interface: SocialResourceProvider

Search Collections findFacets for cloud storage resources.

Specified by:

findFacetRanges in interface SocialResourceProvider

Parameters:

resolver - ResourceResolver for current search permissions

rangeFields - Fields for which facet range counts wanted

resourceTypeFilter - Resource type filter

componentFilter - Component filter

count - maximum results to return

visibleOnly - whether to filter by visibility

Returns:

Map containing field names with a map of values and counts for each field

findFacets

public FacetSearchResult findFacets(ResourceResolver resolver,
                                    java.util.List<java.lang.String> countFields,
                                    java.util.List<FacetRangeField> rangeFields,
                                    java.lang.String resourceTypeFilter,
                                    java.lang.String componentFilter,
                                    int count)

Description copied from interface: SocialResourceProvider

Search Collections findFacets for cloud storage resources.

Specified by:

findFacets in interface SocialResourceProvider

Parameters:

resolver - ResourceResolver for current search permissions

countFields - Fields for which facet counts wanted

rangeFields - Fields for which facet range counts wanted

resourceTypeFilter - Resource type filter

componentFilter - Component filter

count - maximum results to return

Returns:

Map containing field names with a map of values and counts for each field

findFacets

public FacetSearchResult findFacets(ResourceResolver resolver,
                                    java.util.List<java.lang.String> countFields,
                                    java.util.List<FacetRangeField> rangeFields,
                                    java.lang.String resourceTypeFilter,
                                    java.lang.String componentFilter,
                                    int count,
                                    boolean visibleOnly)

Description copied from interface: SocialResourceProvider

Search Collections findFacets for cloud storage resources.

Specified by:

findFacets in interface SocialResourceProvider

Parameters:

resolver - ResourceResolver for current search permissions

countFields - Fields for which facet counts wanted

rangeFields - Fields for which facet range counts wanted

resourceTypeFilter - Resource type filter

componentFilter - Component filter

count - maximum results to return

visibleOnly - whether to filter by visibility

Returns:

Map containing field names with a map of values and counts for each field

findFacets

public FacetSearchResult findFacets(ResourceResolver resolver,
                                    java.util.List<java.lang.String> countFields,
                                    java.util.List<FacetRangeField> rangeFields,
                                    java.lang.String resourceTypeFilter,
                                    java.lang.String componentFilter,
                                    int count,
                                    boolean visibleOnly,
                                    boolean includeChidren)

Description copied from interface: SocialResourceProvider

Search Collections findFacets for cloud storage resources.

Specified by:

findFacets in interface SocialResourceProvider

Parameters:

resolver - ResourceResolver for current search permissions

countFields - Fields for which facet counts wanted

rangeFields - Fields for which facet range counts wanted

resourceTypeFilter - Resource type filter

componentFilter - Component filter

count - maximum results to return

visibleOnly - whether to filter by visibility

includeChidren - Include results from paths subtree

Returns:

Map containing field names with a map of values and counts for each field

clearCache

public void clearCache()

Clear the cache.

incrementBy

public void incrementBy(Resource resource,
                        java.util.Map<java.lang.String,java.lang.Long> incrementMap)
                 throws SlingIOException,
                        PersistenceException

Description copied from interface: SocialResourceProvider

Add an arbitrary increment to the specified properties.

Specified by:

incrementBy in interface SocialResourceProvider

Parameters:

resource - the resource.

incrementMap - map with properties and their increment/decrement values.

Throws:

PersistenceException - on error

SlingIOException

incrementBy

public void incrementBy(Resource resource,
                        java.lang.String property,
                        java.lang.Long increment)
                 throws SlingIOException,
                        PersistenceException

Description copied from interface: SocialResourceProvider

Add an arbitrary increment to the specified counter property.

Specified by:

incrementBy in interface SocialResourceProvider

Parameters:

resource - - the resource to update.

property - - the name of the counter.

increment - - the amount to increase or decrease the counter.

Throws:

PersistenceException - on error

SlingIOException

increment

public void increment(Resource resource,
                      java.lang.String property)
               throws PersistenceException

Description copied from interface: SocialResourceProvider

Add one to the specified counter property.

Specified by:

increment in interface SocialResourceProvider

Parameters:

resource - - the resource to update.

property - - the name of the counter.

Throws:

PersistenceException - on error

decrement

public void decrement(Resource resource,
                      java.lang.String property)
               throws PersistenceException

Description copied from interface: SocialResourceProvider

Subtract one from the specified counter property.

Specified by:

decrement in interface SocialResourceProvider

Parameters:

resource - - the resource to update.

property - - the name of the counter.

Throws:

PersistenceException - on error

getCount

public long getCount(Resource resource,
                     java.lang.String property)

Description copied from interface: SocialResourceProvider

Return the value of the counter.

Specified by:

getCount in interface SocialResourceProvider

Parameters:

resource - - the resource to query.

property - - the name of the counter.

Returns:

the count

getLanguages

public java.util.List<java.lang.String> getLanguages()

Description copied from interface: SocialResourceProvider

Return a list of the languages that this provider can use to query resources.

Specified by:

getLanguages in interface SocialResourceProvider

Returns:

The list of valid languages.

getContentType

public java.lang.String getContentType()

Description copied from interface: SocialResourceProvider

Return the content type for pulling.

Specified by:

getContentType in interface SocialResourceProvider

Returns:

the content type as a string.

getMetaData

public ProviderMetaData getMetaData()

Description copied from interface: SocialResourceProvider

Gets details about the provider.

Specified by:

getMetaData in interface SocialResourceProvider

Returns:

the provider's metadata

See Also:

ProviderMetaData

facetRangeFieldHash

public java.lang.String facetRangeFieldHash(FacetRangeField rangeField)

Hash a range field for use as cache key.

Parameters:

rangeField - the range field to hash

Returns:

the hash

getResources

public java.util.Map<java.lang.String,Resource> getResources(ResourceResolver resolver,
                                                             java.util.List<java.lang.String> paths)

Description copied from interface: SocialResourceProvider

Fetch a group of resources all managed by this resource provider

Specified by:

getResources in interface SocialResourceProvider

Parameters:

resolver - the resolver to use

paths - the list of resources

Returns:

a map from path to Resource (which will be a NonExistingResource if the resource could not be fetched).

getAttachmentInputStream

public java.io.InputStream getAttachmentInputStream(ResourceResolver resolver,
                                                    java.lang.String path)
                                             throws java.io.IOException

Description copied from interface: SocialResourceProvider

Return an attachment resource as an InputStream.

Specified by:

getAttachmentInputStream in interface SocialResourceProvider

Parameters:

resolver - resolver to use to read the resource

path - path to the attachment resource

Returns:

the attachment as an InputStream

Throws:

java.io.IOException - on error

move

public Resource move(ResourceResolver resolver,
                     java.lang.String srcAbsPath,
                     java.lang.String destAbsPath)
              throws PersistenceException

Specified by:

move in interface SocialResourceProvider

Throws:

PersistenceException

getCommentIndex

public int getCommentIndex(java.lang.String path,
                           java.lang.String baseType,
                           ResourceResolver resourceResolver,
                           java.lang.String commentToCheck,
                           boolean visibleOnly)

Description copied from interface: SocialResourceProvider

Get index of a given reply amongst all replies of a post.

Specified by:

getCommentIndex in interface SocialResourceProvider

Parameters:

path - path to parent

baseType - base type of children to return (SocialUtils.PN_BASETYPE value) can be null/empty

resourceResolver - resolver to use

commentToCheck - comment whose index need to be found

visibleOnly - whether to (true) return only visible documents, or (false) all documents

Returns:

the index of the reply within all replies

getCountAndListChildren

public SocialResourceSearchResult<Resource> getCountAndListChildren(java.lang.String path,
                                                                    java.lang.String baseType,
                                                                    ResourceResolver resourceResolver,
                                                                    int offset,
                                                                    int size,
                                                                    java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> sortBy,
                                                                    boolean visibleOnly)

Get a count of the children of the resource at the path, filtered by child base type and visibility if requested. Also get a page of child resources as specified.

Specified by:

getCountAndListChildren in interface SocialResourceProvider

Parameters:

path - path to parent

baseType - base type of children to return (SocialUtils.PN_BASETYPE value) can be null/empty

resourceResolver - resolver to use

offset - offset to start at

size - number to return

sortBy - order to return children in

visibleOnly - whether to (true) return only visible documents, or (false) all documents

Returns:

SocialResourceSearchResult of the child resources.

countChildren

public long countChildren(Resource parent,
                          java.lang.String baseType,
                          boolean visibleOnly)

return count of all children or filtered (visible) children (not hidden due to denied/flagged as hidden). filter by the child base type. One level of children only

Specified by:

countChildren in interface SocialResourceProvider

Parameters:

parent - the parent resource

baseType - The social base type (SocialUtils.PN_BASETYPE value) of children to count (can be null/empty)

visibleOnly - if true, count only the 'visible' children

Returns:

The all children count or the visible children count

listChildren

public java.util.Iterator<Resource> listChildren(java.lang.String path,
                                                 java.lang.String baseType,
                                                 ResourceResolver resourceResolver,
                                                 int offset,
                                                 int size,
                                                 java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> sortBy,
                                                 boolean visibleOnly)

Get a list of the children of the resource at the path. Filtered by child base type.

Specified by:

listChildren in interface SocialResourceProvider

Parameters:

path - path to parent

baseType - base type of children to return (SocialUtils.PN_BASETYPE value) can be null/empty

resourceResolver - resolver to use

offset - offset to start at

size - number to return

sortBy - order to return children in

visibleOnly - whether to (true) return only visible documents, or (false) all documents

Returns:

iterator of the child resources