Package org.apache.sling.resourceresolver.impl.mapping

Class ResourceMapperImpl

java.lang.Object

org.apache.sling.resourceresolver.impl.mapping.ResourceMapperImpl

All Implemented Interfaces:

ResourceMapper

public class ResourceMapperImpl
extends Object
implements ResourceMapper

Constructor Summary

Constructors

Constructor	Description
ResourceMapperImpl(org.apache.sling.resourceresolver.impl.ResourceResolverImpl resolver, ResourceDecoratorTracker resourceDecorator, MapEntriesHandler mapEntries, Object namespaceMangler)

Method Summary

Modifier and Type	Method	Description
Collection<String>	getAllMappings(String resourcePath)	Returns all possible mappings for a given resourcePath as paths.
Collection<String>	getAllMappings(String resourcePath, javax.servlet.http.HttpServletRequest request)	Returns all possible mappings for a given resourcePath as URLs.
String	getMapping(String resourcePath)	Returns a path mapped from the (resource) path applying the reverse mapping used by the ResourceResolver.resolve(String) such that when the path is given to the ResourceResolver.resolve(String) method the same resource is returned.
String	getMapping(String resourcePath, javax.servlet.http.HttpServletRequest request)	Returns an URL mapped from the (resource) path applying the reverse mapping used by the ResourceResolver.resolve(HttpServletRequest, String) such that when the path is given to the ResourceResolver.resolve(HttpServletRequest, String) method the same resource is returned.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ResourceMapperImpl

public ResourceMapperImpl(org.apache.sling.resourceresolver.impl.ResourceResolverImpl resolver,
 ResourceDecoratorTracker resourceDecorator,
 MapEntriesHandler mapEntries,
 Object namespaceMangler)

Method Details

getMapping

public String getMapping(String resourcePath)

Description copied from interface: ResourceMapper

Returns a path mapped from the (resource) path applying the reverse mapping used by the ResourceResolver.resolve(String) such that when the path is given to the ResourceResolver.resolve(String) method the same resource is returned.

Note, that technically the resourcePath need not refer to an existing resource. This method just applies the mappings and returns the resulting string. If the resourcePath does not address an existing resource roundtripping may of course not work and calling ResourceResolver.resolve(String) with the path returned may return null.

This method is intended as the reverse operation of the ResourceResolver.resolve(String) method.

Specified by:

getMapping in interface ResourceMapper

Parameters:

resourcePath - The path for which to return a mapped path.

Returns:

The mapped path.

getMapping

public String getMapping(String resourcePath,
 javax.servlet.http.HttpServletRequest request)

Description copied from interface: ResourceMapper

Returns an URL mapped from the (resource) path applying the reverse mapping used by the ResourceResolver.resolve(HttpServletRequest, String) such that when the path is given to the ResourceResolver.resolve(HttpServletRequest, String) method the same resource is returned.

Note, that technically the resourcePath need not refer to an existing resource. This method just applies the mappings and returns the resulting string. If the resourcePath does not address an existing resource roundtripping may of course not work and calling ResourceResolver.resolve(HttpServletRequest, String) with the path returned may return null.

This method is intended as the reverse operation of the ResourceResolver.resolve(HttpServletRequest, String) method. As such the URL returned is expected to be an absolute URL including scheme, host, any servlet context path and the actual path used to resolve the resource.

Specified by:

getMapping in interface ResourceMapper

Parameters:

resourcePath - The path for which to return a mapped path.

request - The http servlet request object which may be used to apply more mapping functionality.

Returns:

The mapped URL.

getAllMappings

public Collection<String> getAllMappings(String resourcePath)

Description copied from interface: ResourceMapper

Returns all possible mappings for a given resourcePath as paths.

This method differs from the ResourceMapper.getMapping(String) variant by guaranteeing that all possible mappings are returned for a specified path.

The mappings are not returned in any particular order.

Specified by:

getAllMappings in interface ResourceMapper

Parameters:

resourcePath - The path for which to return a mapped path.

Returns:

a collection of mapped URLs, in no particular order. May not be null or empty.

getAllMappings

public Collection<String> getAllMappings(String resourcePath,
 javax.servlet.http.HttpServletRequest request)

Description copied from interface: ResourceMapper

Returns all possible mappings for a given resourcePath as URLs.

This method differs from the ResourceMapper.getMapping(String, HttpServletRequest) variant by guaranteeing that all possible mappings are returned for a specified path.

The mappings are not returned in any particular order.

Specified by:

getAllMappings in interface ResourceMapper

Parameters:

resourcePath - The path for which to return a mapped path.

request - The http servlet request object which may be used to apply more mapping functionality.

Returns:

a collection of mapped URLs, in no particular order. May not be null or empty.