This is an automated email from the ASF dual-hosted git repository. rombert pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-tenant.git
commit 462b53a4a089388e320e54b3020da9de4a3bdd6a Author: Carsten Ziegeler <[email protected]> AuthorDate: Mon Jan 4 13:34:17 2016 +0000 SLING-5240 : Remove getAdministrativeResourceResolver() usage from org.apache.sling.tenant git-svn-id: https://svn.apache.org/repos/asf/sling/trunk@1722866 13f79535-47bb-0310-9956-ffa450edef68 --- .../org/apache/sling/tenant/TenantManager.java | 10 +-- .../sling/tenant/internal/TenantProviderImpl.java | 78 +++++++++++++++++++--- .../apache/sling/tenant/spi/TenantCustomizer.java | 8 ++- ...enantCustomizer.java => TenantManagerHook.java} | 42 ++++++------ .../org/apache/sling/tenant/spi/package-info.java | 2 +- 5 files changed, 102 insertions(+), 38 deletions(-) diff --git a/src/main/java/org/apache/sling/tenant/TenantManager.java b/src/main/java/org/apache/sling/tenant/TenantManager.java index 23b1c1a..63f3a07 100644 --- a/src/main/java/org/apache/sling/tenant/TenantManager.java +++ b/src/main/java/org/apache/sling/tenant/TenantManager.java @@ -47,7 +47,7 @@ public interface TenantManager { * properties. * <p> * After creating the tenant, the - * {@link org.apache.sling.tenant.spi.TenantCustomizer#setup(Tenant, org.apache.sling.api.resource.ResourceResolver)} + * {@link org.apache.sling.tenant.spi.TenantManagerHook#setup(Tenant)} * method is called to allow customizers to configure additional properties. * <p> * Before returning the newly created tenant object the data is persisted. @@ -72,7 +72,7 @@ public interface TenantManager { * property if the value is {@code null}. * <p> * Before returning the - * {@link org.apache.sling.tenant.spi.TenantCustomizer#setup(Tenant, org.apache.sling.api.resource.ResourceResolver)} + * {@link org.apache.sling.tenant.spi.TenantManagerHook#change(Tenant)} * method is called to allow customizers to configure additional properties. * * @param tenant The tenant whose property is to be set or remove. @@ -88,7 +88,7 @@ public interface TenantManager { * Sets or removes multiple properties on the tenant. * <p> * Before returning the - * {@link org.apache.sling.tenant.spi.TenantCustomizer#setup(Tenant, org.apache.sling.api.resource.ResourceResolver)} + * {@link org.apache.sling.tenant.spi.TenantManagerHook#change(Tenant)} * method is called to allow customizers to configure additional properties. * * @param tenant The tenant whose properties are to be modified. @@ -103,7 +103,7 @@ public interface TenantManager { * Removes one or more properties from the tenant. * <p> * Before returning the - * {@link org.apache.sling.tenant.spi.TenantCustomizer#setup(Tenant, org.apache.sling.api.resource.ResourceResolver)} + * {@link org.apache.sling.tenant.spi.TenantManagerHook#change(Tenant)} * method is called to allow customizers to configure additional properties * unless the {@code properties} parameter is {@code null} or empty. * @@ -120,7 +120,7 @@ public interface TenantManager { * Removes the given tenant. * <p> * Before returning the - * {@link org.apache.sling.tenant.spi.TenantCustomizer#remove(Tenant, org.apache.sling.api.resource.ResourceResolver)} + * {@link org.apache.sling.tenant.spi.TenantManagerHook#remove(Tenant)} * method is called to allow customizers to implement further cleanup upon * tenant removal. * diff --git a/src/main/java/org/apache/sling/tenant/internal/TenantProviderImpl.java b/src/main/java/org/apache/sling/tenant/internal/TenantProviderImpl.java index 72fe197..83be26e 100644 --- a/src/main/java/org/apache/sling/tenant/internal/TenantProviderImpl.java +++ b/src/main/java/org/apache/sling/tenant/internal/TenantProviderImpl.java @@ -32,12 +32,12 @@ import java.util.TreeMap; import org.apache.felix.scr.annotations.Activate; import org.apache.felix.scr.annotations.Component; import org.apache.felix.scr.annotations.Deactivate; -import org.apache.felix.scr.annotations.Properties; import org.apache.felix.scr.annotations.Property; import org.apache.felix.scr.annotations.PropertyUnbounded; import org.apache.felix.scr.annotations.Reference; import org.apache.felix.scr.annotations.ReferenceCardinality; import org.apache.felix.scr.annotations.ReferencePolicy; +import org.apache.felix.scr.annotations.References; import org.apache.felix.scr.annotations.Service; import org.apache.sling.api.resource.LoginException; import org.apache.sling.api.resource.ModifiableValueMap; @@ -53,6 +53,7 @@ import org.apache.sling.tenant.TenantManager; import org.apache.sling.tenant.TenantProvider; import org.apache.sling.tenant.internal.console.WebConsolePlugin; import org.apache.sling.tenant.spi.TenantCustomizer; +import org.apache.sling.tenant.spi.TenantManagerHook; import org.osgi.framework.BundleContext; import org.osgi.framework.Constants; import org.osgi.framework.Filter; @@ -69,15 +70,20 @@ import org.slf4j.LoggerFactory; label = "Apache Sling Tenant Provider", description = "Service responsible for providing Tenants", immediate = true) -@Service -@Properties(value = { - @Property(name = Constants.SERVICE_DESCRIPTION, value = "Apache Sling Tenant Provider") -}) -@Reference( +@Service(value = {TenantProvider.class, TenantManager.class}) +@Property(name = Constants.SERVICE_DESCRIPTION, value = "Apache Sling Tenant Provider") +@References({ + @Reference( name = "tenantSetup", referenceInterface = TenantCustomizer.class, cardinality = ReferenceCardinality.OPTIONAL_MULTIPLE, - policy = ReferencePolicy.DYNAMIC) + policy = ReferencePolicy.DYNAMIC), + @Reference( + name = "hook", + referenceInterface = TenantManagerHook.class, + cardinality = ReferenceCardinality.OPTIONAL_MULTIPLE, + policy = ReferencePolicy.DYNAMIC) +}) public class TenantProviderImpl implements TenantProvider, TenantManager { /** default log */ @@ -96,6 +102,9 @@ public class TenantProviderImpl implements TenantProvider, TenantManager { private SortedMap<Comparable<Object>, TenantCustomizer> registeredTenantHandlers = new TreeMap<Comparable<Object>, TenantCustomizer>( Collections.reverseOrder()); + private SortedMap<Comparable<Object>, TenantManagerHook> registeredHooks = new TreeMap<Comparable<Object>, TenantManagerHook>( + Collections.reverseOrder()); + @Property( value = {}, unbounded = PropertyUnbounded.ARRAY, @@ -146,9 +155,25 @@ public class TenantProviderImpl implements TenantProvider, TenantManager { return registeredTenantHandlers.values(); } + @SuppressWarnings("unused") + private synchronized void bindHook(TenantManagerHook action, Map<String, Object> config) { + registeredHooks.put(ServiceUtil.getComparableForServiceRanking(config), action); + } + + @SuppressWarnings("unused") + private synchronized void unbindHook(TenantManagerHook action, Map<String, Object> config) { + registeredHooks.remove(ServiceUtil.getComparableForServiceRanking(config)); + } + + private synchronized Collection<TenantManagerHook> getHooks() { + return registeredHooks.values(); + } + + @Override public Tenant getTenant(final String tenantId) { if (tenantId != null && tenantId.length() > 0) { return call(new ResourceResolverTask<Tenant>() { + @Override public Tenant call(ResourceResolver resolver) { Resource tenantRes = getTenantResource(resolver, tenantId); return (tenantRes != null) ? new TenantImpl(tenantRes) : null; @@ -160,10 +185,12 @@ public class TenantProviderImpl implements TenantProvider, TenantManager { return null; } + @Override public Iterator<Tenant> getTenants() { return getTenants(null); } + @Override public Iterator<Tenant> getTenants(final String tenantFilter) { final Filter filter; if (tenantFilter != null && tenantFilter.length() > 0) { @@ -177,6 +204,7 @@ public class TenantProviderImpl implements TenantProvider, TenantManager { } Iterator<Tenant> result = call(new ResourceResolverTask<Iterator<Tenant>>() { + @Override public Iterator<Tenant> call(ResourceResolver resolver) { Resource tenantRootRes = resolver.getResource(tenantRootPath); @@ -202,15 +230,17 @@ public class TenantProviderImpl implements TenantProvider, TenantManager { return result; } + @Override public Tenant create(final String tenantId, final Map<String, Object> properties) { return call(new ResourceResolverTask<Tenant>() { + @Override public Tenant call(ResourceResolver adminResolver) { try { // create the tenant Resource tenantRes = createTenantResource(adminResolver, tenantId, properties); TenantImpl tenant = new TenantImpl(tenantRes); adminResolver.commit(); - customizeTenant(tenantRes, tenant); + customizeTenant(tenantRes, tenant, true); adminResolver.commit(); // refresh tenant instance, as it copies property from @@ -231,8 +261,10 @@ public class TenantProviderImpl implements TenantProvider, TenantManager { }); } + @Override public void remove(final Tenant tenant) { call(new ResourceResolverTask<Void>() { + @Override public Void call(ResourceResolver resolver) { try { Resource tenantRes = getTenantResource(resolver, tenant.getId()); @@ -245,6 +277,14 @@ public class TenantProviderImpl implements TenantProvider, TenantManager { log.info("removeTenant: Unexpected problem calling TenantCustomizer " + ts, e); } } + // call tenant hooks + for (TenantManagerHook ts : getHooks()) { + try { + ts.remove(tenant); + } catch (Exception e) { + log.info("removeTenant: Unexpected problem calling TenantManagerHook " + ts, e); + } + } resolver.delete(tenantRes); resolver.commit(); @@ -258,8 +298,10 @@ public class TenantProviderImpl implements TenantProvider, TenantManager { }); } + @Override public void setProperty(final Tenant tenant, final String name, final Object value) { updateProperties(tenant, new PropertiesUpdater() { + @Override public void update(ModifiableValueMap properties) { if (value != null) { properties.put(name, value); @@ -270,8 +312,10 @@ public class TenantProviderImpl implements TenantProvider, TenantManager { }); } + @Override public void setProperties(final Tenant tenant, final Map<String, Object> properties) { updateProperties(tenant, new PropertiesUpdater() { + @Override public void update(ModifiableValueMap vm) { for (Entry<String, Object> entry : properties.entrySet()) { if (entry.getValue() != null) { @@ -284,8 +328,10 @@ public class TenantProviderImpl implements TenantProvider, TenantManager { }); } + @Override public void removeProperties(final Tenant tenant, final String... propertyNames) { updateProperties(tenant, new PropertiesUpdater() { + @Override public void update(ModifiableValueMap properties) { for (String name : propertyNames) { properties.remove(name); @@ -334,7 +380,7 @@ public class TenantProviderImpl implements TenantProvider, TenantManager { return resolver.getResource(tenantRootPath + "/" + tenantId); } - private void customizeTenant(final Resource tenantRes, final Tenant tenant) { + private void customizeTenant(final Resource tenantRes, final Tenant tenant, boolean isCreate) { // call tenant setup handler Map<String, Object> tenantProps = tenantRes.adaptTo(ModifiableValueMap.class); @@ -355,6 +401,17 @@ public class TenantProviderImpl implements TenantProvider, TenantManager { log.info("addTenant: Unexpected problem calling TenantCustomizer " + ts, e); } } + // call tenant hooks + for (TenantManagerHook ts : getHooks()) { + try { + Map<String, Object> props = (isCreate ? ts.setup(tenant) : ts.change(tenant)); + if (props != null) { + tenantProps.putAll(props); + } + } catch (Exception e) { + log.info("removeTenant: Unexpected problem calling TenantManagerHook " + ts, e); + } + } } private <T> T call(ResourceResolverTask<T> task) { @@ -377,6 +434,7 @@ public class TenantProviderImpl implements TenantProvider, TenantManager { private void updateProperties(final Tenant tenant, final PropertiesUpdater updater) { call(new ResourceResolverTask<Void>() { + @Override public Void call(ResourceResolver resolver) { try { Resource tenantRes = getTenantResource(resolver, tenant.getId()); @@ -388,7 +446,7 @@ public class TenantProviderImpl implements TenantProvider, TenantManager { ((TenantImpl) tenant).loadProperties(tenantRes); } - customizeTenant(tenantRes, tenant); + customizeTenant(tenantRes, tenant, false); resolver.commit(); if (tenant instanceof TenantImpl) { diff --git a/src/main/java/org/apache/sling/tenant/spi/TenantCustomizer.java b/src/main/java/org/apache/sling/tenant/spi/TenantCustomizer.java index 18785da..345197b 100644 --- a/src/main/java/org/apache/sling/tenant/spi/TenantCustomizer.java +++ b/src/main/java/org/apache/sling/tenant/spi/TenantCustomizer.java @@ -30,7 +30,11 @@ import aQute.bnd.annotation.ConsumerType; * * Tools can hook into the tenant creation, changing a tenant and removing * thereof by implementing this interface. + * + * @deprecated This interface will not be supported in future versions. Use + * {@link TenantManagerHook} instead. */ +@Deprecated @ConsumerType public interface TenantCustomizer { @@ -54,7 +58,7 @@ public interface TenantCustomizer { * property accessor methods. {@code null} or an empty map may be * returned to not add properties. */ - public Map<String, Object> setup(Tenant tenant, ResourceResolver resolver); + Map<String, Object> setup(Tenant tenant, ResourceResolver resolver); /** * Called to remove the setup for the given Tenant. This reverts all changes @@ -72,5 +76,5 @@ public interface TenantCustomizer { * persistence for further cleanup. Note, that this * {@code resolver} will have administrative privileges. */ - public void remove(Tenant tenant, ResourceResolver resolver); + void remove(Tenant tenant, ResourceResolver resolver); } diff --git a/src/main/java/org/apache/sling/tenant/spi/TenantCustomizer.java b/src/main/java/org/apache/sling/tenant/spi/TenantManagerHook.java similarity index 64% copy from src/main/java/org/apache/sling/tenant/spi/TenantCustomizer.java copy to src/main/java/org/apache/sling/tenant/spi/TenantManagerHook.java index 18785da..612f086 100644 --- a/src/main/java/org/apache/sling/tenant/spi/TenantCustomizer.java +++ b/src/main/java/org/apache/sling/tenant/spi/TenantManagerHook.java @@ -20,7 +20,6 @@ package org.apache.sling.tenant.spi; import java.util.Map; -import org.apache.sling.api.resource.ResourceResolver; import org.apache.sling.tenant.Tenant; import aQute.bnd.annotation.ConsumerType; @@ -30,47 +29,50 @@ import aQute.bnd.annotation.ConsumerType; * * Tools can hook into the tenant creation, changing a tenant and removing * thereof by implementing this interface. + * + * @since 1.1 */ @ConsumerType -public interface TenantCustomizer { +public interface TenantManagerHook { /** - * Method called to create or update the given tenant. The method may return - * additional properties to be added to the Tenant's property list. The - * ResourceResolver allows for access to the persistence. + * Method called to create the given tenant. The method may return + * additional properties to be added to the Tenant's property list. * <p> - * The {@code ResourceResolver.commit} method must not be called by this - * method. + * This method is not expected to throw an exception. Any exception thrown + * is logged but otherwise ignored. + * + * @param tenant The {@link Tenant} to be configured by this call + * @return Additional properties to be added to the tenant. These properties + * may later be accessed through the {@linkplain Tenant tenant's} + * property accessor methods. {@code null} or an empty map may be + * returned to not add properties. + */ + Map<String, Object> setup(Tenant tenant); + + /** + * Method called to update the given tenant. The method may return + * additional properties to be added to the Tenant's property list. * <p> * This method is not expected to throw an exception. Any exception thrown * is logged but otherwise ignored. * * @param tenant The {@link Tenant} to be configured by this call - * @param resolver The {@code ResourceResolver} providing access to the - * persistence for further setup. Note, that this - * {@code resolver} will have administrative privileges. * @return Additional properties to be added to the tenant. These properties * may later be accessed through the {@linkplain Tenant tenant's} * property accessor methods. {@code null} or an empty map may be * returned to not add properties. */ - public Map<String, Object> setup(Tenant tenant, ResourceResolver resolver); + Map<String, Object> change(Tenant tenant); /** * Called to remove the setup for the given Tenant. This reverts all changes - * done by the #setup method. The ResourceResolver allows for access to the - * persistence. - * <p> - * The {@code ResourceResolver.commit} method must not be called by this - * method. + * done by the #setup method. * <p> * This method is not expected to throw an exception. Any exception thrown * is logged but otherwise ignored. * * @param tenant The {@link Tenant} about to be removed - * @param resolver The {@code ResourceResolver} providing access to the - * persistence for further cleanup. Note, that this - * {@code resolver} will have administrative privileges. */ - public void remove(Tenant tenant, ResourceResolver resolver); + void remove(Tenant tenant); } diff --git a/src/main/java/org/apache/sling/tenant/spi/package-info.java b/src/main/java/org/apache/sling/tenant/spi/package-info.java index fa458c7..aa5c3f6 100644 --- a/src/main/java/org/apache/sling/tenant/spi/package-info.java +++ b/src/main/java/org/apache/sling/tenant/spi/package-info.java @@ -17,7 +17,7 @@ * under the License. */ -@Version("1.0") +@Version("1.1") package org.apache.sling.tenant.spi; import aQute.bnd.annotation.Version; -- To stop receiving notification emails like this one, please contact "[email protected]" <[email protected]>.
