Package org.apache.sling.tenant
Interface TenantProvider
@ProviderType
public interface TenantProvider
The
TenantProvider
defines the service interface
which may be asked for tenant instances
.-
Method Summary
Modifier and TypeMethodDescriptionReturns an iterator of alltenants
known to this provider.getTenants
(String tenantFilter) Returns an iterator oftenants
matching the giventenantFilter
.
-
Method Details
-
getTenant
-
getTenants
Returns an iterator of alltenants
known to this provider. If no tenants are known the iterator is empty.This method is equivalent to calling
getTenants(String)
withnull
or an empty string. -
getTenants
Returns an iterator oftenants
matching the giventenantFilter
.The
tenantFilter
is a valid OSGi filter string as defined in Section 3.2.6, Filter Syntax, of the OSGi Core Specification, Release 4 ornull
to return all tenants.Calling this method with an empty string or
null
is equivalent to calling thegetTenants()
method and returns all tenants.If no tenants match the
tenantFilter
the iterator is empty.null
is never returned.- Throws:
IllegalArgumentException
- if filter syntax is invalid. A more detailed exception may be wrapped by the exception.
-