org.apache.jetspeed.om.portlet.impl
Class FragmentPortletDefinition

java.lang.Object
  org.apache.jetspeed.om.portlet.impl.FragmentPortletDefinition

All Implemented Interfaces:

java.io.Serializable, PortletDefinitionComposite, org.apache.pluto.om.Controller, org.apache.pluto.om.Model, org.apache.pluto.om.portlet.PortletDefinition, org.apache.pluto.om.portlet.PortletDefinitionCtrl

public class FragmentPortletDefinition
extends java.lang.Object
implements PortletDefinitionComposite

Per-request wrapper for a PortletDefinition that allows for the supplementaton of psml-based portlet Preferences. The Preferences are transparently accessed as default Preferences in the exact same way default Preferences that are provided via the portelt.xml are.

Author:

Scott T. Weaver

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

PORTLETS_PREFS_ROOT

Constructor Summary

FragmentPortletDefinition(PortletDefinitionComposite portletDefinition, Fragment fragment)

Method Summary

void	addContentType(org.apache.pluto.om.portlet.ContentType cType)
void	addContentType(java.lang.String contentType, java.util.Collection modes)
void	addDescription(java.util.Locale locale, java.lang.String description)
void	addDisplayName(org.apache.pluto.om.common.DisplayName displayName) addDisplayName
void	addDisplayName(java.util.Locale locale, java.lang.String displayName)
ParameterComposite	addInitParameter(java.lang.String name, java.lang.String value) Convenience method for directly adding init parameters to this PortletDefinition..
ParameterComposite	addInitParameter(java.lang.String name, java.lang.String value, org.apache.pluto.om.common.DescriptionSet description) Same as setInitParameter(name, title) plus allows a description to inlcuded.
ParameterComposite	addInitParameter(java.lang.String name, java.lang.String value, java.lang.String description, java.util.Locale locale) Same as setInitParameter(name, title) plus allows you to define one initial localized desription.
void	addLanguage(org.apache.pluto.om.common.Language lang)
void	addLanguage(java.lang.String title, java.lang.String shortTitle, java.lang.String keywords, java.util.Locale locale)
void	addPreference(org.apache.pluto.om.common.Preference preference)
PreferenceComposite	addPreference(java.lang.String name, java.lang.String[] values)
void	addSecurityRoleRef(org.apache.pluto.om.common.SecurityRoleRef securityRef) addSecurityRoleRef
org.apache.pluto.om.common.SecurityRoleRef	addSecurityRoleRef(java.lang.String roleName, java.lang.String roleLink)
java.lang.String	getClassName()
org.apache.pluto.om.portlet.ContentTypeSet	getContentTypeSet()
org.apache.pluto.om.common.Description	getDescription(java.util.Locale arg0)
org.apache.pluto.om.common.DescriptionSet	getDescriptionSet()
java.lang.String	getDescriptionText(java.util.Locale locale) Returns localized text of this PortletDefinitions description.
org.apache.pluto.om.common.DisplayName	getDisplayName(java.util.Locale arg0)
org.apache.pluto.om.common.DisplayNameSet	getDisplayNameSet()
java.lang.String	getDisplayNameText(java.util.Locale locale) Returns localized text of this PortletDefinitions display name.
java.lang.String	getExpirationCache()
org.apache.pluto.om.common.ObjectID	getId()
org.apache.pluto.om.common.ParameterSet	getInitParameterSet()
org.apache.pluto.om.common.SecurityRoleRefSet	getInitSecurityRoleRefSet()
java.lang.String	getJetspeedSecurityConstraint() Get the Jetspeed Security Constraint reference for this portlet.
org.apache.pluto.om.common.LanguageSet	getLanguageSet()
GenericMetadata	getMetadata()
java.lang.String	getName()
org.apache.pluto.om.portlet.PortletApplicationDefinition	getPortletApplicationDefinition()
java.lang.ClassLoader	getPortletClassLoader()
java.lang.String	getPortletIdentifier()
org.apache.pluto.om.common.PreferenceSet	getPreferenceSet()
java.lang.String	getPreferenceValidatorClassname()
java.lang.String	getResourceBundle()
org.apache.pluto.om.servlet.ServletDefinition	getServletDefinition()
java.util.Collection	getSupportedLocales()
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.
void	setClassName(java.lang.String arg0)
void	setContentTypeSet(org.apache.pluto.om.portlet.ContentTypeSet contentTypes)
void	setDescriptions(org.apache.pluto.om.common.DescriptionSet arg0)
void	setDisplayNames(org.apache.pluto.om.common.DisplayNameSet arg0)
void	setExpirationCache(java.lang.String cache) Setter for setting expiration cache time for this portlet
void	setId(java.lang.String arg0)
void	setInitParameterSet(org.apache.pluto.om.common.ParameterSet parameters)
void	setInitSecurityRoleRefSet(org.apache.pluto.om.common.SecurityRoleRefSet securityRefs)
void	setJetspeedSecurityConstraint(java.lang.String constraint) Set the Jetspeed Security Constraint reference for this portlet.
void	setLanguageSet(org.apache.pluto.om.common.LanguageSet languages)
void	setMetadata(GenericMetadata metadata)
void	setName(java.lang.String arg0)
void	setPortletApplicationDefinition(org.apache.pluto.om.portlet.PortletApplicationDefinition pad)
void	setPortletClassLoader(java.lang.ClassLoader arg0)
void	setPortletIdentifier(java.lang.String portletIndentifier)
void	setPreferenceSet(org.apache.pluto.om.common.PreferenceSet preferences) The PreferenceSet is a collection user-defineable preferences that this portlet can use to process its logic.
void	setPreferenceValidatorClassname(java.lang.String classname)
void	store()

