info.magnolia.virtualuri.mapping

Class HostBasedVirtualUriMapping

java.lang.Object

info.magnolia.virtualuri.mapping.DefaultVirtualUriMapping

info.magnolia.virtualuri.mapping.HostBasedVirtualUriMapping

All Implemented Interfaces:

VirtualUriMapping

Direct Known Subclasses:

HostBasedRegexpVirtualUriMapping

public class HostBasedVirtualUriMapping
extends DefaultVirtualUriMapping

Virtual Uri mapping that can forward to a different url depending on the request host name. The "mappings" node contains a list of nodes with "host" and "toUri" properties. See below for a sample configuration:

 # [module]/virtualUriMappings/[mapping-name].yaml
 ---
 class: info.magnolia.virtualuri.mapping.HostBasedVirtualUriMapping
 fromUri: /
 toUri: redirect:/.magnolia/admincentral
 mappings:
   - host: www.acme.com
     toUri: forward:/acme/en/index.html
   - host: www.acme.de
     toUri: forward:/acme/de/index.html
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HostBasedVirtualUriMapping.HostUriMapping HostUriMapping object to receive "mapping" nodes in configuration.

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

VirtualUriMapping.Result

Constructor Summary

Constructors

Constructor and Description
HostBasedVirtualUriMapping()

Method Summary

Modifier and Type	Method and Description
List<HostBasedVirtualUriMapping.HostUriMapping>	getMappings()
boolean	isValid() Validate necessary info to check VirtualUriMapping is valid.
Optional<VirtualUriMapping.Result>	mapUri(URI uri) Choose shortest HostMapping matching request host, with the least number of additional characters.
void	setMappings(List<HostBasedVirtualUriMapping.HostUriMapping> hostMappings)
String	toString()
protected Optional<String>	tryToMapHost() Choose the longest host-mapping matching the request host from its end (most specific).

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

getFromUri, getPattern, getToUri, setFromUri, setInternalFromUri, setToUri

Methods inherited from class java.lang.Object

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

Constructor Detail

HostBasedVirtualUriMapping

public HostBasedVirtualUriMapping()

Method Detail

getMappings

public List<HostBasedVirtualUriMapping.HostUriMapping> getMappings()

setMappings

public void setMappings(List<HostBasedVirtualUriMapping.HostUriMapping> hostMappings)

mapUri

public Optional<VirtualUriMapping.Result> mapUri(URI uri)

Choose shortest HostMapping matching request host, with the least number of additional characters.

Specified by:

mapUri in interface VirtualUriMapping

Overrides:

mapUri in class DefaultVirtualUriMapping

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.

Returns:

The URI to map to.

isValid

public boolean isValid()

Description copied from interface: VirtualUriMapping

Validate necessary info to check VirtualUriMapping is valid.

Specified by:

isValid in interface VirtualUriMapping

Overrides:

isValid in class DefaultVirtualUriMapping

tryToMapHost

protected Optional<String> tryToMapHost()

Choose the longest host-mapping matching the request host from its end (most specific).

toString

public String toString()

Overrides:

toString in class DefaultVirtualUriMapping