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

Methods

Modifier and Type	Method and Description
void	addMount(MutableMount mount)
String	getCmsLocation()
String	getLockedBy() Deprecated. deprecated since 7.8.4 and will be removed in 7.9.x
Calendar	getLockedOn() Deprecated. deprecated since 7.8.4 and will be removed in 7.9.x
void	setChannel(Channel channel) Sets the info for this Mount.
void	setChannelInfo(ChannelInfo info) Set the channel info for the mount.
void	setLockedBy(String userId) Deprecated. deprecated since 7.8.4 and will be removed in 7.9.x
void	setLockedOn(Calendar lockedOn) Deprecated. deprecated since 7.8.4 and will be removed in 7.9.x

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

containsMultipleSchemes, getAlias, getCanonicalContentPath, getChannel, getChannelInfo, getChannelPath, getChildMount, getChildMounts, getContentPath, getDefaultResourceBundleId, getDefaultResourceBundleIds, getDefaultSiteMapItemHandlerIds, getEmbeddedMountPath, getFormLoginPage, getHomePage, getHstSite, getHstSiteMapMatcher, getIdentifier, getLocale, getMountPath, getMountPoint, getMountProperties, getName, getNamedPipeline, getPageNotFound, getParameter, getParameters, getParent, getPort, getProperty, 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)

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

Parameters:

info -

setChannel

void setChannel(Channel channel)
                throws UnsupportedOperationException

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

Parameters:

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

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,
                     ServiceException

Parameters:

mount - the MutableMount to add

Throws:

IllegalArgumentException - if the mount could not be added

ServiceException - if the mount could not be added

getCmsLocation

String getCmsLocation()

Returns:

the cms location (fully qualified URL) or null if not configured

getLockedBy

@Deprecated
String getLockedBy()

Deprecated. deprecated since 7.8.4 and will be removed in 7.9.x

Return null when the mount is not locked.

Returns:

userId of the lock owner or null if not locked

setLockedBy

@Deprecated
void setLockedBy(String userId)

Deprecated. deprecated since 7.8.4 and will be removed in 7.9.x

Set the mount's lock owner userId.

getLockedOn

@Deprecated
Calendar getLockedOn()

Deprecated. deprecated since 7.8.4 and will be removed in 7.9.x

Get the date on which the mount was locked. If the mount is not locked, this date can by any date and null.

Returns:

the date on which the mount was locked

setLockedOn

@Deprecated
void setLockedOn(Calendar lockedOn)

Deprecated. deprecated since 7.8.4 and will be removed in 7.9.x

Set the date on which the mount was locked.

Parameters:

lockedOn -