Package lumis.portal.presentation.mode

Class SettingsPortalMode

java.lang.Object

lumis.portal.presentation.mode.AbstractPortalMode

lumis.portal.presentation.mode.SettingsPortalMode

All Implemented Interfaces:

java.io.Serializable, IPortalMode, IPortalModeSPI

public class SettingsPortalMode
extends AbstractPortalMode

Settings portal mode.

Since:

7.1.0

Version:

$Revision$ $Date$

See Also:

Serialized Form

Field Summary

Fields inherited from class lumis.portal.presentation.mode.AbstractPortalMode

ROOT_CHANNELS_ONLY_PORTAL

Constructor Summary

Constructors

Constructor	Description
SettingsPortalMode(int id, java.lang.String name, java.lang.String description, IPermissionProvider permissionProvider, java.lang.Class<? extends HTMLFragmentComponent> renderComponentClass, java.lang.String[] attributeNames, java.lang.Class<? extends AbstractLayoutFileMarkupFilter> markupFilterClass, java.lang.String modeRootUrl)	Constructor for the class.

Method Summary

Modifier and Type	Method	Description
protected java.util.Set<java.lang.String>	getValidWebResourceRootChannels()	Used by the default implementation of AbstractPortalMode.isWebResourceAvailable(WebResource, ChannelConfig).
boolean	isAccessWithWebResourceWebsiteRequired(WebResource webResource, ChannelConfig rootChannel)	Returns whether the given web resource in the this mode may only be accessed using the web resource's website.
boolean	validateAccess(IPortalMode currentMode, javax.servlet.http.HttpServletRequest httpServletRequest, IPageWebResourceRequest webResourceRequest)	Checks whether the current user has access to the given portal mode.

Methods inherited from class lumis.portal.presentation.mode.AbstractPortalMode

getAttributeNames, getDescription, getId, getMarkupFilterClass, getModeRootUrl, getName, getPermissionProvider, getRenderComponentClass, isWebResourceAvailable, writeReplace

Methods inherited from class java.lang.Object

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

Constructor Detail

SettingsPortalMode

public SettingsPortalMode(int id,
                          java.lang.String name,
                          java.lang.String description,
                          IPermissionProvider permissionProvider,
                          java.lang.Class<? extends HTMLFragmentComponent> renderComponentClass,
                          java.lang.String[] attributeNames,
                          java.lang.Class<? extends AbstractLayoutFileMarkupFilter> markupFilterClass,
                          java.lang.String modeRootUrl)

Constructor for the class.

Parameters:

id - the id of the current PortalMode

name - the name of the current PortalMode.

description - the description of the current PortalMode.

the - portal mode url provider of the current PortalMode.

attributeNames - attribute names for the current PortalMode.

markupFilterClass - markup filter class for the current PortalMode.

Since:

7.1.0

Method Detail

validateAccess

public boolean validateAccess(IPortalMode currentMode,
                              javax.servlet.http.HttpServletRequest httpServletRequest,
                              IPageWebResourceRequest webResourceRequest)
                       throws PortalException

Description copied from interface: IPortalModeSPI

Checks whether the current user has access to the given portal mode.

Parameters:

currentMode - the portal mode.

httpServletRequest - the HTTP servlet request.

webResourceRequest - the page web resource request

Returns:

whether the current user has access to the given portal mode.

Throws:

PortalException

isAccessWithWebResourceWebsiteRequired

public boolean isAccessWithWebResourceWebsiteRequired(WebResource webResource,
                                                      ChannelConfig rootChannel)

Description copied from interface: IPortalModeSPI

Returns whether the given web resource in the this mode may only be accessed using the web resource's website.

Parameters:

webResource - the web resource being requested. May be null if no web resource was discovered for the current request.

rootChannel - the web resource's root channel. May be null if no web resource was discovered for the current request.

Returns:

true if the access requires the use of the web resource's website, false otherwise.

getValidWebResourceRootChannels

protected java.util.Set<java.lang.String> getValidWebResourceRootChannels()

Description copied from class: AbstractPortalMode

Used by the default implementation of AbstractPortalMode.isWebResourceAvailable(WebResource, ChannelConfig).

Specified by:

getValidWebResourceRootChannels in class AbstractPortalMode

Returns:

the identifiers of valid root channels of web resource in this mode.