org.hippoecm.hst.configuration.hosting

Interface MutableMount

All Superinterfaces:

Mount

All Known Subinterfaces:

ContextualizableMount

public interface MutableMount
extends Mount

Mount extension that decouples channel info retrieval from the mount service construction. It is only safe to use the methods that are exposed while the mount service is built; i.e. with the HstManagerImpl monitor held.

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
void	addMount(MutableMount mount)
void	setChannel(Channel channel, Channel previewChannel) Sets the Channel info for this Mount.
void	setChannelInfo(ChannelInfo info, ChannelInfo previewInfo) Set the channel info for the mount.

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

setChannelInfo

void setChannelInfo(ChannelInfo info,
                    ChannelInfo previewInfo)

Set the channel info for the mount. The info must be constant, i.e. it must always return the same values.

setChannel

void setChannel(Channel channel,
                Channel previewChannel)
         throws UnsupportedOperationException

Sets the Channel info for this Mount. If the Mount impl does not support setChannel(Channel, Channel), it can throw an UnsupportedOperationException

Parameters:

channel - the channel to set, not allowed to be null

previewChannel - the channel to set, not allowed to be null. if there is no preview, the previewChannel is the same as channel

Throws:

{@link - UnsupportedOperationException} when the implementation does not support to set a Channel and IllegalArgumentException when channel is null

UnsupportedOperationException

addMount

void addMount(MutableMount mount)
       throws IllegalArgumentException

Parameters:

mount - the MutableMount to add

Throws:

IllegalArgumentException - if the mount could not be added