org.apache.jetspeed.om.common.portlet
Interface PortletApplication

All Superinterfaces:

org.apache.pluto.om.Model, org.apache.pluto.om.portlet.PortletApplicationDefinition

All Known Subinterfaces:

MutablePortletApplication

public interface PortletApplication
extends org.apache.pluto.om.portlet.PortletApplicationDefinition

PortletApplication Extends the org.apache.pluto.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 516448 2007-03-09 16:25:47Z ate $

Author:

David Sean Taylor

Method Summary

String	getApplicationIdentifier()
int	getApplicationType() Gets the Portlet Application type.
javax.portlet.PortletMode	getCustomPortletMode(javax.portlet.PortletMode mode)
Collection	getCustomPortletModes()
javax.portlet.WindowState	getCustomWindowState(javax.portlet.WindowState state)
Collection	getCustomWindowStates()
String	getDescription()
String	getJetspeedSecurityConstraint() Get the Jetspeed Security Constraint reference for this portlet application.
Collection	getJetspeedServices() Gets a collection of all Jetspeed Services allowed for this 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
String	getName() Gets the name of the Portlet Application.
org.apache.pluto.om.portlet.PortletDefinition	getPortletDefinitionByName(String name) Finds a portlet by portlet name, searching this portlet application's collection.
Collection	getPortletDefinitions()
Collection	getSupportedPortletModes()
Collection	getSupportedWindowStates()
Collection	getUserAttributeRefs() Gets the collection of user attribute refs associated with this portlet application.
Collection	getUserAttributes() Gets the collection of user attributes associated with this portlet application.
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

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

getId, getPortletDefinitionList, getVersion, getWebApplicationDefinition

Method Detail

getMetadata

GenericMetadata getMetadata()

Returns the metadata from the extended jetspeed-portlet.xml

Returns:

Jetspeed specific metadata

getName

String getName()

Gets the name of the Portlet Application.

Returns:

Name of the application

getPortletDefinitions

Collection getPortletDefinitions()

Returns:

getPortletDefinitionByName

org.apache.pluto.om.portlet.PortletDefinition getPortletDefinitionByName(String name)

Finds a portlet by portlet name, searching this portlet application's collection.

Parameters:

name - The portlet name.

Returns:

A Portlet Definition

getUserAttributeRefs

Collection getUserAttributeRefs()

Gets the collection of user attribute refs associated with this portlet application.

getUserAttributes

Collection getUserAttributes()

Gets the collection of user attributes associated with this portlet application.

getApplicationIdentifier

String getApplicationIdentifier()

getDescription

String getDescription()

Returns:

getApplicationType

int getApplicationType()

Gets the Portlet Application type. Valid values are:

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

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

Returns:

The type of portlet application.

getJetspeedServices

Collection getJetspeedServices()

Gets a collection of all Jetspeed Services allowed for this application.

Returns:

The collection of services of type JetspeedServiceReference.

See Also:

JetspeedServiceReference

getCustomPortletModes

Collection getCustomPortletModes()

getCustomWindowStates

Collection getCustomWindowStates()

getMappedPortletMode

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

getMappedWindowState

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

getCustomPortletMode

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

getCustomWindowState

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

getSupportedPortletModes

Collection getSupportedPortletModes()

getSupportedWindowStates

Collection getSupportedWindowStates()

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

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