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

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

All Implemented Interfaces:

java.io.Serializable, Support, org.apache.ojb.broker.PersistenceBrokerAware, org.apache.pluto.container.om.portlet.PortletDefinition

public class PortletDefinitionImpl
extends java.lang.Object
implements PortletDefinition, java.io.Serializable, Support, org.apache.ojb.broker.PersistenceBrokerAware

PortletDefinitionImpl

Version:

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

See Also:

Serialized Form

Field Summary

protected java.lang.String	portletClass
protected java.lang.String	portletName
protected java.lang.String	preferenceValidatorClassname
protected java.lang.String	resourceBundle

Fields inherited from interface org.apache.jetspeed.om.portlet.PortletDefinition

CLONE_PARENT_INIT_PARAM

Constructor Summary

PortletDefinitionImpl()

PortletDefinitionImpl(java.lang.String cloneParent)

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)
void	addSupportedLocale(java.lang.String lang)
EventDefinitionReference	addSupportedProcessingEvent(javax.xml.namespace.QName qname)
EventDefinitionReference	addSupportedProcessingEvent(java.lang.String name)
void	addSupportedPublicRenderParameter(java.lang.String identifier)
EventDefinitionReference	addSupportedPublishingEvent(javax.xml.namespace.QName qname)
EventDefinitionReference	addSupportedPublishingEvent(java.lang.String name)
Supports	addSupports(java.lang.String mimeType)
void	afterDelete(org.apache.ojb.broker.PersistenceBroker arg0)
void	afterInsert(org.apache.ojb.broker.PersistenceBroker arg0)
void	afterLookup(org.apache.ojb.broker.PersistenceBroker arg0)
void	afterUpdate(org.apache.ojb.broker.PersistenceBroker arg0)
void	beforeDelete(org.apache.ojb.broker.PersistenceBroker arg0)
void	beforeInsert(org.apache.ojb.broker.PersistenceBroker arg0)
void	beforeUpdate(org.apache.ojb.broker.PersistenceBroker arg0)
boolean	equals(java.lang.Object obj)
PortletApplication	getApplication()
java.lang.String	getCacheScope() Caching scope, allowed values are "private" indicating that the content should not be shared across users and "public" indicating that the content may be shared across users.
java.lang.String	getCloneParent()
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)
int	getExpirationCache()
InitParam	getInitParam(java.lang.String name)
java.util.List<InitParam>	getInitParams()
java.lang.String	getJetspeedSecurityConstraint()
Language	getLanguage(java.util.Locale locale)
java.util.List<Language>	getLanguages()
GenericMetadata	getMetadata()
java.lang.String	getPortletClass()
PortletInfo	getPortletInfo()
java.lang.String	getPortletName()
Preferences	getPortletPreferences()
java.lang.String	getPreferenceValidatorClassname()
java.lang.String	getResourceBundle()
SecurityRoleRef	getSecurityRoleRef(java.lang.String roleName)
java.util.List<SecurityRoleRef>	getSecurityRoleRefs()
java.util.List<java.lang.String>	getSupportedLocales()
java.util.List<EventDefinitionReference>	getSupportedProcessingEvents()
java.util.List<java.lang.String>	getSupportedPublicRenderParameters()
java.util.List<EventDefinitionReference>	getSupportedPublishingEvents()
java.util.List<Supports>	getSupports()
Supports	getSupports(java.lang.String mimeType)
java.lang.String	getUniqueName()
int	hashCode()
boolean	isClone()
boolean	isSameIdentity(PortletDefinition other)
void	postLoad(java.lang.Object parameter)
void	setApplication(PortletApplication app)
void	setCacheScope(java.lang.String cacheScope)
void	setDescriptorPreferences(Preferences descriptorPreferences)
void	setExpirationCache(int value)
void	setJetspeedSecurityConstraint(java.lang.String constraint)
void	setPortletClass(java.lang.String portletClass)
void	setPortletName(java.lang.String name)
static void	setPortletPreferencesProvider(PortletPreferencesProvider portletPreferencesProvider)
void	setPreferenceValidatorClassname(java.lang.String string)
void	setResourceBundle(java.lang.String string)
void	storeChildren()

Methods inherited from class java.lang.Object

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

Field Detail

portletName

