lumis.portal.channel
Class ChannelConfig

java.lang.Object
  lumis.portal.structure.StructureElement
      lumis.portal.channel.ChannelConfig

All Implemented Interfaces:

Cloneable, ICacheEntry, ICloneableCacheEntry, ICloneableConfig<ChannelConfig>

Direct Known Subclasses:

ChannelDataType.Data

@StableMinor(version="6.2",
             sinceVersion="4.0")
public class ChannelConfig
extends StructureElement
implements ICloneableCacheEntry, ICloneableConfig<ChannelConfig>

Channel entity class

Since:

4.0.0

Field Summary

static int	CHANNEL_TYPE_BASIC
static int	CHANNEL_TYPE_LUMISADMIN
static int	FRIENDLY_PATH_TYPE_CHANNEL_NAME The friendly path is generated using the parent channel's path and appending this channel's name
static int	FRIENDLY_PATH_TYPE_INHERIT The friendly path is the same as this channel's parent friendly path.
static int	FRIENDLY_PATH_TYPE_USER_DEFINED The friendly path is user defined.
static String	LUMIS_ADMIN_CHANNEL_ID
static String	PORTAL_CHANNEL_ID

Constructor Summary

ChannelConfig()

Method Summary

protected void	applyPropertyBagChanges() Apply the changes made to the properties managed by this element to the property bag persistence entities.
ChannelConfig	clone()
void	deserialize(Node channelNode)
boolean	equals(Object o)
String	getAccessControlListId()
int	getCachePages()
int	getCenterPages()
String	getDescription()
String	getFriendlyId() Returns the channel's friendly identifier.
protected int	getFriendlyIdMaxLength() Returns the maximum length of friendly identifier.
int	getFriendlyPathType()
String	getFriendlyPathUserDefined()
String	getFriendlyURLPattern() Returns the friendly URL pattern specific for this channel (non-inheritable).
String	getId()
String	getLayoutFilePath() Returns the path for the layout file for use by this channel.
int	getLayoutPagesType() Returns the layout format for pages.
String	getLocalGroupPrefix()
protected Pattern	getManagedPropertiesPattern() Returns the property name spaces.
String	getName()
String	getPageRuntimeDataProviderClassName() Deprecated. Since 5.0.0 replaced by getPageWebResourceDataProviderClassName().
int	getPageRuntimeDataProviderType() Deprecated. Since 5.0.0 replaced by getPageWebResourceDataProviderType().
String	getPageTemplateId()
String	getPageWebResourceDataProviderClassName() Returns the class name for the page web resource data provider.
int	getPageWebResourceDataProviderType() Returns the page web resource data provider type.
String	getParentId()
String	getParentTemplateId()
int	getPosition()
String	getPropertyBagId() Returns the property bag identifier.
int	getProtocol()
String	getTemplateLocalGroupPrefix() Returns the template local group prefix.
int	getType()
boolean	hasLocalGroups()
boolean	isAutomaticFriendlyId() Returns whether the channel is going to use automatic generated friendly identifier or not.
boolean	isFriendlyURLPatternEnabled() Returns if the friendly URL pattern specific for this channel (non-inheritable) is enabled.
boolean	isHidden()
boolean	isInheritMetaTags()
boolean	isInheritPageTemplate()
boolean	isInheritProtocol() Deprecated. since 4.0.11. This property is acquired via the getProtocol() method.
boolean	isInheritStylesheet()
boolean	isTemplate()
protected void	loadPropertyBagValues() Loads the values of the property bag of this element.
protected boolean	mayUseFriendlyId(String friendlyId) Indicates if the element may use the given friendly identifier.
void	serialize(ChannelConfig channelConfig, OutputStream outputStream)
void	setAccessControlListId(String accessControlListId)
void	setAutoGeneratedFriendlyId() Generates a new friendly identifier and sets it as the friendly identifier of this channel.
void	setAutomaticFriendlyId(boolean automaticFriendlyId) Indicates whether the channel is going to use automatic generated friendly identifier or not.
void	setCachePages(int cachePages)
void	setCenterPages(int centerPages)
void	setDescription(String description)
void	setFriendlyId(String friendlyId) Sets the channel's friendly identifier.
void	setFriendlyPathType(int friendlyPathType)
void	setFriendlyPathUserDefined(String friendlyPathUserDefined)
void	setFriendlyURLPattern(String friendlyURLPattern) Sets the friendly URL pattern specific for this channel (non-inheritable).
void	setFriendlyURLPatternEnabled(boolean friendlyURLPatternEnabled) Sets if the friendly URL pattern specific for this channel (non-inheritable) is enabled.
void	setHidden(boolean hidden)
void	setId(String id)
void	setInheritMetaTags(boolean inheritMetaTags)
void	setInheritPageTemplate(boolean inheritPageTemplate)
void	setInheritProtocol(boolean inheritProtocol) Deprecated. since 4.0.11. This property is set via the #setProtocol() method.
void	setInheritStylesheet(boolean inheritStylesheet)
void	setLayoutFilePath(String layoutFile) Sets the path for the layout file.
void	setLayoutPagesType(int layoutPagesType) Sets the layout format for pages.
protected void	setLayoutPagesTypeInternal(int layoutPagesType) Sets the layout format for pages.
void	setLocalGroupPrefix(String localGroupPrefix)
void	setLocalGroups(boolean localGroups)
void	setName(String name)
void	setPageRuntimeDataProviderClassName(String runtimeDataProviderClassName) Deprecated. Since 5.0.0 replaced by setPageWebResourceDataProviderClassName(String).
void	setPageRuntimeDataProviderType(int runtimeDataProviderType) Deprecated. Since 5.0.0 replaced by setPageWebResourceDataProviderType(int).
void	setPageTemplateId(String pageTemplateId)
void	setPageWebResourceDataProviderClassName(String providerClassName) Sets the page web resource provider class name.
void	setPageWebResourceDataProviderType(int providerType) Sets the page web resource data provider type.
void	setParentId(String parentId)
void	setParentTemplateId(String parentTemplateId)
void	setPosition(int position)
protected void	setPropertyBagId(String propertyBagId) Sets the property bag identifier.
void	setProtocol(int protocol)
void	setTemplate(boolean isTemplate)
void	setTemplateLocalGroupPrefix(String templateLocalGroupPrefix) Sets the template local group prefix.
void	setType(int type)

