public interface VirtualHost
Modifier and Type | Method and Description |
---|---|
Collection<String> |
getAllowedOrigins()
Returns all the allowed origins for this
VirtualHost |
String |
getBaseURL(javax.servlet.http.HttpServletRequest request)
Returns the base of the
URL as seen by for example a browser. |
String |
getCdnHost() |
VirtualHost |
getChildHost(String name) |
List<VirtualHost> |
getChildHosts() |
String |
getContextPath()
Returns the contextpath (webapp) for all the
Mount s below this VirtualHost . |
String[] |
getDefaultResourceBundleIds() |
String |
getHomePage() |
String |
getHostGroupName()
Returns the name of host group this virtual host belongs to, for example 'prod', 'acct' or 'dev'
|
String |
getHostName()
The hostName of this VirtualHost.
|
String |
getHstLinkUrlPrefix()
Returns the 'HST Link URL prefix' in case one is configured
|
String |
getLocale()
the locale for this VirtualHost or
null when it does not contain one. |
String |
getName()
Returns the
name of this VirtualHost. |
String |
getPageNotFound() |
PortMount |
getPortMount(int portNumber) |
Map<String,String> |
getResponseHeaders()
Return a non-null unmodifiable map of the configuration values of HTTP Response headers which should be set
in any responses by the requests on this.
|
String |
getScheme() |
int |
getSchemeNotMatchingResponseCode()
|
VirtualHosts |
getVirtualHosts() |
boolean |
isCacheable() |
boolean |
isContextPathInUrl() |
boolean |
isCustomHttpsSupported() |
boolean |
isPortInUrl() |
boolean |
isSchemeAgnostic()
If a
VirtualHost is scheme agnostic, the request gets served regardless whether it is http or
https (assuming Mount and HstSiteMapItem do not override the value) |
boolean |
isVersionInPreviewHeader() |
String getHostName()
String getName()
name
of this VirtualHost. Note, this is not the hostName, but only part of it. If the hostName
is www.apache.org, then the name of this VirtualHost might be 'www' or 'apache' or 'org'. It can thus be one segment
of the entire hostName or is get be www.apache.org which is also possiblename
of this VirtualHost. Note, this is only part of the entire hostNamegetHostName()
String getHostGroupName()
name
of the host group this VirtualHost belongs to.String getLocale()
null
when it does not contain one. Note that if an ancestor VirtualHost contains a
locale, this value is inherited unless this VirtualHost explicitly defines its own. The VirtualHost directly below the VirtualHosts
inherits the value from
the VirtualHosts
null
when it does not contain one.VirtualHost getChildHost(String name)
name
- the name segment of the hostnameVirtualHost
or null
if none foundList<VirtualHost> getChildHosts()
PortMount getPortMount(int portNumber)
portNumber
- VirtualHosts getVirtualHosts()
VirtualHosts
container of this VirtualHost
boolean isContextPathInUrl()
true
when the created url should have the contextpath in itString getContextPath()
Returns the contextpath (webapp) for all the Mount
s below this VirtualHost
.
Mount
s below this VirtualHost
.
The contextpath for the ROOT application must be an empty String. If non-empty, a path starting with a "/" character
but that does not end with a "/" character must be returned. It is not allowed to return null
Mount.getContextPath()
boolean isPortInUrl()
true
when the created url should have the port in itString getScheme()
boolean isSchemeAgnostic()
VirtualHost
is scheme agnostic, the request gets served regardless whether it is http
or
https
(assuming Mount
and HstSiteMapItem
do not override the value)true
when this VirtualHost
is scheme agnosticint getSchemeNotMatchingResponseCode()
the response code the HST sets when HttpServletRequest
scheme
does not match getScheme()
.
Default response code is HttpServletResponse.SC_MOVED_PERMANENTLY
. The following response
codes are supported and result in:
getScheme()
, permanent redirect to the correct scheme is donegetScheme()
, temporal redirect to the correct scheme is donegetScheme()
, a page forbidden is returnedgetScheme()
, a page not found is returned
Any other response code than above will result in inheriting the response code from parent VirtualHost
or VirtualHosts
String getHomePage()
null
when not presentString getBaseURL(javax.servlet.http.HttpServletRequest request)
URL
as seen by for example a browser. The base URL is consists of scheme + hostname + portnumber
for example 'http://www.hippoecm.org:8081'
The scheme is 'http' by default, unless getScheme()
returns something else
The hostname is the HttpServeltRequest request.getServerName() (proxies must have ProxyPreserveHost On
)
The portnumber is as follows:
#isPortVisible()
is false
, there is no portnumberport = #getPortNumber()
if (port == 0) {port = request.getServerPort()}
request
- the HttpServletRequestURL
until the context path, thus scheme + hostname + portnumber
, for example 'http://www.hippoecm.org:8081'String getPageNotFound()
Mount
or null
when not presentboolean isVersionInPreviewHeader()
boolean isCacheable()
true
if rendering / resource requests can have their entire page http responses cached.String[] getDefaultResourceBundleIds()
VirtualHost
and empty from ancestor VirtualHost
or when root host from VirtualHosts.getDefaultResourceBundleIds()
String getCdnHost()
null
or empty String in case no cdn host is used and otherwise the cdn host to be used for URLs to sitemap items that have
HstSiteMapItem#isContainerResource() = true
.
Preferred format for a cdn host is //hostname so it piggybacks on the scheme of the current request. Starting with
http/https is allowed but is not preferredString getHstLinkUrlPrefix()
Returns the 'HST Link URL prefix' in case one is configured
boolean isCustomHttpsSupported()
true
if this VirtualHost
allows a HttpServletRequest
over https
to
be rendered while the matched HstSiteMapItem
or Mount
indicates
through getScheme()
the request should be http
Map<String,String> getResponseHeaders()
Return a non-null unmodifiable map of the configuration values of HTTP Response headers which should be set in any responses by the requests on this. They keys from the returned map are the header names.
Note that the header names returned by this method overwrites any already set headers during request processing with the same name
Collection<String> getAllowedOrigins()
Returns all the allowed origins for this VirtualHost
Copyright © 2008–2020 Hippo B.V. (http://www.onehippo.com). All rights reserved.