VirtualHosts (Hippo Site Toolkit API 5.0.2 API)

All Known Subinterfaces:

MutableVirtualHosts
```
public interface VirtualHosts
```
The container interface for VirtualHost

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_SCHEME

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_SCHEME`

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`Blueprint`	`getBlueprint(String id)` Retrieve a blue print from it's ID.
`List<Blueprint>`	`getBlueprints()` The list of available blueprints
`org.onehippo.cms7.services.hst.Channel`	`getChannelById(String hostGroup, String id)` For `hostGroup` get a `Channel` given its id
`org.onehippo.cms7.services.hst.Channel`	`getChannelByJcrPath(String hostGroup, String channelPath)`
`<T extends ChannelInfo> T`	`getChannelInfo(org.onehippo.cms7.services.hst.Channel channel)` The channel info for this channel.
`Class<? extends ChannelInfo>`	`getChannelInfoClass(org.onehippo.cms7.services.hst.Channel channel)` The channel info class for this channel.
`Class<? extends ChannelInfo>`	`getChannelInfoClass(String hostGroup, String id)` The channel info class for this channel identified by id.
`String`	`getChannelManagerSitesName()`
`Map<String,Map<String,org.onehippo.cms7.services.hst.Channel>>`	`getChannels()`
`Map<String,org.onehippo.cms7.services.hst.Channel>`	`getChannels(String hostGroup)`
`String`	`getCmsPreviewPrefix()` The cmsPreviewPrefix will never start or end with a slash and will never be `null`
`String`	`getDefaultContextPath()` For external calls like the CMS REST api, an external app needs to know what context path to use.
`String`	`getDefaultHostName()`
`String`	`getDefaultResourceBundleId()` Deprecated. Use `getDefaultResourceBundleIds()` instead.
`String[]`	`getDefaultResourceBundleIds()`
`int`	`getDiagnosticsDepth()` If `isDiagnosticsEnabled(String)` returns `true`, only until `getDiagnosticsDepth()` the call hierarchy timings will be logged.
`long`	`getDiagnosticsThresholdMillis()` If `isDiagnosticsEnabled(String)` returns `true`, only log if the `org.hippoecm.hst.diagnosis.Task` took longer than or equal to `getDiagnosticsThresholdMillis()`.
`long`	`getDiagnosticsUnitThresholdMillis()`
`List<String>`	`getHostGroupNames()`
`HstManager`	`getHstManager()` Deprecated. since 7.9.0 : Use the `ComponentManager` instead to access the `HstManager`
`String`	`getLocale()`
`Mount`	`getMountByGroupAliasAndType(String hostGroupName, String alias, String type)` Returns the `Mount` for this `hostGroupName`, `alias and type having Mount.getType() equal to type.`
`Mount`	`getMountByIdentifier(String uuid)`
`List<Mount>`	`getMountsByHostGroup(String hostGroupName)`
`List<HstPropertyDefinition>`	`getPropertyDefinitions(org.onehippo.cms7.services.hst.Channel channel)` Get `Channel` property definitions given a `Channel` object instance
`List<HstPropertyDefinition>`	`getPropertyDefinitions(String hostGroup, String channelId)` Get `Channel` property definitions given a `Channel` id
`ResourceBundle`	`getResourceBundle(org.onehippo.cms7.services.hst.Channel channel, Locale locale)` The resource bundle for the channel info.
`boolean`	`isChannelMngrSiteAuthenticationSkipped()`
`boolean`	`isContextPathInUrl()` This is the global setting for every `VirtualHost` / `Mount` whether contextPath should be in the URL or not
`boolean`	`isDiagnosticsEnabled(String ip)`
`boolean`	`isExcluded(String pathInfo)` Deprecated. since CMS 10.0, HST 2.30.00. Use `isHstFilterExcludedPath(String)` instead
`boolean`	`isHstFilterExcludedPath(String pathInfo)` Some paths should not be handled by the hst framework request processing, eg /ping/ When a path must be excluded, this method return true.
`boolean`	`isPortInUrl()` This is the global setting for every `VirtualHost` / `Mount` whether the port number should be in the URL or not
`ResolvedMount`	`matchMount(String hostName, String contextPath, String requestPath)` This method tries to match a hostName, contextPath and requestPath to a flyweight `ResolvedMount`.
`ResolvedSiteMapItem`	`matchSiteMapItem(HstContainerURL hstContainerURL)` Deprecated. since 2.28.00 (CMS 7.9) use `matchMount(String, String, String)` instead and then `ResolvedMount.matchSiteMapItem(String)`
`ResolvedVirtualHost`	`matchVirtualHost(String hostName)` This method tries to match a request to a flyweight `ResolvedVirtualHost`

- Field Detail
  - DEFAULT_SCHEME
```
static final String DEFAULT_SCHEME
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getHstManager
```
@Deprecated
HstManager getHstManager()
```
    Deprecated. since 7.9.0 : Use the ComponentManager instead to access the HstManager
    
    Returns:
    
    the HstManager for this VirtualHosts object
  - isExcluded