Methods inherited from class lumis.portal.structure.StructureElement

getAutomaticFriendlyId, getFriendlyIdBaseValue, getFriendlyIdValueForCounter, getPropertyValue, isManagedProperty, removeProperty, serializePropertyBag, setPropertyValue, stripAccents

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CHANNEL_TYPE_BASIC

public static final int CHANNEL_TYPE_BASIC

See Also:

Constant Field Values

CHANNEL_TYPE_LUMISADMIN

public static final int CHANNEL_TYPE_LUMISADMIN

See Also:

Constant Field Values

PORTAL_CHANNEL_ID

public static final String PORTAL_CHANNEL_ID

See Also:

Constant Field Values

LUMIS_ADMIN_CHANNEL_ID

public static final String LUMIS_ADMIN_CHANNEL_ID

See Also:

Constant Field Values

FRIENDLY_PATH_TYPE_CHANNEL_NAME

public static final int FRIENDLY_PATH_TYPE_CHANNEL_NAME

The friendly path is generated using the parent channel's path and appending this channel's name

See Also:

Constant Field Values

FRIENDLY_PATH_TYPE_USER_DEFINED

public static final int FRIENDLY_PATH_TYPE_USER_DEFINED

The friendly path is user defined.

See Also:

Constant Field Values

FRIENDLY_PATH_TYPE_INHERIT

public static final int FRIENDLY_PATH_TYPE_INHERIT

The friendly path is the same as this channel's parent friendly path.

See Also:

Constant Field Values

Constructor Detail

ChannelConfig

public ChannelConfig()

Method Detail

getManagedPropertiesPattern

protected Pattern getManagedPropertiesPattern()

Description copied from class: StructureElement

Returns the property name spaces. Used to decides if a property can be updated.

Specified by:

getManagedPropertiesPattern in class StructureElement

Returns:

property name spaces

loadPropertyBagValues

protected void loadPropertyBagValues()
                              throws PortalException

Description copied from class: StructureElement

Loads the values of the property bag of this element.

Only the properties that can be changed are actually loaded.

Overrides:

loadPropertyBagValues in class StructureElement

Throws:

PortalException

See Also:

StructureElement.isManagedProperty(String)

applyPropertyBagChanges

protected void applyPropertyBagChanges()
                                throws PortalException

Description copied from class: StructureElement

Apply the changes made to the properties managed by this element to the property bag persistence entities.

