info.magnolia.cms.beans.config
Interface VirtualURIMapping

All Known Subinterfaces:

QueryAwareVirtualURIMapping

All Known Implementing Classes:

DefaultVirtualURIMapping, HostBasedRegexpVirtualURIMapping, HostBasedVirtualURIMapping, RegexpVirtualURIMapping, RotatingVirtualURIMapping

public interface VirtualURIMapping

VirtualURIMapping implementations are used by VirtualURIManager and VirtualUriFilter to transform incoming URI requests.

Version:

$Id$

Author:

philipp

Nested Class Summary

static class

VirtualURIMapping.MappingResult Mapping information returned by mapURI(String).

Method Summary

VirtualURIMapping.MappingResult

mapURI(String uri) Maps an incoming URI to a new target URI.

Method Detail

mapURI

VirtualURIMapping.MappingResult mapURI(String uri)

Maps an incoming URI to a new target URI. Returns a VirtualURIMapping.MappingResult describing the new URI and the level of match. The new URI can be prefixed with "redirect:", "permanent:" or "forward:" to trigger either a temporary redirect, a permanent redirect or a forward respectively. For redirects the URI can be absolute or relative within the web application (the context path is added automatically). If the mapping does not apply to the input URI this method returns null.

Parameters:

uri - the URI of the current request, decoded and without the context path

Returns:

a VirtualURIMapping.MappingResult with the target URI and level or null if the mapping doesn't apply