info.magnolia.cms.beans.config

Class HostBasedRegexpVirtualURIMapping

java.lang.Object

info.magnolia.cms.beans.config.DefaultVirtualURIMapping

info.magnolia.cms.beans.config.HostBasedVirtualURIMapping

info.magnolia.cms.beans.config.HostBasedRegexpVirtualURIMapping

All Implemented Interfaces:

QueryAwareVirtualURIMapping, VirtualURIMapping

public class HostBasedRegexpVirtualURIMapping
extends HostBasedVirtualURIMapping
implements QueryAwareVirtualURIMapping

Virtual uri mapping implementation which combines functionality of HostBasedVirtualURIMapping and RegexpVirtualURIMapping.

Nested Class Summary

Nested classes/interfaces inherited from class info.magnolia.cms.beans.config.HostBasedVirtualURIMapping

HostBasedVirtualURIMapping.HostURIMapping

Nested classes/interfaces inherited from interface info.magnolia.cms.beans.config.VirtualURIMapping

VirtualURIMapping.MappingResult

Field Summary

Fields

Modifier and Type	Field and Description
protected Pattern	regexp

Fields inherited from class info.magnolia.cms.beans.config.HostBasedVirtualURIMapping

hosts

Fields inherited from class info.magnolia.cms.beans.config.DefaultVirtualURIMapping

fromURI, pattern, toURI

Constructor Summary

Constructors

Constructor and Description
HostBasedRegexpVirtualURIMapping()

Method Summary

Methods

Modifier and Type	Method and Description
VirtualURIMapping.MappingResult	mapURI(String uri) Maps an incoming URI to a new target URI.
VirtualURIMapping.MappingResult	mapURI(String uri, String queryString) Maps an incoming URI and queryString to a new target URI.
void	setFromURI(String fromURI)

Methods inherited from class info.magnolia.cms.beans.config.HostBasedVirtualURIMapping

addHost, addMapping, getHosts, getMappings, toString, tryToMapHost

Methods inherited from class info.magnolia.cms.beans.config.DefaultVirtualURIMapping

getFromURI, getToURI, setToURI

Methods inherited from class java.lang.Object

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

Field Detail

regexp

protected Pattern regexp

Constructor Detail

HostBasedRegexpVirtualURIMapping

public HostBasedRegexpVirtualURIMapping()

Method Detail

mapURI

public VirtualURIMapping.MappingResult mapURI(String uri)

Description copied from interface: VirtualURIMapping

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.

Specified by:

mapURI in interface VirtualURIMapping

Overrides:

mapURI in class HostBasedVirtualURIMapping

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

mapURI

public VirtualURIMapping.MappingResult mapURI(String uri,
                                     String queryString)

Description copied from interface: QueryAwareVirtualURIMapping

Maps an incoming URI and queryString 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.

Specified by:

mapURI in interface QueryAwareVirtualURIMapping

Parameters:

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

queryString - the Query String of the current request

Returns:

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

setFromURI

public void setFromURI(String fromURI)

Overrides:

setFromURI in class DefaultVirtualURIMapping