Overrides:

applyPropertyBagChanges in class StructureElement

Throws:

PortalException

See Also:

StructureElement.isManagedProperty(String)

getLayoutFilePath

public String getLayoutFilePath()

Returns the path for the layout file for use by this channel.

The layout file is inherited to child elements and from parent.

If getLayoutPagesType() is not PageConfig.PAGE_LAYOUT_TYPE_LAYOUT_FILE (or inherited it), this method will return null since no layout file is to be used.

Returns:

layoutFile the path for the layout file, relative to the <lumisdata>/def directory, possibly inherited from parent channel; or null if no layout file is to be used.

Since:

5.6.0

See Also:

getLayoutPagesType(), setLayoutFilePath(String)

setLayoutFilePath

public void setLayoutFilePath(String layoutFile)

Sets the path for the layout file.

The path must be relative to the <lumisdata>/def directory, or null for inheriting the value from the parent channel.

The layout file is inherited to child elements.

The layout file property is applicable only if getLayoutPagesType() is PageConfig.PAGE_LAYOUT_TYPE_LAYOUT_FILE or inherited this value.

Parameters:

layoutFile - the path relative to the <lumisdata>/def directory, or null for inheriting the value from the parent channel.

Since:

5.6.0

See Also:

setLayoutPagesType(int)

getId

public String getId()

Returns:

Returns the channelId.

setId

public void setId(String id)

Parameters:

id - The channelId to set.

getDescription

public String getDescription()

Returns:

Returns the description.

setDescription

public void setDescription(String description)

Parameters:

description - The description to set.

getName

public String getName()

Returns:

Returns the name.

setName

public void setName(String name)

Parameters:

name - The name to set.

isHidden

public boolean isHidden()

Returns:

Returns the hidden.

setHidden

public void setHidden(boolean hidden)

Parameters:

hidden - The hidden to set.

isInheritStylesheet

public boolean isInheritStylesheet()

Returns:

true if the Stylesheet was inherited and false otherwise.

isInheritMetaTags

public boolean isInheritMetaTags()

Returns:

true if the Meta-Tags is inherited and false otherwise.

setInheritStylesheet

public void setInheritStylesheet(boolean inheritStylesheet)

Parameters:

inheritStylesheet -

setInheritMetaTags

public void setInheritMetaTags(boolean inheritMetaTags)

Parameters:

inheritMetaTags -

isInheritProtocol

@Deprecated
public boolean isInheritProtocol()

Deprecated. since 4.0.11. This property is acquired via the getProtocol() method.

Returns:

Returns the inheritProtocol.

setInheritProtocol

@Deprecated
public void setInheritProtocol(boolean inheritProtocol)

Deprecated. since 4.0.11. This property is set via the #setProtocol() method.

Parameters:

inheritProtocol - The inheritProtocol to set.

isTemplate

public boolean isTemplate()

Returns:

Returns the isTemplate.

setTemplate

public void setTemplate(boolean isTemplate)

Parameters:

isTemplate - The isTemplate to set.

getPageTemplateId

public String getPageTemplateId()

Returns:

Returns the pageTemplateId.

setPageTemplateId

public void setPageTemplateId(String pageTemplateId)

Parameters:

pageTemplateId - The pageTemplateId to set.

getParentId

public String getParentId()

Returns:

Returns the parentId.

setParentId

public void setParentId(String parentId)

Parameters:

parentId - The parentId to set.

getPosition

public int getPosition()

Returns:

Returns the position.

setPosition

public void setPosition(int position)

Parameters:

position - The position to set.

getProtocol

public int getProtocol()

Returns:

Returns the protocol.

setProtocol

public void setProtocol(int protocol)

Parameters:

protocol - The protocol to set.

getType

public int getType()

Returns:

Returns the type.

setType

public void setType(int type)

Parameters:

type - The type to set.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getAccessControlListId

public String getAccessControlListId()

Returns:

Returns the accessControlListId.

setAccessControlListId

public void setAccessControlListId(String accessControlListId)

Parameters:

accessControlListId - The accessControlListId to set.

getPropertyBagId

public String getPropertyBagId()

Description copied from class: StructureElement

Returns the property bag identifier.

Specified by:

getPropertyBagId in class StructureElement

Returns:

The propertyBagId.

setPropertyBagId

protected void setPropertyBagId(String propertyBagId)

Sets the property bag identifier.

