info.magnolia.virtualuri

Interface VirtualUriMapping

All Known Implementing Classes:

DefaultVirtualUriMapping, HostBasedRegexpVirtualUriMapping, HostBasedVirtualUriMapping, RegexpVirtualUriMapping, RotatingVirtualUriMapping, VirtualUriMappingAdapter

public interface VirtualUriMapping

VirtualUriMapping implementations are configured and loaded into the VirtualUriRegistry; they are then used by the VirtualUriFilter to transform incoming URI requests.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	VirtualUriMapping.Result Mapping information returned by mapUri(URI).

Method Summary

Modifier and Type	Method and Description
boolean	isValid() Validate necessary info to check VirtualUriMapping is valid.
Optional<VirtualUriMapping.Result>	mapUri(URI uri) Maps an incoming URI to a new target URI.

Method Detail

mapUri

Optional<VirtualUriMapping.Result> mapUri(URI uri)

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.

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.

isValid

boolean isValid()

Validate necessary info to check VirtualUriMapping is valid.