Apache Sling Resource Presence

Clone this repo:
  1. 630cf41 SLING-12094 - Use GitHub for the Maven scm.url value by Robert Munteanu · 6 months ago master
  2. ab05745 SLING-11958 Update to Sling Bundle Parent 51 by Oliver Lietz · 9 months ago
  3. 76dcd29 SLING-11473 Update Testing PaxExam to 4.0.0 by Oliver Lietz · 9 months ago
  4. 34ee41e build on Linux only by Oliver Lietz · 10 months ago
  5. 3989ee2 update build plugins by Oliver Lietz · 10 months ago

Apache Sling

Build Status Test Status Coverage Sonarcloud Status JavaDoc Maven Central License

Apache Sling Resource Presence

This module is part of the Apache Sling project.

This module creates proxy OSGi services that are registered only if specific resources are present.

Like for example:

@Reference(target="(path=/content/foo/bar)")
private ResourcePresence barIsPresent;

The barIsPresent service is registered only if the /content/foo/bar resource is present, allowing OSGi components to be dependent on the presence of specific resources.

This is mostly meant for testing, to wait for test content before running specific tests.

Getting Started

  1. Configure a service user mapping for org.apache.sling.resource.presence to allow reading resources, using e.g. service user sling-readall.

  2. Configure a presenter to observe a resource by path, e.g. path=/apps

    Whenever resource /apps is available the presenter will register an OSGi service for it and unregister it whenever /apps gets removed.

  3. You can depend on that service now, e.g. using a @Reference annotation with a target on your component:

        @Reference(
            target = "(path=/apps)"
        )
        private ResourcePresence apps;
    

Using Resource Presence with Pax Exam

When running tests with resources involved, you can use a resource presence to delay test execution until required resources are available.

@Inject
@Filter(value = "(path=/apps)")
private ResourcePresence apps;

@Configuration
public Option[] configuration() {
    return options(
        [...],
        factoryConfiguration("org.apache.sling.resource.presence.internal.ResourcePresenter")
            .put("path", "/apps")
            .asOption()
    );
}

@Test
public void testApps() {
    assertThat(apps.getPath(), is("/apps"));
}