This method should be used only for non-persisted channel, because this property value may not be changed.

Parameters:

propertyBagId - The propertyBagId to set.

Since:

5.0.0

getCenterPages

public int getCenterPages()

Returns:

Returns the centerPages.

setCenterPages

public void setCenterPages(int centerPages)

Parameters:

centerPages - The centerPages to set.

getLayoutPagesType

public int getLayoutPagesType()

Returns the layout format for pages.

Returns:

The layout format for pages.

setLayoutPagesType

public void setLayoutPagesType(int layoutPagesType)

Sets the layout format for pages.

Parameters:

layoutPagesType - one of the valid page layout formats The layout format to set for pages.

setLayoutPagesTypeInternal

protected void setLayoutPagesTypeInternal(int layoutPagesType)

Sets the layout format for pages.

Parameters:

layoutPagesType - one of the valid page layout formats The layout format to set for pages.

getCachePages

public int getCachePages()

Returns:

Returns the cachePages.

setCachePages

public void setCachePages(int cachePages)

Parameters:

cachePages - The cachePages to set.

hasLocalGroups

public boolean hasLocalGroups()

Returns:

Returns the localGroups.

setLocalGroups

public void setLocalGroups(boolean localGroups)

Parameters:

localGroups - The localGroups to set.

getLocalGroupPrefix

public String getLocalGroupPrefix()

Returns:

Returns the localGroupPrefix.

setLocalGroupPrefix

public void setLocalGroupPrefix(String localGroupPrefix)

Parameters:

localGroupPrefix - The localGroupPrefix to set.

getTemplateLocalGroupPrefix

public String getTemplateLocalGroupPrefix()

Returns the template local group prefix. This attribute specifies the pattern used when applying a channel template.

Returns:

the template local group prefix.

Since:

4.0.6

setTemplateLocalGroupPrefix

public void setTemplateLocalGroupPrefix(String templateLocalGroupPrefix)

Sets the template local group prefix.

Parameters:

templateLocalGroupPrefix - the value to set.

Since:

4.0.6

See Also:

getTemplateLocalGroupPrefix()

getFriendlyPathType

public int getFriendlyPathType()

setFriendlyPathType

public void setFriendlyPathType(int friendlyPathType)

getFriendlyPathUserDefined

public String getFriendlyPathUserDefined()

setFriendlyPathUserDefined

public void setFriendlyPathUserDefined(String friendlyPathUserDefined)

setFriendlyId

public void setFriendlyId(String friendlyId)

Sets the channel's friendly identifier. This value must be unique among the channels contained in the same channel this channel is contained.

Parameters:

friendlyId - the channel's friendly identifier.

Since:

6.0.0

setAutoGeneratedFriendlyId

public void setAutoGeneratedFriendlyId()

Generates a new friendly identifier and sets it as the friendly identifier of this channel. The friendly identifier is generated based on this channel's current name.

This method requires an active transaction.

Since:

6.0.0

See Also:

setFriendlyId(String)

getFriendlyId

public String getFriendlyId()

Returns the channel's friendly identifier.

Returns:

the channel's friendly identifier.

Since:

6.0.0

setAutomaticFriendlyId

public void setAutomaticFriendlyId(boolean automaticFriendlyId)

Indicates whether the channel is going to use automatic generated friendly identifier or not.

Parameters:

automaticFriendlyId - indicates whether the channel is going to use automatic generated friendly identifier or not.

Since:

6.0.0

isAutomaticFriendlyId

public boolean isAutomaticFriendlyId()

Returns whether the channel is going to use automatic generated friendly identifier or not.

Returns:

whether the channel is going to use automatic generated friendly identifier or not.

Since:

6.0.0

clone

public ChannelConfig clone()
                    throws CloneNotSupportedException

Specified by:

clone in interface ICloneableCacheEntry

Specified by:

clone in interface ICloneableConfig<ChannelConfig>

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

serialize

public void serialize(ChannelConfig channelConfig,
                      OutputStream outputStream)
               throws PortalException

Throws:

PortalException

deserialize

public void deserialize(Node channelNode)
                 throws PortalException

Throws:

PortalException

getParentTemplateId

public String getParentTemplateId()

setParentTemplateId

public void setParentTemplateId(String parentTemplateId)

isInheritPageTemplate

public boolean isInheritPageTemplate()

setInheritPageTemplate

