org.apache.jetspeed.om.portlet

Interface PortletApplication

All Superinterfaces:

org.apache.pluto.container.om.portlet.PortletApplicationDefinition, Serializable

public interface PortletApplication
extends org.apache.pluto.container.om.portlet.PortletApplicationDefinition, Serializable

PortletApplication Extends the org.apache.pluto.container.om.portlet.PortletApplicationDefinition interface adding methods for those attributes that do not have them so as to make manipulating the portlet OM easier.

Version:

$Id: PortletApplication.java 1074422 2011-02-25 07:45:03Z taylor $

Author:

David Sean Taylor

Field Summary

Fields

Modifier and Type	Field and Description
static int	LOCAL Marks this application as a LOCAL portlet application, stored in Jetspeed managed portlet application space.
static int	WEBAPP Marks this application as a standard web application, stored in the web application server's web application space.

Fields inherited from interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

JSR_168_VERSION, JSR_286_VERSION

Method Summary

Methods

Modifier and Type	Method and Description
PortletDefinition	addClone(String name)
ContainerRuntimeOption	addContainerRuntimeOption(String name)
CustomPortletMode	addCustomPortletMode(String name)
CustomWindowState	addCustomWindowState(String name)
Description	addDescription(String lang)
DisplayName	addDisplayName(String lang)
EventDefinition	addEventDefinition(QName qname)
EventDefinition	addEventDefinition(String name)
Filter	addFilter(String filterName)
FilterMapping	addFilterMapping(String filterName)
void	addJetspeedServiceReference(String name)
Listener	addListener(String listenerClass)
PortletDefinition	addPortlet(String name)
PublicRenderParameter	addPublicRenderParameter(QName qname, String identifier)
PublicRenderParameter	addPublicRenderParameter(String name, String identifier)
SecurityConstraint	addSecurityConstraint(String transportGuarantee)
SecurityRole	addSecurityRole(String name)
UserAttribute	addUserAttribute(String name)
UserAttributeRef	addUserAttributeRef(String name)
int	getApplicationType() Gets the Portlet Application type.
long	getChecksum() The checksum on the portlet XML from the last deployment
PortletDefinition	getClone(String name)
List<PortletDefinition>	getClones()
ContainerRuntimeOption	getContainerRuntimeOption(String name)
List<ContainerRuntimeOption>	getContainerRuntimeOptions()
javax.portlet.PortletMode	getCustomPortletMode(javax.portlet.PortletMode mode)
CustomPortletMode	getCustomPortletMode(String name)
List<CustomPortletMode>	getCustomPortletModes()
CustomWindowState	getCustomWindowState(String name)
javax.portlet.WindowState	getCustomWindowState(javax.portlet.WindowState state)
List<CustomWindowState>	getCustomWindowStates()
Description	getDescription(Locale locale)
List<Description>	getDescriptions()
DisplayName	getDisplayName(Locale locale)
List<DisplayName>	getDisplayNames()
List<EventDefinition>	getEventDefinitions()
Filter	getFilter(String filterName)
FilterMapping	getFilterMapping(String filterName)
List<FilterMapping>	getFilterMappings()
List<Filter>	getFilters()
String	getJetspeedSecurityConstraint() Get the Jetspeed Security Constraint reference for this portlet application.
List<JetspeedServiceReference>	getJetspeedServices()
List<Listener>	getListeners()
String	getLocalContextPath() Returns the context path of local portlet application.
javax.portlet.PortletMode	getMappedPortletMode(javax.portlet.PortletMode mode)
javax.portlet.WindowState	getMappedWindowState(javax.portlet.WindowState state)
GenericMetadata	getMetadata() Returns the metadata from the extended jetspeed-portlet.xml The return value cannot be NULL
PortletDefinition	getPortlet(String name)
List<PortletDefinition>	getPortlets()
PublicRenderParameter	getPublicRenderParameter(String identifier)
List<PublicRenderParameter>	getPublicRenderParameters()
long	getRevision()
List<SecurityConstraint>	getSecurityConstraints()
List<SecurityRole>	getSecurityRoles()
List<javax.portlet.PortletMode>	getSupportedPortletModes()
List<javax.portlet.WindowState>	getSupportedWindowStates()
UserAttribute	getUserAttribute(String name)
UserAttributeRef	getUserAttributeRef(String name)
List<UserAttributeRef>	getUserAttributeRefs()
List<UserAttribute>	getUserAttributes()
boolean	isLayoutApplication() Returns true if the portlet application is a layout application Layouts are not "general" portlets, but instead used to group together other layouts and portlet fragments
void	setApplicationType(int type)
void	setChecksum(long checksum) The checksum on the portlet XML from the last deployment
void	setJetspeedSecurityConstraint(String constraint) Set the Jetspeed Security Constraint reference for this portlet application.
void	setLocalContextPath(String localContextPath) Sets the context path of local portlet application.
void	setRevision(long revision)

