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

Constructor Summary

Channel()
Channel default constructor it is required for REST de/serialization

Channel(Channel orig)
Copy constructor; create an independent copy of a channel.

Channel(String id)
Constructor of a Channel.

Method Summary

boolean	equals(Object other)
String	getChannelInfoClassName()
String	getCmsPreviewPrefix()
String	getContentRoot()
String	getContextPath()
String	getHostname()
String	getHstConfigPath()
String	getHstMountPoint()
String	getHstPreviewMountPoint()
String	getId()
String	getLocale()
String	getLockedBy() Retrieve this channel lock owner's userId.
Long	getLockedOn() Retrieve the timestamp when the lock was set.
String	getMountId()
String	getMountPath()
String	getName()
Map<String,Object>	getProperties()
String	getType()
String	getUrl()
int	hashCode()
boolean	isComposerModeEnabled()
void	setChannelInfoClassName(String channelInfoClassName)
void	setCmsPreviewPrefix(String cmsPreviewPrefix)
void	setComposerModeEnabled(boolean composerModeEnabled)
void	setContentRoot(String contentRoot)
void	setContextPath(String contextPath)
void	setHostname(String hostname)
void	setHstConfigPath(String hstConfigPath)
void	setHstMountPoint(String hstMountPoint)
void	setHstPreviewMountPoint(String hstPreviewMountPoint)
void	setId(String id) Set the unique ID of this channel
void	setLocale(String locale)
void	setLockedBy(String lockedBy) Set owner of this channel's lock.
void	setLockedOn(Long lockedOn) Set to null if the channel is not locked.
void	setMountId(String mountId)
void	setMountPath(String mountPath)
void	setName(String name) Sets the human-readable name of this channel.
void	setType(String type)
void	setUrl(String url)
String	toString()

Methods inherited from class java.lang.Object

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

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 orig)

Copy constructor; create an independent copy of a channel.

Parameters:

orig - the original channel to copy

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)

setHstPreviewMountPoint

public void setHstPreviewMountPoint(String hstPreviewMountPoint)

getHstPreviewMountPoint

public String getHstPreviewMountPoint()

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()

getProperties

public Map<String,Object> getProperties()

getChannelInfoClassName

public String getChannelInfoClassName()

setChannelInfoClassName

public void setChannelInfoClassName(String channelInfoClassName)

setMountId

public void setMountId(String mountId)

getMountId

public String getMountId()

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)

getLockedBy

public String getLockedBy()

Retrieve this channel lock owner's userId. Returns null if the channel is not locked.

Returns:

this channel lock owner's userId

setLockedBy

public void setLockedBy(String lockedBy)

Set owner of this channel's lock. Set to null if the channel is not locked.

Parameters:

lockedBy - this channel lock owner's userId

getLockedOn

public Long getLockedOn()

Retrieve the timestamp when the lock was set. Be warned that this method returns gives invalid results if the channel is not locked.

Returns:

timestamp in milliseconds of when channel lock was acquired

setLockedOn

public void setLockedOn(Long lockedOn)

Set to null if the channel is not locked.

Parameters:

lockedOn - timestamp in milliseconds of when channel lock was acquired

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