Methods inherited from class java.lang.Object

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

Constructor Detail

FragmentPortletDefinition

public FragmentPortletDefinition(PortletDefinitionComposite portletDefinition,
                                 Fragment fragment)

Method Detail

addContentType

public void addContentType(org.apache.pluto.om.portlet.ContentType cType)

Specified by:

addContentType in interface PortletDefinitionComposite

addContentType

public void addContentType(java.lang.String contentType,
                           java.util.Collection modes)

Specified by:

addContentType in interface PortletDefinitionComposite

addDescription

public void addDescription(java.util.Locale locale,
                           java.lang.String description)

Specified by:

addDescription in interface PortletDefinitionComposite

addDisplayName

public void addDisplayName(org.apache.pluto.om.common.DisplayName displayName)

Description copied from interface: PortletDefinitionComposite

addDisplayName

Specified by:

addDisplayName in interface PortletDefinitionComposite

addDisplayName

public void addDisplayName(java.util.Locale locale,
                           java.lang.String displayName)

Specified by:

addDisplayName in interface PortletDefinitionComposite

addInitParameter

public ParameterComposite addInitParameter(java.lang.String name,
                                           java.lang.String value,
                                           org.apache.pluto.om.common.DescriptionSet description)

Description copied from interface: PortletDefinitionComposite

Same as setInitParameter(name, title) plus allows a description to inlcuded.

Specified by:

addInitParameter in interface PortletDefinitionComposite

Parameters:

name - Name of parameter to set

value - new value of the parameter

Returns:

ParameterComposite newly created parameter

See Also:

org.apache.jetspeed.om.common.portlet.PortletApplicationComposite#addInitParameter(java.lang.String, java.lang.String)

addInitParameter

public ParameterComposite addInitParameter(java.lang.String name,
                                           java.lang.String value,
                                           java.lang.String description,
                                           java.util.Locale locale)

Description copied from interface: PortletDefinitionComposite

Same as setInitParameter(name, title) plus allows you to define one initial localized desription.

Specified by:

addInitParameter in interface PortletDefinitionComposite

Parameters:

name - Name of parameter to set

value - new value of the parameter

description - A description for this parameter

locale - The locale the description

Returns:

ParameterComposite newly created parameter

See Also:

org.apache.jetspeed.om.common.portlet.PortletApplicationComposite#addInitParameter(java.lang.String, java.lang.String)

addInitParameter

public ParameterComposite addInitParameter(java.lang.String name,
                                           java.lang.String value)

Description copied from interface: PortletDefinitionComposite

Convenience method for directly adding init parameters to this PortletDefinition.. This has the same affect as ((ParameterSetCtrl)PortletDefinition.getInitParamaterSet()).add()

Specified by:

addInitParameter in interface PortletDefinitionComposite

Parameters:

name - Name of parameter to set

value - new value of said parameter

Returns:

ParameterComposite newly created parameter

addLanguage

public void addLanguage(org.apache.pluto.om.common.Language lang)

Specified by:

addLanguage in interface PortletDefinitionComposite

addLanguage

public void addLanguage(java.lang.String title,
                        java.lang.String shortTitle,
                        java.lang.String keywords,
                        java.util.Locale locale)

Specified by:

