Channel (Hippo Site Toolkit 2.26.05 API)

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

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(String id)
Constructor of a Channel.

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

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`Set<String>`	`getChangedBySet()`
`String`	`getChannelInfoClassName()`
`String`	`getCmsPreviewPrefix()`
`String`	`getContentRoot()`
`String`	`getContextPath()`
`String`	`getDefaultDevice()`
`List<String>`	`getDevices()`
`String`	`getHostname()`
`String`	`getHstConfigPath()`
`String`	`getHstMountPoint()`
`String`	`getHstPreviewMountPoint()`
`String`	`getId()`
`String`	`getLocale()`
`String`	`getLockedBy()` Deprecated. use `getChangedBySet()` instead
`Long`	`getLockedOn()` In coarse grained locking mode: 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()`
`boolean`	`isFineGrainedLocking()` Deprecated. from 7.8.x in the 7.9, this method will be removed
`boolean`	`isPreviewHstConfigExists()`
`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`	`setCmsPreviewPrefix(String cmsPreviewPrefix)`
`void`	`setComposerModeEnabled(boolean composerModeEnabled)`
`void`	`setContentRoot(String contentRoot)`
`void`	`setContextPath(String contextPath)`
`void`	`setDefaultDevice(String defaultDevice)`
`void`	`setDevices(List<String> devices)`
`void`	`setFineGrainedLocking(boolean fineGrainedLocking)` Deprecated. from 7.8.x in the 7.9, this method will be removed
`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)` Deprecated. use `setChangedBySet(java.util.Set)` instead
`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`	`setPreviewHstConfigExists(boolean previewHstConfigExists)`
`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

- 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
- 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)
```
  - isFineGrainedLocking
```
@Deprecated
public boolean isFineGrainedLocking()
```
    Deprecated. from 7.8.x in the 7.9, this method will be removed
  - setFineGrainedLocking
```
@Deprecated
public void setFineGrainedLocking(boolean fineGrainedLocking)
```
    Deprecated. from 7.8.x in the 7.9, this method will be removed
  - isPreviewHstConfigExists
```
public boolean isPreviewHstConfigExists()
```
  - setPreviewHstConfigExists
```
public void setPreviewHstConfigExists(boolean previewHstConfigExists)
```
  - getLockedBy
```
@Deprecated
public String getLockedBy()
```
    Deprecated. use getChangedBySet() instead
    
    Returns:
    In coarse grained locking mode: retrieves this channel lock owner's userId. Returns null if the channel is not locked. In finagrained locking mode : retrieves just one of the users that have a lock on a container or null when locked by no-one.
  - setLockedBy
```
@Deprecated
public void setLockedBy(String lockedBy)
```
    Deprecated. use setChangedBySet(java.util.Set) instead
  - getChangedBySet
```
public Set<String> getChangedBySet()
```
    Returns:
    all 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
  - getLockedOn
```
public Long getLockedOn()
```
    In coarse grained locking mode: retrieve the timestamp when the lock was set. Be warned that this method returns gives invalid results if the channel is not locked. In finegrained locking mode it always returns null
    
    Returns:
    In coarse grained locking mode the timestamp in milliseconds of when channel lock was acquired and in finegrained locking mode always returns null
  - 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
  - getDefaultDevice
```
public String getDefaultDevice()
```
  - getDevices
```
public List<String> getDevices()
```
  - setDefaultDevice
```
public void setDefaultDevice(String defaultDevice)
```
  - setDevices
```
public void setDevices(List<String> devices)
```
  - 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

Class Channel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_DEVICE

Constructor Detail

Channel

Channel

Method Detail

getId

setId

getContentRoot

setContentRoot

getHstMountPoint

setHstMountPoint

setHstPreviewMountPoint

getHstPreviewMountPoint

getHstConfigPath

setHstConfigPath

getName

setName

getUrl

setUrl

setType

getType

isComposerModeEnabled

setComposerModeEnabled

setHostname

getHostname

setMountPath

getMountPath

getProperties

getChannelInfoClassName

setChannelInfoClassName

setMountId

getMountId

getLocale

setLocale

getCmsPreviewPrefix

setCmsPreviewPrefix

getContextPath

setContextPath

isFineGrainedLocking

setFineGrainedLocking

isPreviewHstConfigExists

setPreviewHstConfigExists

getLockedBy

setLockedBy

getChangedBySet

setChangedBySet

getLockedOn

setLockedOn

getDefaultDevice

getDevices

setDefaultDevice

setDevices

hashCode

equals

toString