info.magnolia.virtualuri.mapping

Class RotatingVirtualUriMapping

java.lang.Object

info.magnolia.virtualuri.mapping.DefaultVirtualUriMapping

info.magnolia.virtualuri.mapping.RegexpVirtualUriMapping

info.magnolia.virtualuri.mapping.RotatingVirtualUriMapping

All Implemented Interfaces:

VirtualUriMapping

public class RotatingVirtualUriMapping
extends RegexpVirtualUriMapping

An extension of RegexpVirtualUriMapping that allows a rotation between different destination urls. In order to rotate toUri must contain the * that will be replaced by a random number between start (default is 1) and end (defaults is 3).

An additional property padding can specify the left 0 padding for numbers (defaults is 2). So for example a destination url like forward:/banner/image_*.jpg will randomly forward the request to /banner/image_01.jpg, /banner/image_02.jpg or /banner/image_03.jpg

Nested Class Summary

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

VirtualUriMapping.Result

Constructor Summary

Constructors

Constructor and Description
RotatingVirtualUriMapping()

Method Summary

Modifier and Type	Method and Description
Optional<VirtualUriMapping.Result>	mapUri(URI uri) Maps an incoming URI to a new target URI.
void	setEnd(int end) Sets the end.
void	setPadding(int padding) Sets the padding.
void	setStart(int start) Sets the start.

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

setFromUri

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

RotatingVirtualUriMapping

public RotatingVirtualUriMapping()

Method Detail

setStart

public void setStart(int start)

Sets the start.

Parameters:

start - the start to set

setEnd

public void setEnd(int end)

Sets the end.

Parameters:

end - the end to set

setPadding

public void setPadding(int padding)

Sets the padding.

Parameters:

padding - the padding to set

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 RegexpVirtualUriMapping

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.