Methods inherited from interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

addLocaleEncodingMapping, getContextPath, getDefaultNamespace, getLocaleEncodingMappings, getName, getResourceBundle, getVersion, setContextPath, setDefaultNamespace, setName, setResourceBundle, setVersion

Field Detail

WEBAPP

static final int WEBAPP

Marks this application as a standard web application, stored in the web application server's web application space.

See Also:

Constant Field Values

LOCAL

static final int LOCAL

Marks this application as a LOCAL portlet application, stored in Jetspeed managed portlet application space.

See Also:

Constant Field Values

Method Detail

getApplicationType

int getApplicationType()

Gets the Portlet Application type. Valid values are:

WEBAPP - A standard web application, stored in the web application server's web application space.

LOCAL - A local portlet application stored within Jetspeed's web application.

Returns:

The type of portlet application.

setApplicationType

void setApplicationType(int type)

setChecksum

void setChecksum(long checksum)

The checksum on the portlet XML from the last deployment

Parameters:

checksum -

getChecksum

long getChecksum()

The checksum on the portlet XML from the last deployment

Returns:

getRevision

long getRevision()

setRevision

void setRevision(long revision)

getJetspeedSecurityConstraint

String getJetspeedSecurityConstraint()

Get the Jetspeed Security Constraint reference for this portlet application. This security constraint name references a Jetspeed-specific Security Constraint. Security Constraints are not Java Security Permissions, but a Jetspeed specific way of securing portlets, also known as PSML constraints. See the page.security file for examples of defining security constraint definitions. If a Jetspeed Security Constraint is not defined for a portlet, the constraint applied will then fallback to the constraint defined for the portlet application. If the portlet application does not define a constraint, then no security constraints will be applied to this portlet. Security constraints for a portlet are normally checking during the render process of a portlet.

Returns:

The name of the Security Definition applied to this portlet, defined in the Jetspeed Security Constraints

setJetspeedSecurityConstraint

void setJetspeedSecurityConstraint(String constraint)

Set the Jetspeed Security Constraint reference for this portlet application. This security constraint name references a Jetspeed-specific Security Constraint. Security Constraints are not Java Security Permissions, but a Jetspeed specific way of securing portlets, also known as PSML constraints. See the page.security file for examples of defining security constraint definitions. If the portlet application does not define a constraint, then no security constraints will be applied to this portlet. Security constraints for a portlet are normally checking during the render process of a portlet.

Parameters:

constraint - The name of the Security Definition defined in the Jetspeed Security Constraints

getDescription

Description getDescription(Locale locale)

getDescriptions

List<Description> getDescriptions()

addDescription

Description addDescription(String lang)

getDisplayName

DisplayName getDisplayName(Locale locale)

getDisplayNames

List<DisplayName> getDisplayNames()

addDisplayName

DisplayName addDisplayName(String lang)

getSecurityRoles

List<SecurityRole> getSecurityRoles()

addSecurityRole

SecurityRole addSecurityRole(String name)

getMetadata

GenericMetadata getMetadata()

Returns the metadata from the extended jetspeed-portlet.xml The return value cannot be NULL

Returns:

Jetspeed specific metadata

getPortlet

PortletDefinition getPortlet(String name)

Specified by:

getPortlet in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

getClone

PortletDefinition getClone(String name)

getPortlets

List<PortletDefinition> getPortlets()

Specified by:

getPortlets in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

getClones

List<PortletDefinition> getClones()

addPortlet

PortletDefinition addPortlet(String name)

Specified by:

addPortlet in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

addClone

PortletDefinition addClone(String name)

getEventDefinitions

List<EventDefinition> getEventDefinitions()

Specified by:

getEventDefinitions in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

addEventDefinition

EventDefinition addEventDefinition(String name)

Specified by:

addEventDefinition in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

addEventDefinition

EventDefinition addEventDefinition(QName qname)

Specified by:

addEventDefinition in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

getPublicRenderParameter

PublicRenderParameter getPublicRenderParameter(String identifier)

Specified by:

getPublicRenderParameter in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

getPublicRenderParameters

