org.apache.jetspeed.portlets.pam.beans
Class PortletApplicationBean

java.lang.Object
  org.apache.jetspeed.portlets.pam.beans.PortletApplicationBean

All Implemented Interfaces:

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

public class PortletApplicationBean
extends java.lang.Object
implements PortletApplication

This portlet is a browser over all the portlet applications in the system.

Version:

$Id: PortletApplicationBean.java 348264 2005-11-22 22:06:45Z taylor $

Author:

Jeremy Ford, David Sean Taylor

Constructor Summary

PortletApplicationBean(PortletApplication pa)

Method Summary

java.lang.String	getApplicationIdentifier()
int	getApplicationType() Gets the Portlet Application type.
javax.portlet.PortletMode	getCustomPortletMode(javax.portlet.PortletMode mode)
java.util.Collection	getCustomPortletModes()
javax.portlet.WindowState	getCustomWindowState(javax.portlet.WindowState state)
java.util.Collection	getCustomWindowStates()
java.lang.String	getDescription()
org.apache.pluto.om.common.ObjectID	getId()
java.lang.String	getJetspeedSecurityConstraint() Get the Jetspeed Security Constraint reference for this portlet application.
java.util.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
java.lang.String	getName() Gets the name of the Portlet Application.
org.apache.pluto.om.portlet.PortletDefinition	getPortletDefinitionByName(java.lang.String name) Finds a portlet by portlet name, searching this portlet application's collection.
org.apache.pluto.om.portlet.PortletDefinitionList	getPortletDefinitionList()
java.util.Collection	getPortletDefinitions()
java.util.Collection	getSupportedPortletModes()
java.util.Collection	getSupportedWindowStates()
java.util.Collection	getUserAttributeRefs() Gets the collection of user attribute refs associated with this portlet application.
java.util.Collection	getUserAttributes() Gets the collection of user attributes associated with this portlet application.
java.lang.String	getVersion()
org.apache.pluto.om.servlet.WebApplicationDefinition	getWebApplicationDefinition()
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 class java.lang.Object

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

Constructor Detail

PortletApplicationBean

public PortletApplicationBean(PortletApplication pa)

Method Detail

getMetadata

public GenericMetadata getMetadata()

Description copied from interface: PortletApplication

Returns the metadata from the extended jetspeed-portlet.xml

Specified by:

getMetadata in interface PortletApplication

Returns:

Jetspeed specific metadata

getName

public java.lang.String getName()

Description copied from interface: PortletApplication

Gets the name of the Portlet Application.

Specified by:

getName in interface PortletApplication

Returns:

Name of the application

getPortletDefinitions

public java.util.Collection getPortletDefinitions()

Specified by:

getPortletDefinitions in interface PortletApplication

Returns:

getPortletDefinitionByName

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

Description copied from interface: PortletApplication

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

Specified by:

getPortletDefinitionByName in interface PortletApplication

Parameters:

name - The portlet name.

Returns:

A Portlet Definition

getUserAttributeRefs

public java.util.Collection getUserAttributeRefs()

Description copied from interface: PortletApplication

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

Specified by:

getUserAttributeRefs in interface PortletApplication

getUserAttributes

public java.util.Collection getUserAttributes()

Description copied from interface: PortletApplication

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

Specified by:

getUserAttributes in interface PortletApplication

getApplicationIdentifier

public java.lang.String getApplicationIdentifier()

Specified by:

getApplicationIdentifier in interface PortletApplication

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface PortletApplication

Returns:

getApplicationType

public int getApplicationType()

Description copied from interface: PortletApplication

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.

Specified by:

getApplicationType in interface PortletApplication

Returns:

The type of portlet application.

getId

public org.apache.pluto.om.common.ObjectID getId()

Specified by:

getId in interface org.apache.pluto.om.portlet.PortletApplicationDefinition

getVersion

public java.lang.String getVersion()

Specified by:

getVersion in interface org.apache.pluto.om.portlet.PortletApplicationDefinition

getPortletDefinitionList

public org.apache.pluto.om.portlet.PortletDefinitionList getPortletDefinitionList()

Specified by:

getPortletDefinitionList in interface org.apache.pluto.om.portlet.PortletApplicationDefinition

getWebApplicationDefinition

public org.apache.pluto.om.servlet.WebApplicationDefinition getWebApplicationDefinition()

Specified by:

getWebApplicationDefinition in interface org.apache.pluto.om.portlet.PortletApplicationDefinition

getJetspeedServices

public java.util.Collection getJetspeedServices()

Description copied from interface: PortletApplication

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

Specified by:

getJetspeedServices in interface PortletApplication

Returns:

The collection of services of type JetspeedServiceReference.

See Also:

JetspeedServiceReference

getCustomPortletModes

public java.util.Collection getCustomPortletModes()

Specified by:

getCustomPortletModes in interface PortletApplication

getCustomWindowStates

public java.util.Collection getCustomWindowStates()

Specified by:

getCustomWindowStates in interface PortletApplication

getSupportedPortletModes

public java.util.Collection getSupportedPortletModes()

Specified by:

getSupportedPortletModes in interface PortletApplication

getSupportedWindowStates

public java.util.Collection getSupportedWindowStates()

Specified by:

getSupportedWindowStates in interface PortletApplication

getMappedPortletMode

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

Specified by:

getMappedPortletMode in interface PortletApplication

getMappedWindowState

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

Specified by:

getMappedWindowState in interface PortletApplication

getCustomPortletMode

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

Specified by:

getCustomPortletMode in interface PortletApplication

getCustomWindowState

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

Specified by:

getCustomWindowState in interface PortletApplication

getJetspeedSecurityConstraint

public java.lang.String getJetspeedSecurityConstraint()

Description copied from interface: PortletApplication

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.

Specified by:

getJetspeedSecurityConstraint in interface PortletApplication

Returns:

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

isLayoutApplication

public boolean isLayoutApplication()

Description copied from interface: PortletApplication

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

Specified by:

isLayoutApplication in interface PortletApplication

Returns:

true when this app is a Jetspeed layout application