addLanguage in interface PortletDefinitionComposite

addPreference

public void addPreference(org.apache.pluto.om.common.Preference preference)

Specified by:

addPreference in interface PortletDefinitionComposite

addPreference

public PreferenceComposite addPreference(java.lang.String name,
                                         java.lang.String[] values)

Specified by:

addPreference in interface PortletDefinitionComposite

addSecurityRoleRef

public void addSecurityRoleRef(org.apache.pluto.om.common.SecurityRoleRef securityRef)

Description copied from interface: PortletDefinitionComposite

addSecurityRoleRef

Adds the securityRef to the existing set of SecurityRoleRefs of this PortletDefinition

Specified by:

addSecurityRoleRef in interface PortletDefinitionComposite

Parameters:

securityRef - SecurityRoleRef to add.

addSecurityRoleRef

public org.apache.pluto.om.common.SecurityRoleRef addSecurityRoleRef(java.lang.String roleName,
                                                                     java.lang.String roleLink)

Specified by:

addSecurityRoleRef in interface PortletDefinitionComposite

getClassName

public java.lang.String getClassName()

Specified by:

getClassName in interface org.apache.pluto.om.portlet.PortletDefinition

getContentTypeSet

public org.apache.pluto.om.portlet.ContentTypeSet getContentTypeSet()

Specified by:

getContentTypeSet in interface org.apache.pluto.om.portlet.PortletDefinition

getDescription

public org.apache.pluto.om.common.Description getDescription(java.util.Locale arg0)

Specified by:

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

getDescriptionSet

public org.apache.pluto.om.common.DescriptionSet getDescriptionSet()

Specified by:

getDescriptionSet in interface PortletDefinitionComposite

getDescriptionText

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

Description copied from interface: PortletDefinitionComposite

Returns localized text of this PortletDefinitions description.

Specified by:

getDescriptionText in interface PortletDefinitionComposite

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

getDisplayName

public org.apache.pluto.om.common.DisplayName getDisplayName(java.util.Locale arg0)

Specified by:

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

getDisplayNameSet

public org.apache.pluto.om.common.DisplayNameSet getDisplayNameSet()

Specified by:

getDisplayNameSet in interface PortletDefinitionComposite

getDisplayNameText

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

Description copied from interface: PortletDefinitionComposite

Returns localized text of this PortletDefinitions display name.

Specified by:

getDisplayNameText in interface PortletDefinitionComposite

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

getExpirationCache

public java.lang.String getExpirationCache()

Specified by:

getExpirationCache in interface org.apache.pluto.om.portlet.PortletDefinition

getId

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

Specified by:

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

getInitParameterSet

public org.apache.pluto.om.common.ParameterSet getInitParameterSet()

Specified by:

getInitParameterSet in interface org.apache.pluto.om.portlet.PortletDefinition

getInitSecurityRoleRefSet

public org.apache.pluto.om.common.SecurityRoleRefSet getInitSecurityRoleRefSet()

Specified by:

getInitSecurityRoleRefSet in interface org.apache.pluto.om.portlet.PortletDefinition

getLanguageSet

public org.apache.pluto.om.common.LanguageSet getLanguageSet()

Specified by:

getLanguageSet in interface org.apache.pluto.om.portlet.PortletDefinition

getMetadata

public GenericMetadata getMetadata()

Specified by:

getMetadata in interface PortletDefinitionComposite

getName

public java.lang.String getName()

Specified by:

getName in interface org.apache.pluto.om.portlet.PortletDefinition

getPortletApplicationDefinition

public org.apache.pluto.om.portlet.PortletApplicationDefinition getPortletApplicationDefinition()

Specified by:

getPortletApplicationDefinition in interface org.apache.pluto.om.portlet.PortletDefinition

getPortletClassLoader

public java.lang.ClassLoader getPortletClassLoader()

Specified by:

getPortletClassLoader in interface org.apache.pluto.om.portlet.PortletDefinition

getPortletIdentifier

public java.lang.String getPortletIdentifier()

Specified by:

getPortletIdentifier in interface PortletDefinitionComposite

getPreferenceSet

public org.apache.pluto.om.common.PreferenceSet getPreferenceSet()

Specified by:

getPreferenceSet in interface org.apache.pluto.om.portlet.PortletDefinition

getPreferenceValidatorClassname

public java.lang.String getPreferenceValidatorClassname()

Specified by:

getPreferenceValidatorClassname in interface PortletDefinitionComposite

getResourceBundle

public java.lang.String getResourceBundle()