protected java.lang.String portletName

portletClass

protected java.lang.String portletClass

resourceBundle

protected java.lang.String resourceBundle

preferenceValidatorClassname

protected java.lang.String preferenceValidatorClassname

Constructor Detail

PortletDefinitionImpl

public PortletDefinitionImpl()

PortletDefinitionImpl

public PortletDefinitionImpl(java.lang.String cloneParent)

Method Detail

setPortletPreferencesProvider

public static void setPortletPreferencesProvider(PortletPreferencesProvider portletPreferencesProvider)

getApplication

public PortletApplication getApplication()

Specified by:

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

setApplication

public void setApplication(PortletApplication app)

getPortletName

public java.lang.String getPortletName()

Specified by:

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

setPortletName

public void setPortletName(java.lang.String name)

getPortletClass

public java.lang.String getPortletClass()

Specified by:

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

setPortletClass

public void setPortletClass(java.lang.String portletClass)

Specified by:

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

setDescriptorPreferences

public void setDescriptorPreferences(Preferences descriptorPreferences)

getDescriptorPreferences

public Preferences getDescriptorPreferences()

getPortletPreferences

public Preferences getPortletPreferences()

Specified by:

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

addDescriptorPreference

public Preference addDescriptorPreference(java.lang.String name)

getLanguage

public Language getLanguage(java.util.Locale locale)

getLanguages

public java.util.List<Language> getLanguages()

addLanguage

public Language addLanguage(java.util.Locale locale)

getUniqueName

public java.lang.String getUniqueName()

See Also:

PortletDefinition.getUniqueName()

getDescriptionText

public 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

getDisplayNameText

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

getPreferenceValidatorClassname

public java.lang.String getPreferenceValidatorClassname()

setPreferenceValidatorClassname

public void setPreferenceValidatorClassname(java.lang.String string)

getMetadata

public GenericMetadata getMetadata()

getResourceBundle

public java.lang.String getResourceBundle()

Specified by:

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

Returns:

setResourceBundle

public void setResourceBundle(java.lang.String string)

Specified by:

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

Parameters:

string -

getJetspeedSecurityConstraint

public java.lang.String getJetspeedSecurityConstraint()

setJetspeedSecurityConstraint

public void setJetspeedSecurityConstraint(java.lang.String constraint)

isSameIdentity

public boolean isSameIdentity(PortletDefinition other)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

storeChildren

public void storeChildren()

postLoad

public void postLoad(java.lang.Object parameter)
              throws java.lang.Exception

Specified by:

postLoad in interface Support

Throws:

java.lang.Exception

afterDelete

public void afterDelete(org.apache.ojb.broker.PersistenceBroker arg0)
                 throws org.apache.ojb.broker.PersistenceBrokerException

Specified by:

afterDelete in interface org.apache.ojb.broker.PersistenceBrokerAware

Throws:

org.apache.ojb.broker.PersistenceBrokerException

afterInsert

public void afterInsert(org.apache.ojb.broker.PersistenceBroker arg0)
                 throws org.apache.ojb.broker.PersistenceBrokerException

Specified by:

afterInsert in interface org.apache.ojb.broker.PersistenceBrokerAware

Throws:

org.apache.ojb.broker.PersistenceBrokerException

afterLookup

public void afterLookup(org.apache.ojb.broker.PersistenceBroker arg0)
                 throws org.apache.ojb.broker.PersistenceBrokerException

Specified by:

afterLookup in interface org.apache.ojb.broker.PersistenceBrokerAware

Throws:

org.apache.ojb.broker.PersistenceBrokerException

afterUpdate

public void afterUpdate(org.apache.ojb.broker.PersistenceBroker arg0)
                 throws org.apache.ojb.broker.PersistenceBrokerException

Specified by:

afterUpdate in interface org.apache.ojb.broker.PersistenceBrokerAware

Throws:

org.apache.ojb.broker.PersistenceBrokerException

beforeDelete

public void beforeDelete(org.apache.ojb.broker.PersistenceBroker arg0)
                  throws org.apache.ojb.broker.PersistenceBrokerException

Specified by:

beforeDelete in interface org.apache.ojb.broker.PersistenceBrokerAware

Throws:

org.apache.ojb.broker.PersistenceBrokerException

