Package lumis.portal.page

Class PageWebResource

java.lang.Object

lumis.portal.url.WebResource

lumis.portal.page.PageWebResource

All Implemented Interfaces:

java.lang.Cloneable, ICacheEntry, ICloneableCacheEntry

Direct Known Subclasses:

PageWebResourceWithExtraParametersWrapper

@StableMinor(version="17.0",
             sinceVersion="5.0")
public class PageWebResource
extends WebResource

A page web resource is a concrete derivation of a PageConfig, that may be rendered or linked to. The portal web pages visible by portal users are page web resources rendered.

Since:

5.0.0

Version:

$Revision$ $Date$

Method Summary

Modifier and Type	Method	Description
PageWebResource	clone()
java.net.URL	getCanonicalUrl()	Returns the canonical URL for this web resource.
java.lang.String	getName()	Returns the name for this web resource.
PageConfig	getPage()	Returns the page this web resource is based on.
PageWebResourceData	getPageWebResourceData()	Returns the data generated in runtime for this page web resource.
java.util.Map<java.lang.String,java.lang.String[]>	getParameterMap()	Returns a map containing all parameters for this web resource.
WebResource	getParent()	Returns the web resource of the parent element of this web resource.
javax.portlet.PortletMode	getPortletMode()	Returns the portlet mode for the target in this page web resource.
IProject	getProject()	Returns the project this web resource belongs to (if any). It is important to notice that the relation webresource <-> project is not persisted.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getProperties()	Returns the properties for this web resource.
protected java.lang.String	getRecommendedFileExtension()	Returns the file extension recommended for this web resource, according to its configurations.
java.lang.String	getRunTimeServiceInstanceId()	Returns the service instance identifier of the runtime service instance for this page web resource.
java.lang.String	getRunTimeServiceInterfaceId()	Returns the service interface identifier of the runtime service interface for this page web resource.
protected java.lang.String	getSeoRuleUrlPattern()	Get the Url Path from the SeoRule linked to this WebResource.
java.lang.String	getTargetId()	Returns the target identifier for this page web resource.
int	getTargetScope()	Returns the target scope for this page web resource.
java.lang.String	getTitle()	Returns the title for this web resource.
java.lang.String	getUrlTitle()	Returns the title value meant to be used for friendly URL generation of this web resource.
javax.portlet.WindowState	getWindowState()	Returns the window state for the target in this page web resource.
protected boolean	hasSSI()	Returns whether this web resource has Server Side Include (requires SSI pos-processing).
boolean	isCacheEnabled()	Returns if the cache is enabled for this web resource.
protected boolean	isFriendlyURLEnabled()	Indicates if friendly URL is enabled for this web resource.
boolean	isPreviewModeEnabled()	Returns true if this page web resource is being processed in preview mode.
protected void	setDynamicPath(java.lang.String dynamicPath)	Sets the dynamic path for this web resource.
void	setPreviewModeEnabled(boolean previewModeEnabled)	Sets the preview mode for processing this page web resource.

Methods inherited from class lumis.portal.url.WebResource

calculatePath, getCreatedDateTime, getDynamicPath, getFriendlyPath, getFriendlyURLPattern, getId, getLocale, getPageCache, getParameter, getParameterValues, getPath, getWebsite, isAvailableForGetRequest, isCacheEnabled, isDynamicRequestValid, localize, mayBePersisted, setFriendlyPath, setId, setLocale, setPageCache, setWebsite, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getName

public java.lang.String getName()

Description copied from class: WebResource

Returns the name for this web resource. The name is usually used for management display purposes.

Specified by:

getName in class WebResource

Returns:

this web resource's name, localized according to its locale.

See Also:

WebResource.getLocale()

getTitle

public java.lang.String getTitle()

Description copied from class: WebResource

Returns the title for this web resource. The title is usually used as an end-user title.

Specified by:

getTitle in class WebResource

Returns:

this web resource's title, localized according to its locale.

See Also:

WebResource.getLocale()

getUrlTitle

public java.lang.String getUrlTitle()

Description copied from class: WebResource

Returns the title value meant to be used for friendly URL generation of this web resource.

Specified by:

getUrlTitle in class WebResource

Returns:

the title value.

See Also:

IURLResolver

getCanonicalUrl

public java.net.URL getCanonicalUrl()

Returns the canonical URL for this web resource.

The canonical URL value is provided by IPageWebResourceDataProvider in PageWebResourceData.getCanonicalUrl().

Returns:

the canonical URL, or null if this web resource is not available for access in a web site.

Since:

10.1.0

See Also:

The Canonical Link Relation

setDynamicPath

protected void setDynamicPath(java.lang.String dynamicPath)

Description copied from class: WebResource

Sets the dynamic path for this web resource.

Overrides:

setDynamicPath in class WebResource

