Package org.hibernate.search.backend.lucene.multitenancy.impl

Class DiscriminatorMultiTenancyStrategy

java.lang.Object

org.hibernate.search.backend.lucene.multitenancy.impl.DiscriminatorMultiTenancyStrategy

All Implemented Interfaces:

MultiTenancyStrategy

public class DiscriminatorMultiTenancyStrategy
extends Object
implements MultiTenancyStrategy

Constructor Summary

Constructors

Constructor	Description
DiscriminatorMultiTenancyStrategy()

Method Summary

Modifier and Type	Method	Description
void	checkTenantId(String tenantId, EventContext backendContext)	Check that the tenant id value is consistent with the strategy.
void	checkTenantId(Set<String> tenantIds, EventContext context)	Check that the set of tenant id values is valid.
void	contributeToIndexedDocument(org.apache.lucene.document.Document document, String tenantId)	Contributes additional information to the indexed document.
org.apache.lucene.search.Query	filterOrNull(String tenantId)	Generate a filter for the given tenant ID, to be applied to search queries and update/delete operations.
org.apache.lucene.search.Query	filterOrNull(Set<String> tenantIds)	Generate a filter for the given set of tenant IDs, to be applied to search queries.
boolean	isMultiTenancySupported()	Indicates if the strategy supports multiTenancy.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiscriminatorMultiTenancyStrategy

public DiscriminatorMultiTenancyStrategy()

Method Detail

isMultiTenancySupported

public boolean isMultiTenancySupported()

Description copied from interface: MultiTenancyStrategy

Indicates if the strategy supports multiTenancy.

Specified by:

isMultiTenancySupported in interface MultiTenancyStrategy

Returns:

true if multiTenancy is supported, false otherwise.

contributeToIndexedDocument

public void contributeToIndexedDocument(org.apache.lucene.document.Document document,
                                        String tenantId)

Description copied from interface: MultiTenancyStrategy

Contributes additional information to the indexed document.

Specified by:

contributeToIndexedDocument in interface MultiTenancyStrategy

Parameters:

document - The indexed document.

tenantId - The tenant id.

filterOrNull

public org.apache.lucene.search.Query filterOrNull(String tenantId)

Description copied from interface: MultiTenancyStrategy

Generate a filter for the given tenant ID, to be applied to search queries and update/delete operations.

Specified by:

filterOrNull in interface MultiTenancyStrategy

Parameters:

tenantId - The tenant id.

Returns:

The filter, or null if no filter is necessary.

filterOrNull

public org.apache.lucene.search.Query filterOrNull(Set<String> tenantIds)

Description copied from interface: MultiTenancyStrategy

Generate a filter for the given set of tenant IDs, to be applied to search queries.

Specified by:

filterOrNull in interface MultiTenancyStrategy

Parameters:

tenantIds - The set of tenant ids.

Returns:

The filter, or null if no filter is necessary.

checkTenantId

public void checkTenantId(String tenantId,
                          EventContext backendContext)

Description copied from interface: MultiTenancyStrategy

Check that the tenant id value is consistent with the strategy.

Specified by:

checkTenantId in interface MultiTenancyStrategy

Parameters:

tenantId - The tenant id.

backendContext - The backend.

checkTenantId

public void checkTenantId(Set<String> tenantIds,
                          EventContext context)

Description copied from interface: MultiTenancyStrategy

Check that the set of tenant id values is valid.

Specified by:

checkTenantId in interface MultiTenancyStrategy

Parameters:

tenantIds - The set of tenant ids.

context - The context to add to exceptions (if any).