```
@Deprecated
boolean isExcluded(String pathInfo)
```
    Deprecated. since CMS 10.0, HST 2.30.00. Use isHstFilterExcludedPath(String) instead
  - isHstFilterExcludedPath
```
boolean isHstFilterExcludedPath(String pathInfo)
```
    Some paths should not be handled by the hst framework request processing, eg /ping/ When a path must be excluded, this method return true.
    
    Parameters:
    
    pathInfo -
    
    Returns:
    
    true when the path must be excluded for matching to a host.
  - matchSiteMapItem
```
@Deprecated
ResolvedSiteMapItem matchSiteMapItem(HstContainerURL hstContainerURL)
                                           throws MatchException
```
    Deprecated. since 2.28.00 (CMS 7.9) use matchMount(String, String, String) instead and then ResolvedMount.matchSiteMapItem(String)
    
    This method tries to match a hstContainerURL to a flyweight ResolvedSiteMapItem. It does so, by first trying to match the correct ResolvedVirtualHost. If it does find a ResolvedVirtualHost, the match is delegated to ResolvedVirtualHost.matchMount(String, String), which returns the ResolvedMount. This object delegates to ResolvedMount.matchSiteMapItem(String) which in the end returns the ResolvedSiteMapItem. If somewhere in the chain a match cannot be made a MatchException exception is thrown
    
    Parameters:
    
    hstContainerURL - the HstContainerURL
    
    Returns:
    
    the resolvedSiteMapItem for this request
    
    Throws:
    
    MatchException - when the matching cannot be done, for example because no valid virtual hosts are configured or when the request path does not match a sitemap item
  - matchMount
```
ResolvedMount matchMount(String hostName,
                         String contextPath,
                         String requestPath)
                  throws MatchException
```
    This method tries to match a hostName, contextPath and requestPath to a flyweight ResolvedMount. It does so, by first trying to match the correct ResolvedVirtualHost. If it does find a ResolvedVirtualHost, the match is delegated to ResolvedVirtualHost.matchMount(String, String), which returns the ResolvedMount. If somewhere in the chain a match cannot be made, null will be returned. 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:
    
    hostName -
    
    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
  - matchVirtualHost
```
ResolvedVirtualHost matchVirtualHost(String hostName)
                              throws MatchException
```
    This method tries to match a request to a flyweight ResolvedVirtualHost
    
    Parameters:
    
    hostName -
    
    Returns:
    
    the resolvedVirtualHost for this hostName or null when it can not be matched to a virtualHost
    
    Throws:
    
    MatchException
  - getDefaultHostName
```
String getDefaultHostName()
```
    Returns:
    
    the hostname that is configured as default, or null if none is configured as default.
  - isContextPathInUrl
```
boolean isContextPathInUrl()
```
    This is the global setting for every VirtualHost / Mount whether contextPath should be in the URL or not
    
    Returns:
    
    true when the created url should have the contextPath in it
  - getDefaultContextPath
