Package io.jmix.search.searching

Class SearchRequestScopeProvider

java.lang.Object

io.jmix.search.searching.SearchRequestScopeProvider

@Component("search_SearchRequestScopeProvider")
public class SearchRequestScopeProvider
extends Object

The class is responsible for calculating scopes used for building search requests in the search engine. It considers permissions for the current user and attaches additional subfields to indexed fields as needed. This component utilizes SearchSecurityDecorator to enforce security constraints, IndexConfigurationManager for managing index configurations, and SearchFieldsProvider to resolve fields of the index.

Field Summary

Fields

Modifier and Type	Field	Description
protected final IndexConfigurationManager	indexConfigurationManager
protected final SearchFieldsProvider	searchFieldsProvider
protected final SearchSecurityDecorator	securityDecorator

Constructor Summary

Constructors

Constructor	Description
SearchRequestScopeProvider(SearchSecurityDecorator securityDecorator, IndexConfigurationManager indexConfigurationManager, SearchFieldsProvider searchFieldsProvider)

Method Summary

Modifier and Type	Method	Description
protected Collection<String>	getEntitiesWithConfiguration(List<String> entities)
List<IndexSearchRequestScope>	getSearchRequestScope(List<String> entities, VirtualSubfieldsProvider virtualSubfieldsProvider)	Generates a list of IndexSearchRequestScope objects that define the scope of search requests for the specified entities.

Methods inherited from class java.lang.Object

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

Field Details

securityDecorator

protected final SearchSecurityDecorator securityDecorator

indexConfigurationManager

protected final IndexConfigurationManager indexConfigurationManager

searchFieldsProvider

protected final SearchFieldsProvider searchFieldsProvider

Constructor Details

SearchRequestScopeProvider

public SearchRequestScopeProvider(SearchSecurityDecorator securityDecorator,
 IndexConfigurationManager indexConfigurationManager,
 SearchFieldsProvider searchFieldsProvider)

Method Details

getSearchRequestScope

public List<IndexSearchRequestScope> getSearchRequestScope(List<String> entities,
 VirtualSubfieldsProvider virtualSubfieldsProvider)

Generates a list of IndexSearchRequestScope objects that define the scope of search requests for the specified entities. The method evaluates the entities allowed for the current user based on security constraints and resolves the fields required for search using the provided VirtualSubfieldsProvider.

Parameters:

entities - list of entity names to evaluate for search scope. If empty, all indexed entities are considered.

virtualSubfieldsProvider - provider used to resolve additional subfields for indexed fields.

Returns:

list of IndexSearchRequestScope objects representing the search scope for the specified entities, or an empty list if no valid scopes are resolved.

getEntitiesWithConfiguration

protected Collection<String> getEntitiesWithConfiguration(List<String> entities)