org.apache.jetspeed.om.portlet
Interface PortletDefinition

All Superinterfaces:

org.apache.pluto.container.om.portlet.PortletDefinition, java.io.Serializable

public interface PortletDefinition
extends org.apache.pluto.container.om.portlet.PortletDefinition, java.io.Serializable

PortletDefinitionComposite

Version:

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

Author:

Scott T. Weaver

Field Summary

static java.lang.String

CLONE_PARENT_INIT_PARAM

Method Summary

ContainerRuntimeOption	addContainerRuntimeOption(java.lang.String name)
Description	addDescription(java.lang.String lang)
Preference	addDescriptorPreference(java.lang.String name)
DisplayName	addDisplayName(java.lang.String lang)
InitParam	addInitParam(java.lang.String paramName)
Language	addLanguage(java.util.Locale locale)
SecurityRoleRef	addSecurityRoleRef(java.lang.String roleName)
EventDefinitionReference	addSupportedProcessingEvent(javax.xml.namespace.QName qname)
EventDefinitionReference	addSupportedProcessingEvent(java.lang.String name)
EventDefinitionReference	addSupportedPublishingEvent(javax.xml.namespace.QName qname)
EventDefinitionReference	addSupportedPublishingEvent(java.lang.String name)
Supports	addSupports(java.lang.String mimeType)
PortletApplication	getApplication()
java.lang.String	getCloneParent() returns the parent portlet definition name from which this portlet clone was cloned from.
ContainerRuntimeOption	getContainerRuntimeOption(java.lang.String name)
java.util.List<ContainerRuntimeOption>	getContainerRuntimeOptions()
Description	getDescription(java.util.Locale locale)
java.util.List<Description>	getDescriptions()
java.lang.String	getDescriptionText(java.util.Locale locale) Returns localized text of this PortletDefinitions description.
Preferences	getDescriptorPreferences()
DisplayName	getDisplayName(java.util.Locale locale)
java.util.List<DisplayName>	getDisplayNames()
java.lang.String	getDisplayNameText(java.util.Locale locale) Returns localized text of this PortletDefinitions display name.
InitParam	getInitParam(java.lang.String paramName)
java.util.List<InitParam>	getInitParams()
java.lang.String	getJetspeedSecurityConstraint() Get the Jetspeed Security Constraint reference for this portlet.
Language	getLanguage(java.util.Locale locale)
java.util.List<Language>	getLanguages()
GenericMetadata	getMetadata()
PortletInfo	getPortletInfo()
Preferences	getPortletPreferences()
java.lang.String	getPreferenceValidatorClassname()
SecurityRoleRef	getSecurityRoleRef(java.lang.String roleName)
java.util.List<SecurityRoleRef>	getSecurityRoleRefs()
java.util.List<EventDefinitionReference>	getSupportedProcessingEvents()
java.util.List<EventDefinitionReference>	getSupportedPublishingEvents()
java.util.List<Supports>	getSupports()
Supports	getSupports(java.lang.String mimeType)
java.lang.String	getUniqueName() A portlet's unique name is a string formed by the combination of a portlet's unique within it's parent application plus the parent application's unique name within the portlet container using ":" as a delimiter.
boolean	isClone() Determine if this portlet defintion is a clon
boolean	isSameIdentity(PortletDefinition other) Check if this instance its persistent identity has changed
void	setJetspeedSecurityConstraint(java.lang.String constraint) Set the Jetspeed Security Constraint reference for this portlet.
void	setPreferenceValidatorClassname(java.lang.String classname)
void	storeChildren() Persistence callback to allow a PortletDefinition instance to persist children objects (like portlet preferences) within the same transaction.

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

addSupportedLocale, addSupportedPublicRenderParameter, getCacheScope, getExpirationCache, getPortletClass, getPortletName, getResourceBundle, getSupportedLocales, getSupportedPublicRenderParameters, setCacheScope, setExpirationCache, setPortletClass, setResourceBundle

Field Detail

CLONE_PARENT_INIT_PARAM

static final java.lang.String CLONE_PARENT_INIT_PARAM

See Also:

Constant Field Values

Method Detail

getApplication

PortletApplication getApplication()

Specified by:

getApplication in interface org.apache.pluto.container.om.portlet.PortletDefinition

getInitParam

InitParam getInitParam(java.lang.String paramName)

Specified by:

getInitParam in interface org.apache.pluto.container.om.portlet.PortletDefinition

getInitParams

java.util.List<InitParam> getInitParams()

Specified by:

getInitParams in interface org.apache.pluto.container.om.portlet.PortletDefinition

addInitParam

InitParam addInitParam(java.lang.String paramName)

Specified by:

addInitParam in interface org.apache.pluto.container.om.portlet.PortletDefinition

getPortletInfo

PortletInfo getPortletInfo()

Specified by:

getPortletInfo in interface org.apache.pluto.container.om.portlet.PortletDefinition

getPortletPreferences

Preferences getPortletPreferences()

Specified by:

getPortletPreferences in interface org.apache.pluto.container.om.portlet.PortletDefinition

getDescriptorPreferences

Preferences getDescriptorPreferences()

addDescriptorPreference

Preference addDescriptorPreference(java.lang.String name)

getSupportedProcessingEvents

java.util.List<EventDefinitionReference> getSupportedProcessingEvents()

Specified by:

getSupportedProcessingEvents in interface org.apache.pluto.container.om.portlet.PortletDefinition

addSupportedProcessingEvent

EventDefinitionReference addSupportedProcessingEvent(javax.xml.namespace.QName qname)

Specified by:

addSupportedProcessingEvent in interface org.apache.pluto.container.om.portlet.PortletDefinition

addSupportedProcessingEvent

EventDefinitionReference addSupportedProcessingEvent(java.lang.String name)

