info.magnolia.cms.beans.config
Class HostBasedVirtualURIMapping

java.lang.Object
  info.magnolia.cms.beans.config.DefaultVirtualURIMapping
      info.magnolia.cms.beans.config.HostBasedVirtualURIMapping

All Implemented Interfaces:

VirtualURIMapping

Direct Known Subclasses:

HostBasedRegexpVirtualURIMapping

public class HostBasedVirtualURIMapping
extends DefaultVirtualURIMapping

Simple VirtualURI mapping that can forward to a different url depending on the request host name. The "host" property must be a list of uri=destination strings. See below for a sample configuration:

 [] virtualURIMapping
    [] default
     - class            info.magnolia.cms.beans.config.HostBasedVirtualURIMapping
     - fromURI          /
     - toURI            redirect:/.magnolia/pages/adminCentral.html
       [] hosts
        - 1             www.acme.com=forward:/acme/en/index.html
        - 2             www.acme.de=forward:/acme/de/index.html
 

Nested Class Summary

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

VirtualURIMapping.MappingResult

Field Summary

protected Map<String,String>

hosts

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

fromURI, toURI

Constructor Summary

HostBasedVirtualURIMapping()

Method Summary

void	addHost(String mapping) Adds a host mapping (used by content2bean).
List<String>	getHosts()
VirtualURIMapping.MappingResult	mapURI(String uri) Maps an incoming URI to a new target URI.
void	setHosts(List<String> hosts)
String	toString()
protected String	tryToMapHost()

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

getFromURI, getToURI, setFromURI, setToURI

Methods inherited from class java.lang.Object

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

Field Detail

hosts

protected Map<String,String> hosts

Constructor Detail

HostBasedVirtualURIMapping

public HostBasedVirtualURIMapping()

Method Detail

getHosts

public List<String> getHosts()

setHosts

public void setHosts(List<String> hosts)

addHost

public void addHost(String mapping)

Adds a host mapping (used by content2bean).

Parameters:

mapping - in the form host=path

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 DefaultVirtualURIMapping

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

tryToMapHost

protected String tryToMapHost()

toString

public String toString()

Overrides:

toString in class DefaultVirtualURIMapping