com.adobe.cq.social.srp

Interface SocialResourceProvider

All Superinterfaces:

ModifyingResourceProvider, QueriableResourceProvider, ResourceProvider

All Known Subinterfaces:

CachingResourceProvider

All Known Implementing Classes:

UGCCResourceProvider

public interface SocialResourceProvider
extends ResourceProvider, ModifyingResourceProvider, QueriableResourceProvider

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SocialResourceProvider.PrefetchPerResult Used with SocialResourcePrefetch to specify additional resources to fetch.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JSRPQUERY JSRP Query language.
static java.lang.String	PARAM_BROWSER_LANGUAGE browser language param.
static java.lang.String	PARAM_EXPECTED_LANGUAGE expected language param, this is explicitly set in the search widget, acts as a user override.
static java.lang.String	PARAM_PAGE_LANGUAGE page language param.
static java.lang.String	PARAM_USER_PREFFERED_LANGUAGE User preferred language param, read from user profile
static java.lang.String	SOLRQUERY Used in factory.

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

Method Summary

Modifier and Type	Method and Description
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 baseType) 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).
void	decrement(Resource resource, java.lang.String property) Subtract one from the specified counter property.
SocialResourceSearchResult<Resource>	find(ResourceResolver resolver, java.lang.String component, java.lang.String query, java.util.List<SearchSortField> sortFields, int offset, int limit, boolean requiresTotal) Return a result list of resources given a component and a query.
SocialResourceSearchResult<Resource>	find(ResourceResolver resolver, java.lang.String component, java.lang.String query, 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> facetRanges, 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> facetRanges, 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> fieldNames, java.util.List<FacetRangeField> facetRanges, 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> fieldNames, java.util.List<FacetRangeField> facetRanges, 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> fieldNames, java.util.List<FacetRangeField> facetRanges, java.lang.String resourceTypeFilter, java.lang.String componentFilter, int count, boolean visibleOnly, boolean includeChildren) 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 isVisibleOnly, boolean includeChildren) Search Collections findFacets for cloud storage resources.
java.lang.String	getASIPath() Get the ASI path (provider root).
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.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) Deprecated. Solr and Lucene only use the first mltField when using a stream as the document (our use case) See: https://issues.apache.org/jira/browse/SOLR-5351?
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.
java.util.Map<java.lang.String,Resource>	getResources(ResourceResolver resolver, java.util.List<java.lang.String> resources) Fetch a group of resources all managed by this resource provider
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(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)
void	setConfig(SocialResourceConfiguration config) Set the configuration for the provider.

Methods inherited from interface org.apache.sling.api.resource.ModifyingResourceProvider

commit, create, delete, hasChanges, revert

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

findResources, queryResources

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

getResource, getResource, listChildren

Field Detail

SOLRQUERY

static final java.lang.String SOLRQUERY

Used in factory.

See Also:

Constant Field Values

JSRPQUERY

static final java.lang.String JSRPQUERY

JSRP Query language.

See Also:

Constant Field Values

PARAM_USER_PREFFERED_LANGUAGE

static final java.lang.String PARAM_USER_PREFFERED_LANGUAGE

User preferred language param, read from user profile

See Also:

Constant Field Values

PARAM_BROWSER_LANGUAGE

static final java.lang.String PARAM_BROWSER_LANGUAGE

browser language param.

See Also:

Constant Field Values

PARAM_PAGE_LANGUAGE

static final java.lang.String PARAM_PAGE_LANGUAGE

page language param.

See Also:

Constant Field Values

PARAM_EXPECTED_LANGUAGE

static final java.lang.String PARAM_EXPECTED_LANGUAGE

expected language param, this is explicitly set in the search widget, acts as a user override.

See Also:

Constant Field Values

Method Detail

getCommentIndex

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.

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

listChildren

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.

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

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. Filtered by child base type.

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

listChildren

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.

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

getCountAndListChildren

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.

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

long countChildren(Resource parent)

