org.hippoecm.hst.configuration.internal

Interface ContextualizableMount

All Superinterfaces:

Mount, MutableMount

public interface ContextualizableMount
extends MutableMount

internal only api for being able to decorate a Mount to a preview Mount

Field Summary

Fields inherited from interface org.hippoecm.hst.configuration.hosting.Mount

LIVE_NAME, PREVIEW_NAME, PROPERTY_NAME_MOUNT_PREFIX

Method Summary

Modifier and Type	Method and Description
Channel	getPreviewChannel() internal only : not api
<T extends ChannelInfo> T	getPreviewChannelInfo() internal only : not api The preview channel properties for this mount.
String	getPreviewChannelPath()
HstSite	getPreviewHstSite() internal only : not api

Methods inherited from interface org.hippoecm.hst.configuration.hosting.MutableMount

addMount, setChannel, setChannelInfo

Methods inherited from interface org.hippoecm.hst.configuration.hosting.Mount

containsMultipleSchemes, getAlias, getCanonicalContentPath, getChannel, getChannelInfo, getChannelPath, getChildMount, getChildMounts, getCmsLocation, getCmsLocations, getContentPath, getContextPath, getDefaultResourceBundleId, getDefaultResourceBundleIds, getDefaultSiteMapItemHandlerIds, getFormLoginPage, getHomePage, getHstSite, getHstSiteMapMatcher, getIdentifier, getLocale, getMountPath, getMountPoint, getMountProperties, getName, getNamedPipeline, getPageNotFound, getParameter, getParameters, getParent, getPort, getProperty, getPropertyNames, getRoles, getScheme, getSchemeNotMatchingResponseCode, getType, getTypes, getUsers, getVirtualHost, isAuthenticated, isCacheable, isContextPathInUrl, isMapped, isOfType, isPortInUrl, isPreview, isSchemeAgnostic, isSessionStateful, isSite, isSubjectBasedSession, isVersionInPreviewHeader, onlyForContextPath

Method Detail

getPreviewHstSite

HstSite getPreviewHstSite()

internal only : not api

Returns:

the preview hstSite of this mount. If this mount is already a preview mount, the same is returned as Mount.getHstSite(). Returned value can be null if this mount does not point to a hst:site as mountpoint

getPreviewChannelPath

String getPreviewChannelPath()

Returns:

the repository path to the preview channel configuration node and null if not configured

getPreviewChannel

Channel getPreviewChannel()

internal only : not api

Returns:

the preview Channel of this mount. If this mount is already a preview mount, the same is returned as Mount.getChannel(). Returned value can be null if this mount does not have a channel. If there is no explicit preview channel, then the preview is the same as the live, and this method will return same instance as for Mount.getChannel()

getPreviewChannelInfo

<T extends ChannelInfo> T getPreviewChannelInfo()

internal only : not api The preview channel properties for this mount.

Type Parameters:

T - Type of the channel info. Only checked at runtime on assignment.

Returns:

A preview channel properties instance.