beforeInsert

public void beforeInsert(org.apache.ojb.broker.PersistenceBroker arg0)
                  throws org.apache.ojb.broker.PersistenceBrokerException

Specified by:

beforeInsert in interface org.apache.ojb.broker.PersistenceBrokerAware

Throws:

org.apache.ojb.broker.PersistenceBrokerException

beforeUpdate

public void beforeUpdate(org.apache.ojb.broker.PersistenceBroker arg0)
                  throws org.apache.ojb.broker.PersistenceBrokerException

Specified by:

beforeUpdate in interface org.apache.ojb.broker.PersistenceBrokerAware

Throws:

org.apache.ojb.broker.PersistenceBrokerException

getContainerRuntimeOption

public ContainerRuntimeOption getContainerRuntimeOption(java.lang.String name)

Specified by:

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

getContainerRuntimeOptions

public java.util.List<ContainerRuntimeOption> getContainerRuntimeOptions()

Specified by:

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

addContainerRuntimeOption

public ContainerRuntimeOption addContainerRuntimeOption(java.lang.String name)

Specified by:

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

getSecurityRoleRef

public SecurityRoleRef getSecurityRoleRef(java.lang.String roleName)

Specified by:

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

getSecurityRoleRefs

public java.util.List<SecurityRoleRef> getSecurityRoleRefs()

Specified by:

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

addSecurityRoleRef

public SecurityRoleRef addSecurityRoleRef(java.lang.String roleName)

Specified by:

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

getPortletInfo

public PortletInfo getPortletInfo()

Specified by:

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

getSupports

public Supports getSupports(java.lang.String mimeType)

Specified by:

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

getSupports

public java.util.List<Supports> getSupports()

Specified by:

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

addSupports

public Supports addSupports(java.lang.String mimeType)

Specified by:

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

getSupportedLocales

public java.util.List<java.lang.String> getSupportedLocales()

Specified by:

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

addSupportedLocale

public void addSupportedLocale(java.lang.String lang)

Specified by:

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

getSupportedPublicRenderParameters

public java.util.List<java.lang.String> getSupportedPublicRenderParameters()

Specified by:

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

addSupportedPublicRenderParameter

public void addSupportedPublicRenderParameter(java.lang.String identifier)

Specified by:

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

getCacheScope

public java.lang.String getCacheScope()

Caching scope, allowed values are "private" indicating that the content should not be shared across users and "public" indicating that the content may be shared across users. The default value if not present is "private".

Specified by:

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

setCacheScope

public void setCacheScope(java.lang.String cacheScope)

Specified by:

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

getExpirationCache

public int getExpirationCache()

Specified by:

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

setExpirationCache

public void setExpirationCache(int value)

Specified by:

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

getDescription

public Description getDescription(java.util.Locale locale)

Specified by:

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

getDescriptions

public java.util.List<Description> getDescriptions()

Specified by:

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

addDescription

public Description addDescription(java.lang.String lang)

Specified by:

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

getDisplayName

public DisplayName getDisplayName(java.util.Locale locale)

Specified by:

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

getDisplayNames

public java.util.List<DisplayName> getDisplayNames()

Specified by:

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

addDisplayName

public DisplayName addDisplayName(java.lang.String lang)

Specified by:

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

getInitParam

public InitParam getInitParam(java.lang.String name)

Specified by:

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

getInitParams

public java.util.List<InitParam> getInitParams()

Specified by:

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

addInitParam

public InitParam addInitParam(java.lang.String paramName)

Specified by:

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

getSupportedProcessingEvents

public java.util.List<EventDefinitionReference> getSupportedProcessingEvents()

Specified by:

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

addSupportedProcessingEvent

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

Specified by:

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

addSupportedProcessingEvent

public EventDefinitionReference addSupportedProcessingEvent(java.lang.String name)

Specified by:

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

getSupportedPublishingEvents

public java.util.List<EventDefinitionReference> getSupportedPublishingEvents()

Specified by:

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

addSupportedPublishingEvent

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

Specified by:

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

addSupportedPublishingEvent

public EventDefinitionReference addSupportedPublishingEvent(java.lang.String name)

Specified by:

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

isClone

public boolean isClone()

getCloneParent

public java.lang.String getCloneParent()