Package org.apache.sling.resourcemerger.spi

Interface MergedResourcePicker

  • @Deprecated
@ConsumerType
public interface MergedResourcePicker
    Deprecated.
    Use new MergedResourcePicker2 instead.
    Service interface which can be implemented to define an algorithm used to pick resources to be merged. For each picker service, a separate ResourceProvider will be exposed at the MERGE_ROOT of the picker.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String MERGE_ROOT
      Deprecated.
      Service property name identifying the root path for the merged resources.
      static String READ_ONLY
      Deprecated.
      Service property name specifying whether the resources are read-only or support CRUD operations.
      static String TRAVERSE_PARENT
      Deprecated.
      Service property name specifying whether the parent hierarchy is traversed to check for hiding properties.

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      @NotNull List<@NotNull org.apache.sling.api.resource.Resource> pickResources​(@NotNull org.apache.sling.api.resource.ResourceResolver resolver, @NotNull String relativePath)
      Deprecated.
      Method invoked by the MergingResourceProvider to identify the resources to be merged for a given relative path.

    • Field Detail

      • MERGE_ROOT

        static final String MERGE_ROOT
        Deprecated.
        Service property name identifying the root path for the merged resources. By convention, starts, with /mnt, although this is by no means required. The value of this service property must be of type String and must not end in a slash.
        See Also:
        Constant Field Values

      • READ_ONLY

        static final String READ_ONLY
        Deprecated.
        Service property name specifying whether the resources are read-only or support CRUD operations. If not specified this property defaults to true. The value of this property must be of type Boolean.
        See Also:
        Constant Field Values

      • TRAVERSE_PARENT

        static final String TRAVERSE_PARENT
        Deprecated.
        Service property name specifying whether the parent hierarchy is traversed to check for hiding properties. If not specified this property defaults to false. The value of this property must be of type Boolean.
        See Also:
        Constant Field Values

    • Method Detail

      • pickResources

        @NotNull
@NotNull List<@NotNull org.apache.sling.api.resource.Resource> pickResources​(@NotNull
                                                                             @NotNull org.apache.sling.api.resource.ResourceResolver resolver,
                                                                             @NotNull
                                                                             @NotNull String relativePath)
        Deprecated.
        Method invoked by the MergingResourceProvider to identify the resources to be merged for a given relative path. The resources returned may be either resources returned from the ResourceResolver directory or an instance of NonExistingResource.
        Parameters:
        resolver - the ResourceResolver
        relativePath - the path relative to the merge root
        Returns:
        a List of Resource objects
        See Also:
        MergedResourcePicker2.pickResources(ResourceResolver, String, Resource)