Package com.composum.sling.core.service

Interface PathReferencesService

All Known Implementing Classes:

PathReferencesServiceImpl

public interface PathReferencesService

the service for finding and changing resource references

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PathReferencesService.Hit	a found resource which is referencing the searched path
static interface	PathReferencesService.HitIterator
static class	PathReferencesService.Options	an options set to specify the parameters of the query to search path references; build the options for the reference search like this:

Method Summary

Modifier and Type	Method	Description
void	changeReferences(@NotNull org.apache.sling.api.resource.ResourceResolver resolver, @NotNull PathReferencesService.Hit hit, @NotNull String newPath)	replaces each occurrence of the paths found in a previous search by the new path in the properties of the found resource (hit)
@NotNull PathReferencesService.HitIterator	findReferences(@NotNull org.apache.sling.api.resource.ResourceResolver resolver, @NotNull PathReferencesService.Options options, @NotNull String searchRoot, @NotNull String path)	searches resources which are referencing the given path

Method Detail

findReferences

@NotNull
@NotNull PathReferencesService.HitIterator findReferences(@NotNull
                                                          @NotNull org.apache.sling.api.resource.ResourceResolver resolver,
                                                          @NotNull
                                                          @NotNull PathReferencesService.Options options,
                                                          @NotNull
                                                          @NotNull String searchRoot,
                                                          @NotNull
                                                          @NotNull String path)

searches resources which are referencing the given path

Parameters:

resolver - the resolver (the user/session context)

options - the options to create the search query

searchRoot - the repository root path of the area to browse

path - the path for which the referers have to be found; maybe with wildcards ('*'/'%')

Returns:

the iterator to traverse the found referrers

changeReferences

void changeReferences(@NotNull
                      @NotNull org.apache.sling.api.resource.ResourceResolver resolver,
                      @NotNull
                      @NotNull PathReferencesService.Hit hit,
                      @NotNull
                      @NotNull String newPath)

replaces each occurrence of the paths found in a previous search by the new path in the properties of the found resource (hit)

Parameters:

resolver - the resolver (user/session) to use for searching

hit - the repository resource which has to be changed

newPath - the new path value