Package org.apache.sling.tenant
Interface TenantProvider
-
@ProviderType public interface TenantProvider
TheTenantProvider
defines the service interface which may be asked fortenant instances
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Tenant
getTenant(java.lang.String tenantId)
java.util.Iterator<Tenant>
getTenants()
Returns an iterator of alltenants
known to this provider.java.util.Iterator<Tenant>
getTenants(java.lang.String tenantFilter)
Returns an iterator oftenants
matching the giventenantFilter
.
-
-
-
Method Detail
-
getTenant
Tenant getTenant(java.lang.String tenantId)
-
getTenants
java.util.Iterator<Tenant> 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
java.util.Iterator<Tenant> getTenants(java.lang.String tenantFilter)
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:
java.lang.IllegalArgumentException
- if filter syntax is invalid. A more detailed exception may be wrapped by the exception.
-
-