This project has retired. For details please refer to its Attic page.

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

All Superinterfaces:

org.apache.pluto.om.Model, PortletApplication, org.apache.pluto.om.portlet.PortletApplicationDefinition, java.io.Serializable

public interface MutablePortletApplication
extends PortletApplication, java.io.Serializable

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

Version:

$Id: MutablePortletApplication.java 695790 2008-09-16 09:39:47Z ate $

Author:

David Sean Taylor, Scott T. Weaver

Field Summary

static int	INTERNAL Marks this application as a INTERNAL portlet application, stored in Jetspeed managed portlet application space.
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.

Method Summary

void	addJetspeedService(JetspeedServiceReference service) Adds a Jetspeed component service to the collection of component services allowed for this application.
void	addPortletDefinition(org.apache.pluto.om.portlet.PortletDefinition pd)
void	addUserAttribute(java.lang.String name, java.lang.String description) Adds a user attribute to the user attribute set.
void	addUserAttribute(UserAttribute userAttribute) Adds a user attribute to the user attribute set.
void	addUserAttributeRef(UserAttributeRef userAttributeRef) Adds a user attribute ref to the user attribute ref set.
long	getChecksum() The checksum on the portlet XML from the last deployment
void	setApplicationIdentifier(java.lang.String applicationIndentifier)
void	setApplicationType(int type) Sets the Portlet Application type.
void	setChecksum(long checksum) The checksum on the portlet XML from the last deployment
void	setDescription(java.lang.String string)
void	setJetspeedSecurityConstraint(java.lang.String constraint) Set the Jetspeed Security Constraint reference for this portlet application.
void	setMetadata(GenericMetadata metadata) Sets the metadata from the extended jetspeed-portlet.xml
void	setName(java.lang.String name)
void	setPortletDefinitionList(org.apache.pluto.om.portlet.PortletDefinitionList portlets)
void	setUserAttributeRefs(java.util.Collection userAttributeRefs) Sets a user-attribute-ref to the collection of user attribute refs associated with this portlet application.
void	setUserAttributes(java.util.Collection userAttributes) Sets a user-attribute to the collection of user attributes associated with this portlet application.
void	setVersion(java.lang.String version)
void	setWebApplicationDefinition(org.apache.pluto.om.servlet.WebApplicationDefinition wad) Associates the web application definition with this portlet application defintion.

Methods inherited from interface org.apache.jetspeed.om.common.portlet.PortletApplication

getApplicationIdentifier, getApplicationType, getCustomPortletMode, getCustomPortletModes, getCustomWindowState, getCustomWindowStates, getDescription, getJetspeedSecurityConstraint, getJetspeedServices, getMappedPortletMode, getMappedWindowState, getMetadata, getName, getPortletDefinitionByName, getPortletDefinitions, getSupportedPortletModes, getSupportedWindowStates, getUserAttributeRefs, getUserAttributes, isLayoutApplication

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

getId, getPortletDefinitionList, getVersion, getWebApplicationDefinition

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

INTERNAL

static final int INTERNAL

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

See Also:

Constant Field Values

Method Detail

setMetadata

void setMetadata(GenericMetadata metadata)

Sets the metadata from the extended jetspeed-portlet.xml

Parameters:

metadata -

setWebApplicationDefinition

void setWebApplicationDefinition(org.apache.pluto.om.servlet.WebApplicationDefinition wad)

Associates the web application definition with this portlet application defintion.

Parameters:

wad -

setName

void setName(java.lang.String name)

Parameters:

name -

addPortletDefinition

void addPortletDefinition(org.apache.pluto.om.portlet.PortletDefinition pd)

Parameters:

pd -

setPortletDefinitionList

void setPortletDefinitionList(org.apache.pluto.om.portlet.PortletDefinitionList portlets)

Parameters:

portlets -

addUserAttribute

void addUserAttribute(UserAttribute userAttribute)

Adds a user attribute to the user attribute set.

Parameters:

userAttribute - The user attribute.

addUserAttribute

void addUserAttribute(java.lang.String name,
                      java.lang.String description)

Adds a user attribute to the user attribute set.

Parameters:

userAttribute - The user attribute.

setUserAttributeRefs

void setUserAttributeRefs(java.util.Collection userAttributeRefs)

Sets a user-attribute-ref to the collection of user attribute refs associated with this portlet application.

addUserAttributeRef

void addUserAttributeRef(UserAttributeRef userAttributeRef)

Adds a user attribute ref to the user attribute ref set.

Parameters:

userAttributeRef - The user attribute ref.

setUserAttributes

void setUserAttributes(java.util.Collection userAttributes)

Sets a user-attribute to the collection of user attributes associated with this portlet application.

setApplicationIdentifier

void setApplicationIdentifier(java.lang.String applicationIndentifier)

setDescription

void setDescription(java.lang.String string)

Parameters:

string -

setVersion

void setVersion(java.lang.String version)

Parameters:

version -

setApplicationType

void setApplicationType(int type)

Sets 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.

Parameters:

type - The type of portlet application.

addJetspeedService

void addJetspeedService(JetspeedServiceReference service)

Adds a Jetspeed component service to the collection of component services allowed for this application.

Parameters:

service - The component service being added.

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:

setJetspeedSecurityConstraint

void setJetspeedSecurityConstraint(java.lang.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