info.magnolia.virtualuri.mapping

Class RegexpVirtualUriMapping

java.lang.Object

info.magnolia.virtualuri.mapping.DefaultVirtualUriMapping

info.magnolia.virtualuri.mapping.RegexpVirtualUriMapping

All Implemented Interfaces:

VirtualUriMapping

Direct Known Subclasses:

RotatingVirtualUriMapping

public class RegexpVirtualUriMapping
extends DefaultVirtualUriMapping

Query aware virtual uri mapping implementation that uses regular expressions in fromUri/toUri. When using regular expression in fromUri, toUri can contain references to the regexp matches. For example:

 fromUri=/products/([0-9A-Z]+)\.html\?available(true|false)
 toUri=/product/detail.html?productId=$1&available=$2
 

Nested Class Summary

Nested classes/interfaces inherited from interface info.magnolia.virtualuri.VirtualUriMapping

VirtualUriMapping.Result

Constructor Summary

Constructors

Constructor and Description
RegexpVirtualUriMapping()

Method Summary

Modifier and Type	Method and Description
Optional<VirtualUriMapping.Result>	mapUri(URI uri) Maps an incoming URI to a new target URI.
void	setFromUri(String fromUri)

Methods inherited from class info.magnolia.virtualuri.mapping.DefaultVirtualUriMapping

getFromUri, getPattern, getToUri, isValid, setInternalFromUri, setToUri, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RegexpVirtualUriMapping

public RegexpVirtualUriMapping()

Method Detail

setFromUri

public void setFromUri(String fromUri)

Overrides:

setFromUri in class DefaultVirtualUriMapping

mapUri

public Optional<VirtualUriMapping.Result> mapUri(URI uri)

Description copied from interface: VirtualUriMapping

Maps an incoming URI to a new target URI. 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.

Specified by:

mapUri in interface VirtualUriMapping

Overrides:

mapUri in class DefaultVirtualUriMapping

Parameters:

uri - a relative URI containing only the path and query components. The path is relative to the magnolia servlet mapping; context path is already stripped.