org.hippoecm.hst.configuration.channel

Class Channel

java.lang.Object

org.hippoecm.hst.configuration.channel.Channel

All Implemented Interfaces:

Serializable

public class Channel
extends Object
implements Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DEVICE

Constructor Summary

Constructors

Constructor and Description
Channel() Channel default constructor it is required for REST de/serialization
Channel(Channel channel)
Channel(String id) Constructor of a Channel.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
Set<String>	getChangedBySet()
String	getChannelInfoClassName()
String	getChannelNodeLockedBy()
String	getChannelPath()
String	getCmsPreviewPrefix()
String	getContentRoot()
String	getContextPath()
String	getDefaultDevice()
List<String>	getDevices()
boolean	getHasCustomProperties()
String	getHostname()
String	getHstConfigPath()
String	getHstMountPoint()
String	getId()
Calendar	getLastModified()
String	getLastModifiedBy()
String	getLocale()
Calendar	getLockedOn()
String	getMountId()
String	getMountPath()
String	getName()
Map<String,Object>	getProperties() Returns the Immutable collection of properties for this Channel.
String	getSiteMapId()
String	getType()
String	getUrl()
int	hashCode()
boolean	isComposerModeEnabled()
boolean	isDeletable()
boolean	isPreview()
boolean	isPreviewHstConfigExists()
boolean	isWorkspaceExists()
void	setChangedBySet(Set<String> changedBySet) sets all users that have a lock on the channel or some part of the channel
void	setChannelInfoClassName(String channelInfoClassName)
void	setChannelNodeLockedBy(String channelNodeLockedBy)
void	setChannelPath(String channelPath)
void	setCmsPreviewPrefix(String cmsPreviewPrefix)
void	setComposerModeEnabled(boolean composerModeEnabled)
void	setContentRoot(String contentRoot)
void	setContextPath(String contextPath)
void	setDefaultDevice(String defaultDevice)
void	setDeletable(boolean deletable)
void	setDevices(List<String> devices)
void	setHasCustomProperties(boolean hasCustomProperties)
void	setHostname(String hostname)
void	setHstConfigPath(String hstConfigPath)
void	setHstMountPoint(String hstMountPoint)
void	setId(String id) Set the unique ID of this channel
void	setLastModified(Calendar lastModified)
void	setLastModifiedBy(String lastModifiedBy)
void	setLocale(String locale)
void	setLockedOn(Calendar lockedOn)
void	setMountId(String mountId)
void	setMountPath(String mountPath)
void	setName(String name) Sets the human-readable name of this channel.
void	setPreview(boolean preview)
void	setPreviewHstConfigExists(boolean previewHstConfigExists)
void	setProperties(Map<String,Object> properties)
void	setSiteMapId(String sitemapId)
void	setType(String type)
void	setUrl(String url)
void	setWorkSpaceExists(boolean workspaceExists)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_DEVICE

public static final String DEFAULT_DEVICE

See Also:

Constant Field Values

Constructor Detail

Channel

public Channel()

Channel default constructor it is required for REST de/serialization

Channel

public Channel(String id)

Constructor of a Channel. Should normally only be invoked by the Channel manager implementation to guarantee uniqueness of the id.

Parameters:

id - the unique ID of this channel

Channel

public Channel(Channel channel)

Method Detail

getId

public String getId()

Returns:

the unique ID of this channel

setId

public void setId(String id)
           throws IllegalStateException

Set the unique ID of this channel

Throws:

IllegalStateException

getContentRoot

public String getContentRoot()

setContentRoot

public void setContentRoot(String contentRoot)

getHstMountPoint

public String getHstMountPoint()

setHstMountPoint

public void setHstMountPoint(String hstMountPoint)

getHstConfigPath

public String getHstConfigPath()

setHstConfigPath

public void setHstConfigPath(String hstConfigPath)

getName

public String getName()

Returns:

the human-readable name of this channel, or null if this channel does not have a name.

setName

public void setName(String name)

Sets the human-readable name of this channel.

Parameters:

name - the new name of this channel

getUrl

public String getUrl()

Returns:

the fully qualified URL of this channel.

setUrl

public void setUrl(String url)

Parameters:

url - the fully qualified URL of this channel.

setType

public void setType(String type)

getType

public String getType()

isComposerModeEnabled

public boolean isComposerModeEnabled()

setComposerModeEnabled

public void setComposerModeEnabled(boolean composerModeEnabled)

setHostname

public void setHostname(String hostname)

getHostname

public String getHostname()

setMountPath

public void setMountPath(String mountPath)

getMountPath

public String getMountPath()

setChannelPath

public void setChannelPath(String channelPath)

getChannelPath

public String getChannelPath()

setProperties

public void setProperties(Map<String,Object> properties)

getProperties

public Map<String,Object> getProperties()

Returns the Immutable collection of properties for this Channel.

getChannelInfoClassName

public String getChannelInfoClassName()

setChannelInfoClassName

public void setChannelInfoClassName(String channelInfoClassName)

setMountId

public void setMountId(String mountId)

getMountId

public String getMountId()

setSiteMapId

public void setSiteMapId(String sitemapId)

getSiteMapId

public String getSiteMapId()

getLocale

public String getLocale()

setLocale

public void setLocale(String locale)

getCmsPreviewPrefix

public String getCmsPreviewPrefix()

setCmsPreviewPrefix

public void setCmsPreviewPrefix(String cmsPreviewPrefix)

getContextPath

public String getContextPath()

setContextPath

public void setContextPath(String contextPath)

isPreviewHstConfigExists

public boolean isPreviewHstConfigExists()

setPreviewHstConfigExists

public void setPreviewHstConfigExists(boolean previewHstConfigExists)

isWorkspaceExists

public boolean isWorkspaceExists()

setWorkSpaceExists

public void setWorkSpaceExists(boolean workspaceExists)

getHasCustomProperties

public boolean getHasCustomProperties()

setHasCustomProperties

public void setHasCustomProperties(boolean hasCustomProperties)

isDeletable

public boolean isDeletable()

setDeletable

public void setDeletable(boolean deletable)

getChangedBySet

public Set<String> getChangedBySet()

Returns:

all *non-system* users that have a lock on the channel or some part of the channel. If no users have a lock, and empty set is returned

setChangedBySet

public void setChangedBySet(Set<String> changedBySet)

sets all users that have a lock on the channel or some part of the channel

getDefaultDevice

public String getDefaultDevice()

getDevices

public List<String> getDevices()

setDefaultDevice

public void setDefaultDevice(String defaultDevice)

setDevices

public void setDevices(List<String> devices)

setPreview

public void setPreview(boolean preview)

isPreview

public boolean isPreview()

getChannelNodeLockedBy

public String getChannelNodeLockedBy()

setChannelNodeLockedBy

public void setChannelNodeLockedBy(String channelNodeLockedBy)

getLastModifiedBy

public String getLastModifiedBy()

setLastModifiedBy

public void setLastModifiedBy(String lastModifiedBy)

getLockedOn

public Calendar getLockedOn()

setLockedOn

public void setLockedOn(Calendar lockedOn)

getLastModified

public Calendar getLastModified()

setLastModified

public void setLastModified(Calendar lastModified)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object