public abstract class AbstractPortalMode extends Object implements IPortalModeSPI
Modifier and Type | Field and Description |
---|---|
protected static Set<String> |
ROOT_CHANNELS_ONLY_PORTAL
Utility constant that may be used by implementations of
getValidWebResourceRootChannels() . |
Constructor and Description |
---|
AbstractPortalMode(int id,
String name,
String description,
IPermissionProvider permissionProvider,
Class<? extends HTMLFragmentComponent> renderComponentClass,
String[] attributeNames,
Class<? extends AbstractLayoutFileMarkupFilter> markupFilterClass,
String modeRootUrl)
Constructor for the class.
|
Modifier and Type | Method and Description |
---|---|
Set<String> |
getAttributeNames()
Returns the set of attribute names for the current PortalMode.
|
String |
getDescription()
Returns the description of the current PortalMode.
|
int |
getId()
Returns the id of the current PortalMode.
|
Class<? extends AbstractLayoutFileMarkupFilter> |
getMarkupFilterClass()
Returns markup filter for parser to use to render page.
|
String |
getModeRootUrl() |
String |
getName()
Returns the name of the current PortalMode.
|
IPermissionProvider |
getPermissionProvider()
Returns the permission provider of the current PortalMode.
|
Class<? extends HTMLFragmentComponent> |
getRenderComponentClass()
Returns the render component
|
protected abstract Set<String> |
getValidWebResourceRootChannels()
Used by the default implementation of
isWebResourceAvailable(WebResource, ChannelConfig) . |
boolean |
isWebResourceAvailable(WebResource webResource,
ChannelConfig rootChannel)
Returns whether the given web resource is available for access in the this mode.
|
protected Object |
writeReplace()
Uses
PortalModeSerializedData as the serialization of this portal mode. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
isAccessWithWebResourceWebsiteRequired, validateAccess
protected static final Set<String> ROOT_CHANNELS_ONLY_PORTAL
getValidWebResourceRootChannels()
.public AbstractPortalMode(int id, String name, String description, IPermissionProvider permissionProvider, Class<? extends HTMLFragmentComponent> renderComponentClass, String[] attributeNames, Class<? extends AbstractLayoutFileMarkupFilter> markupFilterClass, String modeRootUrl)
id
- the id of the current PortalModename
- 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.public Set<String> getAttributeNames()
getAttributeNames
in interface IPortalModeSPI
public String getDescription()
getDescription
in interface IPortalMode
public int getId()
getId
in interface IPortalMode
public String getName()
getName
in interface IPortalMode
public IPermissionProvider getPermissionProvider()
getPermissionProvider
in interface IPortalModeSPI
public Class<? extends HTMLFragmentComponent> getRenderComponentClass()
getRenderComponentClass
in interface IPortalModeSPI
public Class<? extends AbstractLayoutFileMarkupFilter> getMarkupFilterClass()
IPortalModeSPI
getMarkupFilterClass
in interface IPortalModeSPI
public String getModeRootUrl()
getModeRootUrl
in interface IPortalMode
public boolean isWebResourceAvailable(WebResource webResource, ChannelConfig rootChannel)
IPortalModeSPI
isWebResourceAvailable
in interface IPortalModeSPI
webResource
- the web resource.true
if the web resource is available, false
otherwise.protected abstract Set<String> getValidWebResourceRootChannels()
isWebResourceAvailable(WebResource, ChannelConfig)
.protected Object writeReplace()
PortalModeSerializedData
as the serialization of this portal mode.LumisXP 12.3.0.200408 - Copyright © 2006–2020 Lumis EIP Tecnologia da Informação LTDA. All Rights Reserved.