org.apache.sling.tenant.internal

Class TenantProviderImpl

java.lang.Object

org.apache.sling.tenant.internal.TenantProviderImpl

All Implemented Interfaces:

TenantManager, TenantProvider

public class TenantProviderImpl
extends Object
implements TenantProvider, TenantManager

Resource based Tenant Provider implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TenantProviderImpl.Configuration

Constructor Summary

Constructors

Constructor and Description
TenantProviderImpl()

Method Summary

Modifier and Type	Method and Description
protected void	activate(org.osgi.framework.BundleContext bundleContext, TenantProviderImpl.Configuration configuration)
Tenant	create(String tenantId, Map<String,Object> properties) Creates a new tenant with the given tenant ID and the initial set of properties.
protected void	deactivate()
Tenant	getTenant(String tenantId) Returns the Tenant with the given tenantId or null if no such tenant exists.
Iterator<Tenant>	getTenants() Returns an iterator of all tenants known to this provider.
Iterator<Tenant>	getTenants(String tenantFilter) Returns an iterator of tenants matching the given tenantFilter.
void	remove(Tenant tenant) Removes the given tenant.
void	removeProperties(Tenant tenant, String... propertyNames) Removes one or more properties from the tenant.
void	setProperties(Tenant tenant, Map<String,Object> properties) Sets or removes multiple properties on the tenant.
void	setProperty(Tenant tenant, String name, Object value) Sets a single property of the tenant to a new value or removes the property if the value is null.

Methods inherited from class java.lang.Object

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

Constructor Detail

TenantProviderImpl

public TenantProviderImpl()

Method Detail

activate

protected void activate(org.osgi.framework.BundleContext bundleContext,
                        TenantProviderImpl.Configuration configuration)

deactivate

protected void deactivate()

getTenant

public Tenant getTenant(String tenantId)

Description copied from interface: TenantProvider

Returns the Tenant with the given tenantId or null if no such tenant exists.

Specified by:

getTenant in interface TenantProvider

getTenants

public Iterator<Tenant> getTenants()

Description copied from interface: TenantProvider

Returns an iterator of all tenants known to this provider. If no tenants are known the iterator is empty.

This method is equivalent to calling TenantProvider.getTenants(String) with null or an empty string.

Specified by:

getTenants in interface TenantProvider

getTenants

public Iterator<Tenant> getTenants(String tenantFilter)

Description copied from interface: TenantProvider

Returns an iterator of tenants matching the given tenantFilter.

The tenantFilter is a valid OSGi filter string as defined in Section 3.2.6, Filter Syntax, of the OSGi Core Specification, Release 4 or null to return all tenants.

Calling this method with an empty string or null is equivalent to calling the TenantProvider.getTenants() method and returns all tenants.

If no tenants match the tenantFilter the iterator is empty. null is never returned.

Specified by:

getTenants in interface TenantProvider

create

public Tenant create(String tenantId,
                     Map<String,Object> properties)

Description copied from interface: TenantManager

Creates a new tenant with the given tenant ID and the initial set of properties.

After creating the tenant, the TenantManagerHook.setup(Tenant) method is called to allow customizers to configure additional properties.

Before returning the newly created tenant object the data is persisted.

Specified by:

create in interface TenantManager

Parameters:

tenantId - The name of the new tenant. This name must not be null or an empty string. It must also not be the same name as that of an existing tenant.

properties - An optional map of initial properties. This may be null to not preset any properties. It is recommended, though, that this map contain at least the Tenant.PROP_NAME and Tenant.PROP_DESCRIPTION properties.

Returns:

The newly created Tenant instance or null if a tenant with the id already exists.

remove

public void remove(Tenant tenant)

Description copied from interface: TenantManager

Removes the given tenant.

Before returning the TenantManagerHook.remove(Tenant) method is called to allow customizers to implement further cleanup upon tenant removal.

Specified by:

remove in interface TenantManager

Parameters:

tenant - The tenant to remove.

setProperty

public void setProperty(Tenant tenant,
                        String name,
                        Object value)

Description copied from interface: TenantManager

Sets a single property of the tenant to a new value or removes the property if the value is null.

Before returning the TenantManagerHook.change(Tenant) method is called to allow customizers to configure additional properties.

Specified by:

setProperty in interface TenantManager

Parameters:

tenant - The tenant whose property is to be set or remove.

name - The name of the property to set or remove.

value - The new value of the property. If this value is null the property is actually removed.

setProperties

public void setProperties(Tenant tenant,
                          Map<String,Object> properties)

Description copied from interface: TenantManager

Sets or removes multiple properties on the tenant.

Before returning the TenantManagerHook.change(Tenant) method is called to allow customizers to configure additional properties.

Specified by:

setProperties in interface TenantManager

Parameters:

tenant - The tenant whose properties are to be modified.

properties - The map of properties to set or remove. A property whose value is null is removed from the tenant.

removeProperties

public void removeProperties(Tenant tenant,
                             String... propertyNames)

Description copied from interface: TenantManager

Removes one or more properties from the tenant.

Before returning the TenantManagerHook.change(Tenant) method is called to allow customizers to configure additional properties unless the properties parameter is null or empty.

Specified by:

removeProperties in interface TenantManager

Parameters:

tenant - The tenant from which to remove properties.

propertyNames - The list of properties to be removed. If this is null or empty, nothing happens and the TenantCustomizer is not called.