org.hippoecm.hst.core.request
Interface ResolvedVirtualHost

All Known Implementing Classes:

ResolvedVirtualHostImpl

public interface ResolvedVirtualHost

Implementations of this interface are a request flyweight instance of the VirtualHost object, where possible wildcard property placeholders have been filled in, similar to the ResolvedMount and Mount

Method Summary

int	getPortNumber() the portNumber that resolved to this ResolvedVirtualHost.
String	getResolvedHostName() the hostName that resolved to this ResolvedVirtualHost.
VirtualHost	getVirtualHost()
ResolvedMount	matchMount(String contextPath, String requestPath) matches the current requestPath and resolved virtual host to a ResolvedMount item.

Method Detail

getVirtualHost

VirtualHost getVirtualHost()

Returns:

the backing virtual host of this ResolvedVirtualHost

getResolvedHostName

String getResolvedHostName()

the hostName that resolved to this ResolvedVirtualHost. Note that this might be different then the one in VirtualHost.getHostName() as this hostName might contain not yet filled in wildcards.

Returns:

the hostName that resolved to this ResolvedVirtualHost

See Also:

VirtualHost.getHostName()

getPortNumber

int getPortNumber()

the portNumber that resolved to this ResolvedVirtualHost.

Returns:

the portNumber that resolved to this ResolvedVirtualHost

matchMount

ResolvedMount matchMount(String contextPath,
                         String requestPath)
                         throws MatchException

matches the current requestPath and resolved virtual host to a ResolvedMount item. When the contextPath param is not null it might influence the matching, depending whether Mount.onlyForContextPath() is not null

Parameters:

contextPath - the contextPath if needed for matching. This parameter is allowed to be null

requestPath -

Returns:

a ResolvedMount or null when none matches

Throws:

MatchException