return count of all children (one level).

Parameters:

parent - the parent resource

Returns:

The all children count or the visible children count

countChildren

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

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

Parameters:

parent - the parent resource

baseType - 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

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

Parameters:

parent - the parent resource

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

Returns:

The all children count or the visible children count

countChildren

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

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

countChildren

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). filter by the child base type. One level of children only

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

setConfig

void setConfig(SocialResourceConfiguration config)

Set the configuration for the provider.

Parameters:

config - The configuration

getASIPath

java.lang.String getASIPath()

Get the ASI path (provider root).

Returns:

The provider root.

getMLTResults

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

Deprecated. Solr and Lucene only use the first mltField when using a stream as the document (our use case) See: https://issues.apache.org/jira/browse/SOLR-5351?

Return a list of related posts, given a query.

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.

getMLTResults

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.

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

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

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

Parameters:

resolver - The resource resolver.

component - The component for filtering on

query - 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

Returns:

The matching documents.

find

SocialResourceSearchResult<Resource> find(ResourceResolver resolver,
                                          java.lang.String component,
                                          java.lang.String query,
                                          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.

Parameters:

resolver - The resource resolver.

component - The component for filtering on

query - 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

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.

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

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.

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

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 isVisibleOnly,
                                                                                             boolean includeChildren)

Search Collections findFacets for cloud storage resources.

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

isVisibleOnly - 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

findFacets

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

Search Collections findFacets for cloud storage resources.

Parameters:

resolver - ResourceResolver for current search permissions

fieldNames - Fields for which facet counts wanted

facetRanges - 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

FacetSearchResult findFacets(ResourceResolver resolver,
                             java.util.List<java.lang.String> fieldNames,
                             java.util.List<FacetRangeField> facetRanges,
                             java.lang.String resourceTypeFilter,
                             java.lang.String componentFilter,
                             int count,
                             boolean visibleOnly,
                             boolean includeChildren)

Search Collections findFacets for cloud storage resources.

Parameters:

resolver - ResourceResolver for current search permissions

fieldNames - Fields for which facet counts wanted

facetRanges - 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

includeChildren - Include results from paths subtree

Returns:

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

findFacets

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

Search Collections findFacets for cloud storage resources.

Parameters:

resolver - ResourceResolver for current search permissions

fieldNames - Fields for which facet counts wanted

facetRanges - 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

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

Search Collections findFacets for cloud storage resources.

Parameters:

resolver - ResourceResolver for current search permissions

facetRanges - 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

findFacetRanges

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

Search Collections findFacets for cloud storage resources.

Parameters:

resolver - ResourceResolver for current search permissions

facetRanges - 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

getLanguages

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

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

Returns:

The list of valid languages.

getContentType

java.lang.String getContentType()

Return the content type for pulling.

Returns:

the content type as a string.

increment

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

Add one to the specified counter property.

Parameters:

resource - - the resource to update.

property - - the name of the counter.

Throws:

PersistenceException - on error

decrement

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

Subtract one from the specified counter property.

Parameters:

resource - - the resource to update.

property - - the name of the counter.

Throws:

PersistenceException - on error

incrementBy

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

Add an arbitrary increment to the specified counter property.

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

incrementBy

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

Add an arbitrary increment to the specified properties.

Parameters:

resource - the resource.

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

Throws:

PersistenceException - on error

getCount

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

Return the value of the counter.

Parameters:

resource - - the resource to query.

property - - the name of the counter.

Returns:

the count

getMetaData

ProviderMetaData getMetaData()

Gets details about the provider.

Returns:

the provider's metadata

See Also:

ProviderMetaData

getResources

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

Fetch a group of resources all managed by this resource provider

Parameters:

resolver - the resolver to use

resources - the list of resources

Returns:

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

getAttachmentInputStream

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

Return an attachment resource as an InputStream.

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

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

Throws:

PersistenceException

findFacets

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. It can return the first page of results that match both the scored and unscored query strings.

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.