Package org.apache.sling.tenant
Interface TenantProvider
-
@ProviderType public interface TenantProviderTheTenantProviderdefines the service interface which may be asked fortenant instances.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description TenantgetTenant(java.lang.String tenantId)java.util.Iterator<Tenant>getTenants()Returns an iterator of alltenantsknown to this provider.java.util.Iterator<Tenant>getTenants(java.lang.String tenantFilter)Returns an iterator oftenantsmatching the giventenantFilter.
-
-
-
Method Detail
-
getTenant
Tenant getTenant(java.lang.String tenantId)
-
getTenants
java.util.Iterator<Tenant> getTenants()
Returns an iterator of alltenantsknown to this provider. If no tenants are known the iterator is empty.This method is equivalent to calling
getTenants(String)withnullor an empty string.
-
getTenants
java.util.Iterator<Tenant> getTenants(java.lang.String tenantFilter)
Returns an iterator oftenantsmatching the giventenantFilter.The
tenantFilteris a valid OSGi filter string as defined in Section 3.2.6, Filter Syntax, of the OSGi Core Specification, Release 4 ornullto return all tenants.Calling this method with an empty string or
nullis equivalent to calling thegetTenants()method and returns all tenants.If no tenants match the
tenantFilterthe iterator is empty.nullis never returned.- Throws:
java.lang.IllegalArgumentException- if filter syntax is invalid. A more detailed exception may be wrapped by the exception.
-
-