use of org.apache.sling.resourceresolver.impl.providers.ResourceProviderTracker.ChangeListener in project sling by apache.
the class ResourceResolverFactoryActivator method activate.
// ---------- SCR Integration ---------------------------------------------
/**
* Activates this component (called by SCR before)
*/
@Activate
protected void activate(final BundleContext bundleContext, final ResourceResolverFactoryConfig config) {
this.bundleContext = bundleContext;
this.config = config;
final BidiMap virtuals = new TreeBidiMap();
for (int i = 0; config.resource_resolver_virtual() != null && i < config.resource_resolver_virtual().length; i++) {
final String[] parts = Mapping.split(config.resource_resolver_virtual()[i]);
virtuals.put(parts[0], parts[2]);
}
virtualURLMap = virtuals;
final List<Mapping> maps = new ArrayList<>();
for (int i = 0; config.resource_resolver_mapping() != null && i < config.resource_resolver_mapping().length; i++) {
maps.add(new Mapping(config.resource_resolver_mapping()[i]));
}
final Mapping[] tmp = maps.toArray(new Mapping[maps.size()]);
// check whether direct mappings are allowed
if (config.resource_resolver_allowDirect()) {
final Mapping[] tmp2 = new Mapping[tmp.length + 1];
tmp2[0] = Mapping.DIRECT;
System.arraycopy(tmp, 0, tmp2, 1, tmp.length);
mappings = tmp2;
} else {
mappings = tmp;
}
// from configuration if available
searchPath = config.resource_resolver_searchpath();
if (searchPath != null && searchPath.length > 0) {
for (int i = 0; i < searchPath.length; i++) {
// ensure leading slash
if (!searchPath[i].startsWith("/")) {
searchPath[i] = "/" + searchPath[i];
}
// ensure trailing slash
if (!searchPath[i].endsWith("/")) {
searchPath[i] += "/";
}
}
}
if (searchPath == null) {
searchPath = new String[] { "/" };
}
// the root of the resolver mappings
mapRoot = config.resource_resolver_map_location();
mapRootPrefix = mapRoot + '/';
final String[] paths = config.resource_resolver_map_observation();
this.observationPaths = new Path[paths.length];
for (int i = 0; i < paths.length; i++) {
this.observationPaths[i] = new Path(paths[i]);
}
// vanity path white list
this.vanityPathWhiteList = null;
String[] vanityPathPrefixes = config.resource_resolver_vanitypath_whitelist();
if (vanityPathPrefixes != null) {
final List<String> prefixList = new ArrayList<>();
for (final String value : vanityPathPrefixes) {
if (value.trim().length() > 0) {
if (value.trim().endsWith("/")) {
prefixList.add(value.trim());
} else {
prefixList.add(value.trim() + "/");
}
}
}
if (prefixList.size() > 0) {
this.vanityPathWhiteList = prefixList.toArray(new String[prefixList.size()]);
}
}
// vanity path black list
this.vanityPathBlackList = null;
vanityPathPrefixes = config.resource_resolver_vanitypath_blacklist();
if (vanityPathPrefixes != null) {
final List<String> prefixList = new ArrayList<>();
for (final String value : vanityPathPrefixes) {
if (value.trim().length() > 0) {
if (value.trim().endsWith("/")) {
prefixList.add(value.trim());
} else {
prefixList.add(value.trim() + "/");
}
}
}
if (prefixList.size() > 0) {
this.vanityPathBlackList = prefixList.toArray(new String[prefixList.size()]);
}
}
// check for required property
Set<String> requiredResourceProvidersLegacy = getStringSet(config.resource_resolver_required_providers());
Set<String> requiredResourceProviderNames = getStringSet(config.resource_resolver_required_providernames());
boolean hasLegacyRequiredProvider = false;
if (requiredResourceProvidersLegacy != null) {
hasLegacyRequiredProvider = requiredResourceProvidersLegacy.remove(ResourceResolverFactoryConfig.LEGACY_REQUIRED_PROVIDER_PID);
if (!requiredResourceProvidersLegacy.isEmpty()) {
logger.error("ResourceResolverFactory is using deprecated required providers configuration (resource.resolver.required.providers" + "). Please change to use the property resource.resolver.required.providernames for values: " + requiredResourceProvidersLegacy);
} else {
requiredResourceProvidersLegacy = null;
}
}
if (hasLegacyRequiredProvider) {
final boolean hasRequiredProvider;
if (requiredResourceProviderNames != null) {
hasRequiredProvider = !requiredResourceProviderNames.add(ResourceResolverFactoryConfig.REQUIRED_PROVIDER_NAME);
} else {
hasRequiredProvider = false;
requiredResourceProviderNames = Collections.singleton(ResourceResolverFactoryConfig.REQUIRED_PROVIDER_NAME);
}
if (hasRequiredProvider) {
logger.warn("ResourceResolverFactory is using deprecated required providers configuration (resource.resolver.required.providers" + ") with value '" + ResourceResolverFactoryConfig.LEGACY_REQUIRED_PROVIDER_PID + ". Please remove this configuration property. " + ResourceResolverFactoryConfig.REQUIRED_PROVIDER_NAME + " is already contained in the property resource.resolver.required.providernames.");
} else {
logger.warn("ResourceResolverFactory is using deprecated required providers configuration (resource.resolver.required.providers" + ") with value '" + ResourceResolverFactoryConfig.LEGACY_REQUIRED_PROVIDER_PID + ". Please remove this configuration property and add " + ResourceResolverFactoryConfig.REQUIRED_PROVIDER_NAME + " to the property resource.resolver.required.providernames.");
}
}
// for testing: if we run unit test, both trackers are set from the outside
if (this.resourceProviderTracker == null) {
this.resourceProviderTracker = new ResourceProviderTracker();
this.changeListenerWhiteboard = new ResourceChangeListenerWhiteboard();
this.preconds.activate(this.bundleContext, requiredResourceProvidersLegacy, requiredResourceProviderNames, resourceProviderTracker);
this.changeListenerWhiteboard.activate(this.bundleContext, this.resourceProviderTracker, searchPath);
this.resourceProviderTracker.activate(this.bundleContext, this.eventAdmin, new ChangeListener() {
@Override
public void providerAdded() {
if (factoryRegistration == null) {
checkFactoryPreconditions(null, null);
}
}
@Override
public void providerRemoved(final String name, final String pid, final boolean stateful, final boolean isUsed) {
if (factoryRegistration != null) {
if (isUsed && (stateful || config.resource_resolver_providerhandling_paranoid())) {
unregisterFactory();
}
checkFactoryPreconditions(name, pid);
}
}
});
} else {
this.preconds.activate(this.bundleContext, requiredResourceProvidersLegacy, requiredResourceProviderNames, resourceProviderTracker);
this.checkFactoryPreconditions(null, null);
}
}
use of org.apache.sling.resourceresolver.impl.providers.ResourceProviderTracker.ChangeListener in project sling by apache.
the class ResourceProviderTrackerTest method testActivationDeactivation.
@Test
public void testActivationDeactivation() throws Exception {
final BundleContext bundleContext = MockOsgi.newBundleContext();
final EventAdmin eventAdmin = mock(EventAdmin.class);
final Fixture fixture = new Fixture(bundleContext);
final ResourceProviderTracker tracker = new ResourceProviderTracker();
tracker.setObservationReporterGenerator(new SimpleObservationReporterGenerator(new NoDothingObservationReporter()));
// create boolean markers for the listener
final AtomicBoolean addedCalled = new AtomicBoolean(false);
final AtomicBoolean removedCalled = new AtomicBoolean(false);
final ChangeListener listener = new ChangeListener() {
@Override
public void providerAdded() {
addedCalled.set(true);
}
@Override
public void providerRemoved(String name, String pid, boolean stateful, boolean used) {
removedCalled.set(true);
}
};
// activate and check that no listener is called yet
tracker.activate(bundleContext, eventAdmin, listener);
assertFalse(addedCalled.get());
assertFalse(removedCalled.get());
// add a new resource provider
@SuppressWarnings("unchecked") ResourceProvider<Object> rp = mock(ResourceProvider.class);
final ResourceProviderInfo info = fixture.registerResourceProvider(rp, "/", AuthType.no);
// check added is called but not removed
assertTrue(addedCalled.get());
assertFalse(removedCalled.get());
// verify a single provider
assertThat(tracker.getResourceProviderStorage().getAllHandlers().size(), equalTo(1));
// reset boolean markers
addedCalled.set(false);
removedCalled.set(false);
// remove provider
fixture.unregisterResourceProvider(info);
// verify removed is called but not added
assertTrue(removedCalled.get());
assertFalse(addedCalled.get());
// no provider anymore
assertThat(tracker.getResourceProviderStorage().getAllHandlers().size(), equalTo(0));
}
use of org.apache.sling.resourceresolver.impl.providers.ResourceProviderTracker.ChangeListener in project sling by apache.
the class ResourceProviderTrackerTest method testReactivation.
@Test
public void testReactivation() throws Exception {
final BundleContext bundleContext = MockOsgi.newBundleContext();
final EventAdmin eventAdmin = mock(EventAdmin.class);
final Fixture fixture = new Fixture(bundleContext);
final ResourceProviderTracker tracker = new ResourceProviderTracker();
tracker.setObservationReporterGenerator(new SimpleObservationReporterGenerator(new NoDothingObservationReporter()));
// create boolean markers for the listener
final AtomicBoolean addedCalled = new AtomicBoolean(false);
final AtomicBoolean removedCalled = new AtomicBoolean(false);
final ChangeListener listener = new ChangeListener() {
@Override
public void providerAdded() {
addedCalled.set(true);
}
@Override
public void providerRemoved(String name, String pid, boolean stateful, boolean used) {
removedCalled.set(true);
}
};
// activate and check that no listener is called yet
tracker.activate(bundleContext, eventAdmin, listener);
assertFalse(addedCalled.get());
assertFalse(removedCalled.get());
// activate and check that no listener is called yet
@SuppressWarnings("unchecked") ResourceProvider<Object> rp = mock(ResourceProvider.class);
final ResourceProviderInfo info = fixture.registerResourceProvider(rp, "/", AuthType.no);
// check added is called but not removed
assertTrue(addedCalled.get());
assertFalse(removedCalled.get());
// verify a single provider
assertThat(tracker.getResourceProviderStorage().getAllHandlers().size(), equalTo(1));
// reset boolean markers
addedCalled.set(false);
removedCalled.set(false);
// add overlay provider
final ResourceProviderInfo infoOverlay = fixture.registerResourceProvider(rp, "/", AuthType.no);
// check added and removed is called
assertTrue(addedCalled.get());
assertTrue(removedCalled.get());
// verify a single provider
assertThat(tracker.getResourceProviderStorage().getAllHandlers().size(), equalTo(1));
// reset boolean markers
addedCalled.set(false);
removedCalled.set(false);
// unregister overlay provider
fixture.unregisterResourceProvider(infoOverlay);
// check added and removed is called
assertTrue(addedCalled.get());
assertTrue(removedCalled.get());
// verify a single provider
assertThat(tracker.getResourceProviderStorage().getAllHandlers().size(), equalTo(1));
// reset boolean markers
addedCalled.set(false);
removedCalled.set(false);
// unregister first provider
fixture.unregisterResourceProvider(info);
// check removed is called but not added
assertTrue(removedCalled.get());
assertFalse(addedCalled.get());
// verify no provider
assertThat(tracker.getResourceProviderStorage().getAllHandlers().size(), equalTo(0));
}
Aggregations