```
String getDefaultContextPath()
```
    For external calls like the CMS REST api, an external app needs to know what context path to use. Through this getter, the default context path can be retrieved. If not configured, null is returned and the external app must know the context path. If configured, the contextPath is either an empty string, or it has to start with a "/" and is not allowed to have any other "/".
    
    Returns:
    
    the default context path for the webapps or null when not configured
  - isPortInUrl
```
boolean isPortInUrl()
```
    This is the global setting for every VirtualHost / Mount whether the port number should be in the URL or not
    
    Returns:
    
    true when the created url should have the port number in it
  - getLocale
```
String getLocale()
```
    Returns:
    
    the locale of this VirtualHosts object or null if no locale is configured
  - getMountByGroupAliasAndType
```
Mount getMountByGroupAliasAndType(String hostGroupName,
                                  String alias,
                                  String type)
```
    Returns the Mount for this hostGroupName, alias and type having Mount.getType() equal to type. Returns null when no match
    Parameters: hostGroupName - alias - the alias the mount must have type - the type (for example preview, live, composer) the siteMount must have. Returns: the Mount for this hostGroupName, alias and type having Mount.getType() equal to type. Returns null when no match
  getMountsByHostGroup List<Mount> getMountsByHostGroup(String hostGroupName) Parameters: hostGroupName - Returns: the List<Mount> belonging to hostGroupName or null when there are no Mount for hostGroupName getHostGroupNames List<String> getHostGroupNames() Returns: return the list of all hostGroupNames getMountByIdentifier Mount getMountByIdentifier(String uuid) Parameters: uuid - getCmsPreviewPrefix String getCmsPreviewPrefix() The cmsPreviewPrefix will never start or end with a slash and will never be null Returns: the configured cmsPreviewPrefix with leading and trailing slashes removed. It will never be null. If configured to be empty, it will be "" getChannelManagerSitesName String getChannelManagerSitesName() Returns: the node name of the hst:sites that will be managed by the ChannelManager. If not configured it returns hst:sites isDiagnosticsEnabled boolean isDiagnosticsEnabled(String ip) Returns: true when diagnostics about request processing is enabled for the client IP address. If ip is null, then the ip address of the request won't be taken into account to determine whether or not the diagnostics is enabled. getDiagnosticsDepth int getDiagnosticsDepth() If isDiagnosticsEnabled(String) returns true, only until getDiagnosticsDepth() the call hierarchy timings will be logged. Default value returned is -1 meaning no limit Returns: the depth until where to log and -1 if not limit getDiagnosticsThresholdMillis long getDiagnosticsThresholdMillis() If isDiagnosticsEnabled(String) returns true, only log if the org.hippoecm.hst.diagnosis.Task took longer than or equal to getDiagnosticsThresholdMillis(). Default threshold of -1 meaning no threshold Returns: the threshold value configured and -1 if not configured meaning no threshold. getDiagnosticsUnitThresholdMillis long getDiagnosticsUnitThresholdMillis() Returns: the threshold value for a task to get logged separately. If not configured -1 is returned meaning no threshold for subtask diagnostics getDefaultResourceBundleId @Deprecated String getDefaultResourceBundleId() Deprecated. Use getDefaultResourceBundleIds() instead. Returns: the first item of default resource bundle IDs or null if not configured or empty. getDefaultResourceBundleIds String[] getDefaultResourceBundleIds() Returns: default resource bundle IDs for all sites to use, for example { "org.example.resources.MyResources" }, or empty array when not configured isChannelMngrSiteAuthenticationSkipped boolean isChannelMngrSiteAuthenticationSkipped() Returns: true when the channel manager can skip authentication required for mounts or sitemapitems. getChannels Map<String,org.onehippo.cms7.services.hst.Channel> getChannels(String hostGroup) Parameters: hostGroup - the name of the host group to get the channels for Returns: all managed channels for the hostGroup. Empty List in case the hostGroup does not exist or has no channel. The keys in the map are the Channel.getId()'s getChannels Map<String,Map<String,org.onehippo.cms7.services.hst.Channel>> getChannels() Returns: The map of all hostGroup names to the map of all the channels for that hostgroup getChannelByJcrPath org.onehippo.cms7.services.hst.Channel getChannelByJcrPath(String hostGroup, String channelPath) Parameters: hostGroup - the name of the host group to get channel for Returns: the channel configured at the given channelPath and null if no such channel exists Throws: IllegalArgumentException - in case of invalid channelPath getChannelById org.onehippo.cms7.services.hst.Channel getChannelById(String hostGroup, String id) For hostGroup get a Channel given its id Parameters: hostGroup - the name of the host group to get channel for id - - Channel id Returns: Channel which has this id or null getBlueprints List<Blueprint> getBlueprints() The list of available blueprints getBlueprint Blueprint getBlueprint(String id) Retrieve a blue print from it's ID. Parameters: id - getChannelInfoClass Class<? extends ChannelInfo> getChannelInfoClass(org.onehippo.cms7.services.hst.Channel channel) throws ChannelException The channel info class for this channel. Since this class comes from a separate context, it cannot be deserialized. Parameters: channel - - Channel for which ChannelInfo is going to be retrieved Returns: The ChannelInfo Class type of Channel Throws: ChannelException getChannelInfoClass Class<? extends ChannelInfo> getChannelInfoClass(String hostGroup, String id) throws ChannelException The channel info class for this channel identified by id. Parameters: hostGroup - the name of the host group to get channel for id - - Channel id Returns: The ChannelInfo Class type of Channel identified by id Throws: ChannelException getChannelInfo <T extends ChannelInfo> T getChannelInfo(org.onehippo.cms7.services.hst.Channel channel) throws ChannelException The channel info for this channel. It is an instance of the getChannelInfoClass(org.onehippo.cms7.services.hst.Channel) class. Type Parameters: T - Parameters: channel - Throws: ChannelException getResourceBundle ResourceBundle getResourceBundle(org.onehippo.cms7.services.hst.Channel channel, Locale locale) The resource bundle for the channel info. It contains the display names for fields and values. Returns: The ResourceBundle or null if the resource bundle could not be found getPropertyDefinitions List<HstPropertyDefinition> getPropertyDefinitions(org.onehippo.cms7.services.hst.Channel channel) Get Channel property definitions given a Channel object instance Parameters: channel - - Channel for which property definitions are going to be retrieved Returns: List of HstPropertyDefinition getPropertyDefinitions List<HstPropertyDefinition> getPropertyDefinitions(String hostGroup, String channelId) Get Channel property definitions given a Channel id Parameters: hostGroup - the name of the host group to get channel for channelId - - Channel id for which property definitions are going to be retrieved Returns: List of HstPropertyDefinition

Interface VirtualHosts

Field Summary

Method Summary

Field Detail

DEFAULT_SCHEME

Method Detail

getHstManager

isExcluded

isHstFilterExcludedPath

matchSiteMapItem

matchMount

matchVirtualHost

getDefaultHostName

isContextPathInUrl

getDefaultContextPath

isPortInUrl

getLocale

getMountByGroupAliasAndType

getMountsByHostGroup

getHostGroupNames

getMountByIdentifier

getCmsPreviewPrefix

getChannelManagerSitesName

isDiagnosticsEnabled

getDiagnosticsDepth

getDiagnosticsThresholdMillis

getDiagnosticsUnitThresholdMillis

getDefaultResourceBundleId

getDefaultResourceBundleIds

isChannelMngrSiteAuthenticationSkipped

getChannels

getChannels

getChannelByJcrPath

getChannelById

getBlueprints

getBlueprint

getChannelInfoClass

getChannelInfoClass

getChannelInfo

getResourceBundle

getPropertyDefinitions

getPropertyDefinitions