Specified by:

addSupportedProcessingEvent in interface org.apache.pluto.container.om.portlet.PortletDefinition

getSupportedPublishingEvents

java.util.List<EventDefinitionReference> getSupportedPublishingEvents()

Specified by:

getSupportedPublishingEvents in interface org.apache.pluto.container.om.portlet.PortletDefinition

addSupportedPublishingEvent

EventDefinitionReference addSupportedPublishingEvent(javax.xml.namespace.QName qname)

Specified by:

addSupportedPublishingEvent in interface org.apache.pluto.container.om.portlet.PortletDefinition

addSupportedPublishingEvent

EventDefinitionReference addSupportedPublishingEvent(java.lang.String name)

Specified by:

addSupportedPublishingEvent in interface org.apache.pluto.container.om.portlet.PortletDefinition

getSecurityRoleRef

SecurityRoleRef getSecurityRoleRef(java.lang.String roleName)

Specified by:

getSecurityRoleRef in interface org.apache.pluto.container.om.portlet.PortletDefinition

getSecurityRoleRefs

java.util.List<SecurityRoleRef> getSecurityRoleRefs()

Specified by:

getSecurityRoleRefs in interface org.apache.pluto.container.om.portlet.PortletDefinition

addSecurityRoleRef

SecurityRoleRef addSecurityRoleRef(java.lang.String roleName)

Specified by:

addSecurityRoleRef in interface org.apache.pluto.container.om.portlet.PortletDefinition

getSupports

Supports getSupports(java.lang.String mimeType)

Specified by:

getSupports in interface org.apache.pluto.container.om.portlet.PortletDefinition

getSupports

java.util.List<Supports> getSupports()

Specified by:

getSupports in interface org.apache.pluto.container.om.portlet.PortletDefinition

addSupports

Supports addSupports(java.lang.String mimeType)

Specified by:

addSupports in interface org.apache.pluto.container.om.portlet.PortletDefinition

getDescription

Description getDescription(java.util.Locale locale)

Specified by:

getDescription in interface org.apache.pluto.container.om.portlet.PortletDefinition

getDescriptions

java.util.List<Description> getDescriptions()

Specified by:

getDescriptions in interface org.apache.pluto.container.om.portlet.PortletDefinition

addDescription

Description addDescription(java.lang.String lang)

Specified by:

addDescription in interface org.apache.pluto.container.om.portlet.PortletDefinition

getDisplayName

DisplayName getDisplayName(java.util.Locale locale)

Specified by:

getDisplayName in interface org.apache.pluto.container.om.portlet.PortletDefinition

getDisplayNames

java.util.List<DisplayName> getDisplayNames()

Specified by:

getDisplayNames in interface org.apache.pluto.container.om.portlet.PortletDefinition

addDisplayName

DisplayName addDisplayName(java.lang.String lang)

Specified by:

addDisplayName in interface org.apache.pluto.container.om.portlet.PortletDefinition

getMetadata

GenericMetadata getMetadata()

getContainerRuntimeOption

ContainerRuntimeOption getContainerRuntimeOption(java.lang.String name)

Specified by:

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

getContainerRuntimeOptions

java.util.List<ContainerRuntimeOption> getContainerRuntimeOptions()

Specified by:

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

addContainerRuntimeOption

ContainerRuntimeOption addContainerRuntimeOption(java.lang.String name)

Specified by:

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

getLanguage

Language getLanguage(java.util.Locale locale)

getLanguages

java.util.List<Language> getLanguages()

addLanguage

Language addLanguage(java.util.Locale locale)

getUniqueName

java.lang.String getUniqueName()

A portlet's unique name is a string formed by the combination of a portlet's unique within it's parent application plus the parent application's unique name within the portlet container using ":" as a delimiter.
FORMAT: application name:portlet name
EXAMPLE: com.myapp.portletApp1:weather-portlet

Returns:

Name that uniquely indetifies this portlet within the container. If either the name of the portlet is null or this portlet has not yet been assigned to an portlet application, null is returned.

getDisplayNameText

java.lang.String getDisplayNameText(java.util.Locale locale)

Returns localized text of this PortletDefinitions display name.

Parameters:

locale - Locale to get the display name for

Returns:

Localized text string of the display name or null if no DisplayName exists for this locale

getDescriptionText

java.lang.String getDescriptionText(java.util.Locale locale)

Returns localized text of this PortletDefinitions description.

Parameters:

locale - Locale to get the description for

Returns:

Localized text string of the display name or null if no Description exists for this locale

getPreferenceValidatorClassname

java.lang.String getPreferenceValidatorClassname()

setPreferenceValidatorClassname

void setPreferenceValidatorClassname(java.lang.String classname)

getJetspeedSecurityConstraint

java.lang.String getJetspeedSecurityConstraint()

Get the Jetspeed Security Constraint reference for this portlet. 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(java.lang.String constraint)

Set the Jetspeed Security Constraint reference for this portlet. 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

storeChildren

void storeChildren()

Persistence callback to allow a PortletDefinition instance to persist children objects (like portlet preferences) within the same transaction.

This method must be called always from the #store() method. Using a callback from the persistence manager might not be reliable when the PortletDefinition itself isn't changed but children might.

Notably condition when this might happen is the Pluto 1.0.1 preferences handling calling the portletDefinition store() method

isSameIdentity

boolean isSameIdentity(PortletDefinition other)

Check if this instance its persistent identity has changed

Parameters:

other -

Returns:

true only if the internal identities are the same

isClone

boolean isClone()

Determine if this portlet defintion is a clon

getCloneParent

java.lang.String getCloneParent()

returns the parent portlet definition name from which this portlet clone was cloned from. If not defined, returns null

Returns:

the parent application name or null if not a clone