org.hippoecm.hst.core.request

Interface ResolvedVirtualHost

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

Modifier and Type	Method and Description
int	getPortNumber() Deprecated. since HST 2.28.00 (CMS 7.9.0) use ResolvedMount.getPortNumber() instead
String	getResolvedHostName() Deprecated. since HST 2.28.00 (CMS 7.9.0) use getVirtualHost()#VirtualHost.getHostName() instead
VirtualHost	getVirtualHost()
ResolvedMount	matchMount(String contextPath, String requestPath) This method tries to match the current ResolvedVirtualHost for contextPath and requestPath to a flyweight ResolvedMount.

Method Detail

getVirtualHost

VirtualHost getVirtualHost()

Returns:

the backing virtual host of this ResolvedVirtualHost

getResolvedHostName

@Deprecated
String getResolvedHostName()

Deprecated. since HST 2.28.00 (CMS 7.9.0) use getVirtualHost()#VirtualHost.getHostName() instead

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

@Deprecated
int getPortNumber()

Deprecated. since HST 2.28.00 (CMS 7.9.0) use ResolvedMount.getPortNumber() instead

the portNumber that resolved to this ResolvedVirtualHost.

Returns:

the portNumber that resolved to this ResolvedVirtualHost

matchMount

ResolvedMount matchMount(String contextPath,
                         String requestPath)
                  throws MatchException

This method tries to match the current ResolvedVirtualHost for contextPath and requestPath to a flyweight ResolvedMount. If Mount.getContentPath() ()} returns a non-null value, the Mount can only match for the request if the HttpServletRequest.getContextPath() is equal to Mount.getContextPath(). Note that the ROOT.war matches to a Mount.getContextPath() equal to empty String. When Mount.getContextPath() returns null the HttpServletRequest.getContextPath() is ignored for matching.

Parameters:

contextPath - the contextPath of the HttpServletRequest

requestPath -

Returns:

the ResolvedMount for this hstContainerUrl or null when it can not be matched to a Mount

Throws:

MatchException