public void setInheritPageTemplate(boolean inheritPageTemplate)

getPageRuntimeDataProviderType

@Deprecated
public int getPageRuntimeDataProviderType()

Deprecated. Since 5.0.0 replaced by getPageWebResourceDataProviderType().

Returns the page runtime data provider type. The possible values are or or or

Returns:

the runtime data provider type.

Since:

4.2.0

setPageRuntimeDataProviderType

@Deprecated
public void setPageRuntimeDataProviderType(int runtimeDataProviderType)

Deprecated. Since 5.0.0 replaced by setPageWebResourceDataProviderType(int).

Sets the page runtime data provider type. The possible values are or or or

Parameters:

runtimeDataProviderType - the runtime data provider type.

Since:

4.2.0

getPageRuntimeDataProviderClassName

@Deprecated
public String getPageRuntimeDataProviderClassName()

Deprecated. Since 5.0.0 replaced by getPageWebResourceDataProviderClassName().

Returns the class name for the page runtime data provider. This value should only be used if the runtime data provider type is

Returns:

the runtime data provider class name

Since:

4.2.0

setPageRuntimeDataProviderClassName

@Deprecated
public void setPageRuntimeDataProviderClassName(String runtimeDataProviderClassName)

Deprecated. Since 5.0.0 replaced by setPageWebResourceDataProviderClassName(String).

Sets the runtime data provider class name.

Parameters:

runtimeDataProviderClassName - the class name to be set.

Since:

4.2.0

getPageWebResourceDataProviderClassName

public String getPageWebResourceDataProviderClassName()

Returns the class name for the page web resource data provider.

This value should only be used if the page web resource data provider type is PageConfig.PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CUSTOM

Returns:

the runtime data provider class name

Since:

5.0.0

setPageWebResourceDataProviderClassName

public void setPageWebResourceDataProviderClassName(String providerClassName)

Sets the page web resource provider class name.

Parameters:

providerClassName - the class name to be set.

Since:

5.0.0

getPageWebResourceDataProviderType

public int getPageWebResourceDataProviderType()

Returns the page web resource data provider type. The possible values are PageConfig.PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_INHERIT or PageConfig.PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_DEFAULT or PageConfig.PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CONTENT or PageConfig.PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CUSTOM

Returns:

the page web resource data provider type.

Since:

5.0.0

setPageWebResourceDataProviderType

public void setPageWebResourceDataProviderType(int providerType)

Sets the page web resource data provider type. The possible values are PageConfig.PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_INHERIT or PageConfig.PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_DEFAULT or PageConfig.PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CONTENT or PageConfig.PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CUSTOM

Parameters:

providerType - the page web resource data provider type.

Since:

5.0.0

getFriendlyURLPattern

public String getFriendlyURLPattern()

Returns the friendly URL pattern specific for this channel (non-inheritable).

Returns:

the friendlyURLPattern the pattern, or null if it is not set for this channel.

Since:

5.0.0

setFriendlyURLPattern

public void setFriendlyURLPattern(String friendlyURLPattern)

Sets the friendly URL pattern specific for this channel (non-inheritable).

Parameters:

friendlyURLPattern - the pattern.

Since:

5.0.0

isFriendlyURLPatternEnabled

public boolean isFriendlyURLPatternEnabled()

Returns if the friendly URL pattern specific for this channel (non-inheritable) is enabled.

Returns:

true if enabled, false if disabled.

Since:

5.0.0

setFriendlyURLPatternEnabled

public void setFriendlyURLPatternEnabled(boolean friendlyURLPatternEnabled)

Sets if the friendly URL pattern specific for this channel (non-inheritable) is enabled.

Parameters:

friendlyURLPatternEnabled - true to enable, false to disable.

Since:

5.0.0

mayUseFriendlyId

protected boolean mayUseFriendlyId(String friendlyId)
                            throws PortalException

Description copied from class: StructureElement

Indicates if the element may use the given friendly identifier.

Specified by:

mayUseFriendlyId in class StructureElement

Parameters:

friendlyId - the friendly identifier.

Returns:

true if the element may use the given friendly identifier, false otherwise.

Throws:

PortalException

getFriendlyIdMaxLength

protected int getFriendlyIdMaxLength()

Description copied from class: StructureElement

Returns the maximum length of friendly identifier.

Overrides:

getFriendlyIdMaxLength in class StructureElement

Returns:

the maximum length of friendly identifier.