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

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

All Implemented Interfaces:

Serializable, org.apache.jetspeed.om.common.portlet.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 Object
implements org.apache.jetspeed.om.common.portlet.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

private org.apache.jetspeed.om.page.Fragment	fragment
private org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite	portletDefinition

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

PORTLETS_PREFS_ROOT

Constructor Summary

FragmentPortletDefinition(org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite portletDefinition, org.apache.jetspeed.om.page.Fragment fragment)

Method Summary

void	addContentType(org.apache.pluto.om.portlet.ContentType cType)
void	addContentType(String contentType, Collection modes)
void	addDescription(Locale locale, String description)
void	addDisplayName(org.apache.pluto.om.common.DisplayName displayName)
void	addDisplayName(Locale locale, String displayName)
org.apache.jetspeed.om.common.ParameterComposite	addInitParameter(String name, String value)
org.apache.jetspeed.om.common.ParameterComposite	addInitParameter(String name, String value, org.apache.pluto.om.common.DescriptionSet description)
org.apache.jetspeed.om.common.ParameterComposite	addInitParameter(String name, String value, String description, Locale locale)
void	addLanguage(org.apache.pluto.om.common.Language lang)
void	addLanguage(String title, String shortTitle, String keywords, Locale locale)
void	addPreference(org.apache.pluto.om.common.Preference preference)
org.apache.jetspeed.om.common.preference.PreferenceComposite	addPreference(String name, String[] values)
void	addSecurityRoleRef(org.apache.pluto.om.common.SecurityRoleRef securityRef)
org.apache.pluto.om.common.SecurityRoleRef	addSecurityRoleRef(String roleName, String roleLink)
String	getClassName()
org.apache.pluto.om.portlet.ContentTypeSet	getContentTypeSet()
org.apache.pluto.om.common.Description	getDescription(Locale arg0)
org.apache.pluto.om.common.DescriptionSet	getDescriptionSet()
String	getDescriptionText(Locale locale)
org.apache.pluto.om.common.DisplayName	getDisplayName(Locale arg0)
org.apache.pluto.om.common.DisplayNameSet	getDisplayNameSet()
String	getDisplayNameText(Locale locale)
String	getExpirationCache()
org.apache.pluto.om.common.ObjectID	getId()
org.apache.pluto.om.common.ParameterSet	getInitParameterSet()
org.apache.pluto.om.common.SecurityRoleRefSet	getInitSecurityRoleRefSet()
String	getJetspeedSecurityConstraint()
org.apache.pluto.om.common.LanguageSet	getLanguageSet()
org.apache.jetspeed.om.common.GenericMetadata	getMetadata()
String	getName()
org.apache.pluto.om.portlet.PortletApplicationDefinition	getPortletApplicationDefinition()
ClassLoader	getPortletClassLoader()
String	getPortletIdentifier()
org.apache.pluto.om.common.PreferenceSet	getPreferenceSet()
String	getPreferenceValidatorClassname()
String	getResourceBundle()
org.apache.pluto.om.servlet.ServletDefinition	getServletDefinition()
Collection	getSupportedLocales()
String	getUniqueName()
void	setClassName(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(String cache)
void	setId(String arg0)
void	setInitParameterSet(org.apache.pluto.om.common.ParameterSet parameters)
void	setInitSecurityRoleRefSet(org.apache.pluto.om.common.SecurityRoleRefSet securityRefs)
void	setJetspeedSecurityConstraint(String constraint)
void	setLanguageSet(org.apache.pluto.om.common.LanguageSet languages)
void	setMetadata(org.apache.jetspeed.om.common.GenericMetadata metadata)
void	setName(String arg0)
void	setPortletApplicationDefinition(org.apache.pluto.om.portlet.PortletApplicationDefinition pad)
void	setPortletClassLoader(ClassLoader arg0)
void	setPortletIdentifier(String portletIndentifier)
void	setPreferenceSet(org.apache.pluto.om.common.PreferenceSet preferences)
void	setPreferenceValidatorClassname(String classname)
void	store()

Methods inherited from class java.lang.Object

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

Field Detail

portletDefinition

private final org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite portletDefinition

fragment

private final org.apache.jetspeed.om.page.Fragment fragment

Constructor Detail

FragmentPortletDefinition

public FragmentPortletDefinition(org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite portletDefinition,
                                 org.apache.jetspeed.om.page.Fragment fragment)

Method Detail

addContentType

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

Specified by:

addContentType in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

addContentType

public void addContentType(String contentType,
                           Collection modes)

Specified by:

addContentType in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

addDescription

public void addDescription(Locale locale,
                           String description)

Specified by:

addDescription in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

addDisplayName

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

Specified by:

addDisplayName in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

addDisplayName

public void addDisplayName(Locale locale,
                           String displayName)

Specified by:

addDisplayName in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

addInitParameter

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

Specified by:

addInitParameter in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

addInitParameter

public org.apache.jetspeed.om.common.ParameterComposite addInitParameter(String name,
                                                                         String value,
                                                                         String description,
                                                                         Locale locale)

Specified by:

addInitParameter in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

addInitParameter

public org.apache.jetspeed.om.common.ParameterComposite addInitParameter(String name,
                                                                         String value)

Specified by:

addInitParameter in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

addLanguage

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

Specified by:

addLanguage in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

addLanguage

public void addLanguage(String title,
                        String shortTitle,
                        String keywords,
                        Locale locale)

Specified by:

addLanguage in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

addPreference

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

Specified by:

addPreference in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

addPreference

public org.apache.jetspeed.om.common.preference.PreferenceComposite addPreference(String name,
                                                                                  String[] values)

Specified by:

addPreference in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

addSecurityRoleRef

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

Specified by:

addSecurityRoleRef in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

addSecurityRoleRef

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

Specified by:

addSecurityRoleRef in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

getClassName

public 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(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 org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

getDescriptionText

public String getDescriptionText(Locale locale)

Specified by:

getDescriptionText in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

getDisplayName

public org.apache.pluto.om.common.DisplayName getDisplayName(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 org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

getDisplayNameText

public String getDisplayNameText(Locale locale)

Specified by:

getDisplayNameText in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

getExpirationCache

public 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 org.apache.jetspeed.om.common.GenericMetadata getMetadata()

Specified by:

getMetadata in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

getName

public 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 ClassLoader getPortletClassLoader()

Specified by:

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

getPortletIdentifier

public String getPortletIdentifier()

Specified by:

getPortletIdentifier in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

getPreferenceSet

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

Specified by:

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

getPreferenceValidatorClassname

public String getPreferenceValidatorClassname()

Specified by:

getPreferenceValidatorClassname in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

getResourceBundle

public String getResourceBundle()

Specified by:

getResourceBundle in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

getServletDefinition

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

Specified by:

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

getSupportedLocales

public Collection getSupportedLocales()

Specified by:

getSupportedLocales in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

getUniqueName

public String getUniqueName()

Specified by:

getUniqueName in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

setClassName

public void setClassName(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 org.apache.jetspeed.om.common.portlet.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(String cache)

Specified by:

setExpirationCache in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

setId

public void setId(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 org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

setInitSecurityRoleRefSet

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

Specified by:

setInitSecurityRoleRefSet in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

setLanguageSet

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

Specified by:

setLanguageSet in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

setMetadata

public void setMetadata(org.apache.jetspeed.om.common.GenericMetadata metadata)

Specified by:

setMetadata in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

setName

public void setName(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 org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

setPortletClassLoader

public void setPortletClassLoader(ClassLoader arg0)

Specified by:

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

setPortletIdentifier

public void setPortletIdentifier(String portletIndentifier)

Specified by:

setPortletIdentifier in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

setPreferenceSet

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

Specified by:

setPreferenceSet in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

setPreferenceValidatorClassname

public void setPreferenceValidatorClassname(String classname)

Specified by:

setPreferenceValidatorClassname in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

store

public void store()
           throws IOException

Specified by:

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

Throws:

IOException

getJetspeedSecurityConstraint

public String getJetspeedSecurityConstraint()

Specified by:

getJetspeedSecurityConstraint in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite

setJetspeedSecurityConstraint

public void setJetspeedSecurityConstraint(String constraint)

Specified by:

setJetspeedSecurityConstraint in interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite