|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.jetspeed.om.portlet.impl.PortletDefinitionImpl
public class PortletDefinitionImpl
PortletDefinitionImpl
| Field Summary | |
|---|---|
protected long |
appId
|
protected java.util.List |
portletEntities
|
protected static PortletFactory |
portletFactory
|
protected static PortletRegistry |
registry
This is a static instance of the PortletREgistry that can be used by all instances of the PortletDefinitionImpl to support the PortletDefintionCtrl.store() method. |
| Fields inherited from interface org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite |
|---|
PORTLETS_PREFS_ROOT |
| Constructor Summary | |
|---|---|
PortletDefinitionImpl()
|
|
| Method Summary | |
|---|---|
void |
addContentType(org.apache.pluto.om.portlet.ContentType cType)
|
void |
addContentType(java.lang.String contentType,
java.util.Collection modes)
|
void |
addDescription(org.apache.pluto.om.common.Description description)
|
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)
|
void |
addInitParameter(org.apache.pluto.om.common.Parameter parameter)
|
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)
|
void |
addSupportedLocale(java.lang.String locale)
|
boolean |
equals(java.lang.Object obj)
|
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()
|
protected java.util.Collection |
getMetadataFields()
|
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()
|
javax.portlet.PreferencesValidator |
getPreferencesValidator()
|
java.lang.String |
getPreferenceValidatorClassname()
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. |
int |
hashCode()
|
void |
postLoad(java.lang.Object parameter)
|
void |
setClassName(java.lang.String className)
|
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 oid)
|
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)
|
protected void |
setMetadataFields(java.util.Collection metadataFields)
|
void |
setName(java.lang.String name)
|
void |
setPortletApplicationDefinition(org.apache.pluto.om.portlet.PortletApplicationDefinition pad)
|
void |
setPortletClassLoader(java.lang.ClassLoader loader)
|
static void |
setPortletFactory(PortletFactory portletFactory)
|
void |
setPortletIdentifier(java.lang.String portletIdentifier)
|
static void |
setPortletRegistry(PortletRegistry registry)
|
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 string)
setPreferenceValidatorClassname |
void |
setResourceBundle(java.lang.String string)
|
void |
store()
store will attempt to perform an atomic persistence call against this portletDefinition. |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected static PortletRegistry registry
protected static PortletFactory portletFactory
protected java.util.List portletEntities
protected long appId
| Constructor Detail |
|---|
public PortletDefinitionImpl()
| Method Detail |
|---|
public org.apache.pluto.om.common.ObjectID getId()
getId in interface org.apache.pluto.om.portlet.PortletDefinitionPortletDefinition.getId()public java.lang.String getClassName()
getClassName in interface org.apache.pluto.om.portlet.PortletDefinitionPortletDefinition.getClassName()public java.lang.String getName()
getName in interface org.apache.pluto.om.portlet.PortletDefinitionPortletDefinition.getName()public org.apache.pluto.om.common.LanguageSet getLanguageSet()
getLanguageSet in interface org.apache.pluto.om.portlet.PortletDefinitionPortletDefinition.getLanguageSet()public org.apache.pluto.om.common.ParameterSet getInitParameterSet()
getInitParameterSet in interface org.apache.pluto.om.portlet.PortletDefinitionPortletDefinition.getInitParameterSet()public org.apache.pluto.om.common.SecurityRoleRefSet getInitSecurityRoleRefSet()
getInitSecurityRoleRefSet in interface org.apache.pluto.om.portlet.PortletDefinitionPortletDefinition.getInitSecurityRoleRefSet()public org.apache.pluto.om.common.PreferenceSet getPreferenceSet()
getPreferenceSet in interface org.apache.pluto.om.portlet.PortletDefinitionPortletDefinition.getPreferenceSet()public void setPreferenceSet(org.apache.pluto.om.common.PreferenceSet preferences)
PortletDefinitionComposite
setPreferenceSet in interface PortletDefinitionCompositePortletDefinitionComposite.setPreferenceSet(org.apache.pluto.om.common.PreferenceSet)public org.apache.pluto.om.portlet.ContentTypeSet getContentTypeSet()
getContentTypeSet in interface org.apache.pluto.om.portlet.PortletDefinitionPortletDefinition.getContentTypeSet()public org.apache.pluto.om.portlet.PortletApplicationDefinition getPortletApplicationDefinition()
getPortletApplicationDefinition in interface org.apache.pluto.om.portlet.PortletDefinitionPortletDefinition.getPortletApplicationDefinition()public org.apache.pluto.om.servlet.ServletDefinition getServletDefinition()
getServletDefinition in interface org.apache.pluto.om.portlet.PortletDefinitionPortletDefinition.getServletDefinition()public java.lang.String getExpirationCache()
getExpirationCache in interface org.apache.pluto.om.portlet.PortletDefinitionPortletDefinition.getExpirationCache()public java.lang.ClassLoader getPortletClassLoader()
getPortletClassLoader in interface org.apache.pluto.om.portlet.PortletDefinitionPortletDefinition.getPortletClassLoader()public void setId(java.lang.String oid)
setId in interface org.apache.pluto.om.portlet.PortletDefinitionCtrlPortletDefinitionCtrl.setId(java.lang.String)public void setClassName(java.lang.String className)
setClassName in interface org.apache.pluto.om.portlet.PortletDefinitionCtrlPortletDefinitionCtrl.setClassName(java.lang.String)public void setName(java.lang.String name)
setName in interface org.apache.pluto.om.portlet.PortletDefinitionCtrlPortletDefinitionCtrl.setName(java.lang.String)public void setPortletClassLoader(java.lang.ClassLoader loader)
setPortletClassLoader in interface org.apache.pluto.om.portlet.PortletDefinitionCtrlPortletDefinitionCtrl.setPortletClassLoader(java.lang.ClassLoader)public void addLanguage(org.apache.pluto.om.common.Language lang)
addLanguage in interface PortletDefinitionCompositePortletDefinitionComposite.addLanguage(org.apache.pluto.om.common.Language)
public void addLanguage(java.lang.String title,
java.lang.String shortTitle,
java.lang.String keywords,
java.util.Locale locale)
addLanguage in interface PortletDefinitionCompositePortletDefinitionComposite.addLanguage(java.lang.String, java.lang.String, java.lang.String, java.util.Locale)public void setContentTypeSet(org.apache.pluto.om.portlet.ContentTypeSet contentTypes)
setContentTypeSet in interface PortletDefinitionCompositePortletDefinitionComposite.setContentTypeSet(org.apache.pluto.om.portlet.ContentTypeSet)public void setInitParameterSet(org.apache.pluto.om.common.ParameterSet parameters)
setInitParameterSet in interface PortletDefinitionCompositePortletDefinitionComposite.setInitParameterSet(org.apache.pluto.om.common.ParameterSet)public void setInitSecurityRoleRefSet(org.apache.pluto.om.common.SecurityRoleRefSet securityRefs)
setInitSecurityRoleRefSet in interface PortletDefinitionCompositePortletDefinitionComposite.setInitSecurityRoleRefSet(org.apache.pluto.om.common.SecurityRoleRefSet)public void setLanguageSet(org.apache.pluto.om.common.LanguageSet languages)
setLanguageSet in interface PortletDefinitionCompositePortletDefinitionComposite.setLanguageSet(org.apache.pluto.om.common.LanguageSet)
public ParameterComposite addInitParameter(java.lang.String name,
java.lang.String value,
org.apache.pluto.om.common.DescriptionSet description)
PortletDefinitionCompositesetInitParameter(name, title) plus allows a
description to inlcuded.
- Specified by:
addInitParameter in interface PortletDefinitionComposite
- Parameters:
name - Name of parameter to setvalue - new value of the parameter
- Returns:
- ParameterComposite newly created parameter
- See Also:
org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite#setInitParameter(java.lang.String,
java.lang.String, java.lang.String)
public ParameterComposite addInitParameter(java.lang.String name,
java.lang.String value,
java.lang.String description,
java.util.Locale locale)
PortletDefinitionCompositesetInitParameter(name, title) plus allows you
to define one initial localized desription.
- Specified by:
addInitParameter in interface PortletDefinitionComposite
- Parameters:
name - Name of parameter to setvalue - new value of the parameterdescription - A description for this parameterlocale - The locale the description
- Returns:
- ParameterComposite newly created parameter
- See Also:
PortletDefinitionComposite.addInitParameter(java.lang.String,
java.lang.String, java.lang.String, java.util.Locale)
public void addInitParameter(org.apache.pluto.om.common.Parameter parameter)
public ParameterComposite addInitParameter(java.lang.String name,
java.lang.String value)
PortletDefinitionCompositePortletDefinition.. This has the
same affect as
((ParameterSetCtrl)PortletDefinition.getInitParamaterSet()).add()
addInitParameter in interface PortletDefinitionCompositename - Name of parameter to setvalue - new value of said parameter
org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite#setInitParameter(java.lang.String,
java.lang.String)public void setExpirationCache(java.lang.String cache)
PortletDefinitionComposite
setExpirationCache in interface PortletDefinitionCompositePortletDefinitionComposite.setExpirationCache(java.lang.String)public void addContentType(org.apache.pluto.om.portlet.ContentType cType)
addContentType in interface PortletDefinitionCompositePortletDefinitionComposite.addContentType(org.apache.pluto.om.portlet.ContentType)
public void addContentType(java.lang.String contentType,
java.util.Collection modes)
addContentType in interface PortletDefinitionCompositeorg.apache.jetspeed.om.common.portlet.PortletDefinitionComposite#addContentType(java.lang.String, java.lang.String[])
public PreferenceComposite addPreference(java.lang.String name,
java.lang.String[] values)
addPreference in interface PortletDefinitionCompositeorg.apache.jetspeed.om.common.portlet.PortletDefinitionComposite#addPreference(java.lang.String,
java.util.Collection)public void setPortletIdentifier(java.lang.String portletIdentifier)
setPortletIdentifier in interface PortletDefinitionCompositepublic java.lang.String getPortletIdentifier()
getPortletIdentifier in interface PortletDefinitionCompositepublic void setPortletApplicationDefinition(org.apache.pluto.om.portlet.PortletApplicationDefinition pad)
setPortletApplicationDefinition in interface PortletDefinitionCompositePortletDefinitionComposite.setPortletApplicationDefinition(org.apache.pluto.om.portlet.PortletApplicationDefinition)public boolean equals(java.lang.Object obj)
equals in class java.lang.ObjectObject.equals(java.lang.Object)public int hashCode()
hashCode in class java.lang.ObjectObject.hashCode()public java.lang.String getUniqueName()
PortletDefinitionComposite
getUniqueName in interface PortletDefinitionCompositenull or this portlet has not
yet been assigned to an portlet application, null is returned.PortletDefinitionComposite.getUniqueName()public org.apache.pluto.om.common.Description getDescription(java.util.Locale arg0)
getDescription in interface org.apache.pluto.om.portlet.PortletDefinitionPortletDefinition.getDescription(java.util.Locale)public org.apache.pluto.om.common.DisplayName getDisplayName(java.util.Locale arg0)
getDisplayName in interface org.apache.pluto.om.portlet.PortletDefinitionPortletDefinition.getDisplayName(java.util.Locale)public void setDescriptions(org.apache.pluto.om.common.DescriptionSet arg0)
setDescriptions in interface org.apache.pluto.om.portlet.PortletDefinitionCtrlPortletDefinitionCtrl.setDescriptions(org.apache.pluto.om.common.DescriptionSet)public void setDisplayNames(org.apache.pluto.om.common.DisplayNameSet arg0)
setDisplayNames in interface org.apache.pluto.om.portlet.PortletDefinitionCtrlPortletDefinitionCtrl.setDisplayNames(org.apache.pluto.om.common.DisplayNameSet)public java.lang.String getDisplayNameText(java.util.Locale locale)
getDisplayNameText in interface PortletDefinitionCompositelocale - Locale to get the display name for
null
if no DisplayName exists for this localepublic java.lang.String getDescriptionText(java.util.Locale locale)
getDescriptionText in interface PortletDefinitionCompositelocale - Locale to get the description for
null
if no Description exists for this localepublic org.apache.pluto.om.common.DescriptionSet getDescriptionSet()
getDescriptionSet in interface PortletDefinitionComposite
public void addDescription(java.util.Locale locale,
java.lang.String description)
addDescription in interface PortletDefinitionCompositePortletDefinitionComposite.addDescription(java.util.Locale,
java.lang.String)public void addDescription(org.apache.pluto.om.common.Description description)
public void addDisplayName(java.util.Locale locale,
java.lang.String displayName)
addDisplayName in interface PortletDefinitionCompositePortletDefinitionComposite.addDisplayName(java.util.Locale,
java.lang.String)public void addDisplayName(org.apache.pluto.om.common.DisplayName displayName)
PortletDefinitionCompositeaddDisplayName
addDisplayName in interface PortletDefinitionCompositepublic org.apache.pluto.om.common.DisplayNameSet getDisplayNameSet()
getDisplayNameSet in interface PortletDefinitionComposite
public void store()
throws java.io.IOException
store will attempt to perform an atomic persistence call against this portletDefinition.
store in interface org.apache.pluto.om.portlet.PortletDefinitionCtrljava.io.IOExceptionPortletDefinitionCtrl.store()public java.lang.String getPreferenceValidatorClassname()
getPreferenceValidatorClassname
getPreferenceValidatorClassname in interface PortletDefinitionCompositepublic void setPreferenceValidatorClassname(java.lang.String string)
setPreferenceValidatorClassname
setPreferenceValidatorClassname in interface PortletDefinitionCompositestring - public void addPreference(org.apache.pluto.om.common.Preference preference)
addPreference in interface PortletDefinitionCompositepreference - PortletDefinitionComposite.addPreference(org.apache.pluto.om.common.Preference)public void addSecurityRoleRef(org.apache.pluto.om.common.SecurityRoleRef securityRef)
PortletDefinitionCompositeaddSecurityRoleRef
Adds thesecurityRef to the existing
set of SecurityRoleRefs of this PortletDefinition
addSecurityRoleRef in interface PortletDefinitionCompositesecurityRef - SecurityRoleRef to add.PortletDefinitionComposite.addSecurityRoleRef(org.apache.pluto.om.common.SecurityRoleRef)
public org.apache.pluto.om.common.SecurityRoleRef addSecurityRoleRef(java.lang.String roleName,
java.lang.String roleLink)
addSecurityRoleRef in interface PortletDefinitionCompositePortletDefinitionComposite.addSecurityRoleRef(java.lang.String, java.lang.String)public GenericMetadata getMetadata()
getMetadata in interface PortletDefinitionCompositePortletApplication.getMetadata()public void setMetadata(GenericMetadata metadata)
setMetadata in interface PortletDefinitionCompositeMutablePortletApplication.setMetadata(org.apache.jetspeed.om.common.GenericMetadata)protected java.util.Collection getMetadataFields()
protected void setMetadataFields(java.util.Collection metadataFields)
collection - public java.lang.String getResourceBundle()
getResourceBundle in interface PortletDefinitionCompositepublic void setResourceBundle(java.lang.String string)
string - public java.util.Collection getSupportedLocales()
getSupportedLocales in interface PortletDefinitionCompositepublic void addSupportedLocale(java.lang.String locale)
public void postLoad(java.lang.Object parameter)
throws java.lang.Exception
postLoad in interface Supportjava.lang.Exceptionpublic static void setPortletRegistry(PortletRegistry registry)
public static void setPortletFactory(PortletFactory portletFactory)
public javax.portlet.PreferencesValidator getPreferencesValidator()
getPreferencesValidator in interface PreferencesValidatorFactorypublic java.lang.String getJetspeedSecurityConstraint()
PortletDefinitionCompositeGet 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.
getJetspeedSecurityConstraint in interface PortletDefinitionCompositepublic void setJetspeedSecurityConstraint(java.lang.String constraint)
PortletDefinitionCompositeSet 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.
setJetspeedSecurityConstraint in interface PortletDefinitionCompositeconstraint - The name of the Security Definition defined in
the Jetspeed Security Constraints
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||