Specified by:

getResourceBundle in interface PortletDefinitionComposite

getServletDefinition

public org.apache.pluto.om.servlet.ServletDefinition getServletDefinition()

Specified by:

getServletDefinition in interface org.apache.pluto.om.portlet.PortletDefinition

getSupportedLocales

public java.util.Collection getSupportedLocales()

Specified by:

getSupportedLocales in interface PortletDefinitionComposite

getUniqueName

public java.lang.String getUniqueName()

Description copied from interface: PortletDefinitionComposite

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

Specified by:

getUniqueName in interface PortletDefinitionComposite

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.

setClassName

public void setClassName(java.lang.String arg0)

Specified by:

setClassName in interface org.apache.pluto.om.portlet.PortletDefinitionCtrl

setContentTypeSet

public void setContentTypeSet(org.apache.pluto.om.portlet.ContentTypeSet contentTypes)

Specified by:

setContentTypeSet in interface PortletDefinitionComposite

setDescriptions

public void setDescriptions(org.apache.pluto.om.common.DescriptionSet arg0)

Specified by:

setDescriptions in interface org.apache.pluto.om.portlet.PortletDefinitionCtrl

setDisplayNames

public void setDisplayNames(org.apache.pluto.om.common.DisplayNameSet arg0)

Specified by:

setDisplayNames in interface org.apache.pluto.om.portlet.PortletDefinitionCtrl

setExpirationCache

public void setExpirationCache(java.lang.String cache)

Description copied from interface: PortletDefinitionComposite

Setter for setting expiration cache time for this portlet

Specified by:

setExpirationCache in interface PortletDefinitionComposite

setId

public void setId(java.lang.String arg0)

Specified by:

setId in interface org.apache.pluto.om.portlet.PortletDefinitionCtrl

setInitParameterSet

public void setInitParameterSet(org.apache.pluto.om.common.ParameterSet parameters)

Specified by:

setInitParameterSet in interface PortletDefinitionComposite

setInitSecurityRoleRefSet

public void setInitSecurityRoleRefSet(org.apache.pluto.om.common.SecurityRoleRefSet securityRefs)

Specified by:

setInitSecurityRoleRefSet in interface PortletDefinitionComposite

setLanguageSet

public void setLanguageSet(org.apache.pluto.om.common.LanguageSet languages)

Specified by:

setLanguageSet in interface PortletDefinitionComposite

setMetadata

public void setMetadata(GenericMetadata metadata)

Specified by:

setMetadata in interface PortletDefinitionComposite

setName

public void setName(java.lang.String arg0)

Specified by:

setName in interface org.apache.pluto.om.portlet.PortletDefinitionCtrl

setPortletApplicationDefinition

public void setPortletApplicationDefinition(org.apache.pluto.om.portlet.PortletApplicationDefinition pad)

Specified by:

setPortletApplicationDefinition in interface PortletDefinitionComposite

setPortletClassLoader

public void setPortletClassLoader(java.lang.ClassLoader arg0)

Specified by:

setPortletClassLoader in interface org.apache.pluto.om.portlet.PortletDefinitionCtrl

setPortletIdentifier

public void setPortletIdentifier(java.lang.String portletIndentifier)

Specified by:

setPortletIdentifier in interface PortletDefinitionComposite

setPreferenceSet

public void setPreferenceSet(org.apache.pluto.om.common.PreferenceSet preferences)

Description copied from interface: PortletDefinitionComposite

The PreferenceSet is a collection user-defineable preferences that this portlet can use to process its logic.

Specified by:

setPreferenceSet in interface PortletDefinitionComposite

setPreferenceValidatorClassname

public void setPreferenceValidatorClassname(java.lang.String classname)

Specified by:

setPreferenceValidatorClassname in interface PortletDefinitionComposite

store

public void store()
           throws java.io.IOException

Specified by:

store in interface org.apache.pluto.om.portlet.PortletDefinitionCtrl

Throws:

java.io.IOException

getJetspeedSecurityConstraint

public java.lang.String getJetspeedSecurityConstraint()

Description copied from interface: PortletDefinitionComposite

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.

Specified by:

getJetspeedSecurityConstraint in interface PortletDefinitionComposite

Returns:

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

setJetspeedSecurityConstraint

public void setJetspeedSecurityConstraint(java.lang.String constraint)

Description copied from interface: PortletDefinitionComposite

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.

Specified by:

setJetspeedSecurityConstraint in interface PortletDefinitionComposite

Parameters:

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