List<PublicRenderParameter> getPublicRenderParameters()

Specified by:

getPublicRenderParameters in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

addPublicRenderParameter

PublicRenderParameter addPublicRenderParameter(String name,
                                             String identifier)

Specified by:

addPublicRenderParameter in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

addPublicRenderParameter

PublicRenderParameter addPublicRenderParameter(QName qname,
                                             String identifier)

Specified by:

addPublicRenderParameter in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

getCustomPortletMode

CustomPortletMode getCustomPortletMode(String name)

Specified by:

getCustomPortletMode in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

getCustomPortletMode

javax.portlet.PortletMode getCustomPortletMode(javax.portlet.PortletMode mode)

getCustomPortletModes

List<CustomPortletMode> getCustomPortletModes()

Specified by:

getCustomPortletModes in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

addCustomPortletMode

CustomPortletMode addCustomPortletMode(String name)

Specified by:

addCustomPortletMode in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

getCustomWindowState

CustomWindowState getCustomWindowState(String name)

Specified by:

getCustomWindowState in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

getCustomWindowState

javax.portlet.WindowState getCustomWindowState(javax.portlet.WindowState state)

getCustomWindowStates

List<CustomWindowState> getCustomWindowStates()

Specified by:

getCustomWindowStates in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

addCustomWindowState

CustomWindowState addCustomWindowState(String name)

Specified by:

addCustomWindowState in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

getSupportedPortletModes

List<javax.portlet.PortletMode> getSupportedPortletModes()

getSupportedWindowStates

List<javax.portlet.WindowState> getSupportedWindowStates()

getMappedPortletMode

javax.portlet.PortletMode getMappedPortletMode(javax.portlet.PortletMode mode)

getMappedWindowState

javax.portlet.WindowState getMappedWindowState(javax.portlet.WindowState state)

getUserAttribute

UserAttribute getUserAttribute(String name)

Specified by:

getUserAttribute in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

getUserAttributes

List<UserAttribute> getUserAttributes()

Specified by:

getUserAttributes in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

addUserAttribute

UserAttribute addUserAttribute(String name)

Specified by:

addUserAttribute in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

getUserAttributeRef

UserAttributeRef getUserAttributeRef(String name)

getUserAttributeRefs

List<UserAttributeRef> getUserAttributeRefs()

addUserAttributeRef

UserAttributeRef addUserAttributeRef(String name)

getSecurityConstraints

List<SecurityConstraint> getSecurityConstraints()

Specified by:

getSecurityConstraints in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

addSecurityConstraint

SecurityConstraint addSecurityConstraint(String transportGuarantee)

Specified by:

addSecurityConstraint in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

getFilter

Filter getFilter(String filterName)

Specified by:

getFilter in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

getFilters

List<Filter> getFilters()

Specified by:

getFilters in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

addFilter

Filter addFilter(String filterName)

Specified by:

addFilter in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

getFilterMapping

FilterMapping getFilterMapping(String filterName)

Specified by:

getFilterMapping in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

getFilterMappings

List<FilterMapping> getFilterMappings()

Specified by:

getFilterMappings in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

addFilterMapping

FilterMapping addFilterMapping(String filterName)

Specified by:

addFilterMapping in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

getListeners

List<Listener> getListeners()

Specified by:

getListeners in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

addListener

Listener addListener(String listenerClass)

Specified by:

addListener in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

getContainerRuntimeOption

ContainerRuntimeOption getContainerRuntimeOption(String name)

Specified by:

getContainerRuntimeOption in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

getContainerRuntimeOptions

List<ContainerRuntimeOption> getContainerRuntimeOptions()

Specified by:

getContainerRuntimeOptions in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

addContainerRuntimeOption

ContainerRuntimeOption addContainerRuntimeOption(String name)

Specified by:

addContainerRuntimeOption in interface org.apache.pluto.container.om.portlet.PortletApplicationDefinition

getJetspeedServices

List<JetspeedServiceReference> getJetspeedServices()

addJetspeedServiceReference

void addJetspeedServiceReference(String name)

isLayoutApplication

boolean isLayoutApplication()

Returns true if the portlet application is a layout application Layouts are not "general" portlets, but instead used to group together other layouts and portlet fragments

Returns:

true when this app is a Jetspeed layout application

getLocalContextPath

String getLocalContextPath()

Returns the context path of local portlet application. If the application is not local, then returns null.

Returns:

setLocalContextPath

void setLocalContextPath(String localContextPath)

Sets the context path of local portlet application.

Parameters:

localContextPath -