info.magnolia.virtualuri.mapping

Class DefaultVirtualUriMapping

java.lang.Object

info.magnolia.virtualuri.mapping.DefaultVirtualUriMapping

All Implemented Interfaces:

VirtualUriMapping

Direct Known Subclasses:

HostBasedVirtualUriMapping, RegexpVirtualUriMapping

public class DefaultVirtualUriMapping
extends Object
implements VirtualUriMapping

A simple implementation of VirtualUriMapping based on UrlPattern.

Nested Class Summary

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

VirtualUriMapping.Result

Constructor Summary

Constructors

Constructor and Description
DefaultVirtualUriMapping()

Method Summary

Modifier and Type	Method and Description
String	getFromUri()
UrlPattern	getPattern()
String	getToUri()
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.
void	setFromUri(String fromUri)
protected void	setInternalFromUri(String fromUri)
void	setToUri(String toUri)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultVirtualUriMapping

public DefaultVirtualUriMapping()

Method Detail

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

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

public boolean isValid()

Description copied from interface: VirtualUriMapping

Validate necessary info to check VirtualUriMapping is valid.

Specified by:

isValid in interface VirtualUriMapping

getFromUri

public String getFromUri()

setFromUri

public void setFromUri(String fromUri)

setInternalFromUri

protected void setInternalFromUri(String fromUri)

getToUri

public String getToUri()

setToUri

public void setToUri(String toUri)

getPattern

public UrlPattern getPattern()

toString

public String toString()

Overrides:

toString in class Object