Parameters:

dynamicPath - the dynamic path relative to the portal web application root. It must start with '/'.

isCacheEnabled

public boolean isCacheEnabled()

Description copied from class: WebResource

Returns if the cache is enabled for this web resource.

Overrides:

isCacheEnabled in class WebResource

Returns:

true if the cache is enabled, false otherwise.

isFriendlyURLEnabled

protected boolean isFriendlyURLEnabled()

Description copied from class: WebResource

Indicates if friendly URL is enabled for this web resource.

Overrides:

isFriendlyURLEnabled in class WebResource

Returns:

true if it is enabled, false otherwise.

hasSSI

protected boolean hasSSI()

Description copied from class: WebResource

Returns whether this web resource has Server Side Include (requires SSI pos-processing).

Overrides:

hasSSI in class WebResource

Returns:

true if this web resource has SSI, false otherwise.

getRecommendedFileExtension

protected java.lang.String getRecommendedFileExtension()

Description copied from class: WebResource

Returns the file extension recommended for this web resource, according to its configurations.

Overrides:

getRecommendedFileExtension in class WebResource

Returns:

the extension, starting with '.'. Example: ".htm"

getParameterMap

public java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()

Description copied from class: WebResource

Returns a map containing all parameters for this web resource.

Specified by:

getParameterMap in class WebResource

Returns:

an immutable map containing all parameters for this web resource.

getParent

public WebResource getParent()

Description copied from class: WebResource

Returns the web resource of the parent element of this web resource.

Specified by:

getParent in class WebResource

Returns:

the parent of this web resource, or null if it has no parent.

getProperties

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getProperties()

Description copied from class: WebResource

Returns the properties for this web resource.

Specified by:

getProperties in class WebResource

Returns:

a immutable map where the key is the property name and the value is a list of the property's values.

getPageWebResourceData

public PageWebResourceData getPageWebResourceData()

Returns the data generated in runtime for this page web resource.

Since:

5.0.0

getPage

public PageConfig getPage()

Returns the page this web resource is based on.

Returns:

the page.

Since:

5.0.0

getTargetId

public java.lang.String getTargetId()

Returns the target identifier for this page web resource.

Returns:

the target identifier.

Since:

5.0.0

getTargetScope

public int getTargetScope()

Returns the target scope for this page web resource.

Returns:

the target scope. One of the TARGET_SCOPE_* constants in IServiceInterfaceUrl.

Since:

5.0.0

getPortletMode

public javax.portlet.PortletMode getPortletMode()

Returns the portlet mode for the target in this page web resource.

Returns:

the portlet mode.

Since:

5.0.0

getWindowState

public javax.portlet.WindowState getWindowState()

Returns the window state for the target in this page web resource.

Returns:

the window state.

Since:

5.0.0

isPreviewModeEnabled

public boolean isPreviewModeEnabled()

Returns true if this page web resource is being processed in preview mode.

Returns:

true if preview mode is enabled, false otherwise.

Since:

5.0.0

setPreviewModeEnabled

public void setPreviewModeEnabled(boolean previewModeEnabled)

Sets the preview mode for processing this page web resource.

Parameters:

previewModeEnabled - true to enable, false to disable.

Since:

5.0.0

getRunTimeServiceInstanceId

public java.lang.String getRunTimeServiceInstanceId()

Returns the service instance identifier of the runtime service instance for this page web resource.

Returns:

the service instance identifier, or null if this page web resource does not have a runtime service instance.

Since:

5.0.0

See Also:

ServiceInstanceConfig

getRunTimeServiceInterfaceId

public java.lang.String getRunTimeServiceInterfaceId()

Returns the service interface identifier of the runtime service interface for this page web resource.

Returns:

the service interface identifier, or null if this page web resource does not have a runtime service interface.

Since:

5.0.0

See Also:

ServiceInterfaceConfig

getSeoRuleUrlPattern

protected java.lang.String getSeoRuleUrlPattern()
                                         throws PortalException

Description copied from class: WebResource

Get the Url Path from the SeoRule linked to this WebResource.

Specified by:

getSeoRuleUrlPattern in class WebResource

Returns:

The url path pattern or null if not specified.

Throws:

PortalException

clone

public PageWebResource clone()
                      throws java.lang.CloneNotSupportedException

Specified by:

clone in interface ICloneableCacheEntry

Overrides:

clone in class WebResource

Throws:

java.lang.CloneNotSupportedException

getProject

public IProject getProject()
                    throws PortalException

Description copied from class: WebResource

Returns the project this web resource belongs to (if any).
It is important to notice that the relation webresource <-> project is not persisted. Instead, it is calculated at runtime.
This method may require a current transaction.

Specified by:

getProject in class WebResource

Returns:

the project this web resource belongs to (if any).

Throws:

PortalException