|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jetspeed.om.portlet.impl.FragmentPortletDefinition
public class FragmentPortletDefinition
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.
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 |
---|
public FragmentPortletDefinition(PortletDefinitionComposite portletDefinition, Fragment fragment)
Method Detail |
---|
public void addContentType(org.apache.pluto.om.portlet.ContentType cType)
addContentType
in interface PortletDefinitionComposite
public void addContentType(java.lang.String contentType, java.util.Collection modes)
addContentType
in interface PortletDefinitionComposite
public void addDescription(java.util.Locale locale, java.lang.String description)
addDescription
in interface PortletDefinitionComposite
public void addDisplayName(org.apache.pluto.om.common.DisplayName displayName)
PortletDefinitionComposite
addDisplayName
addDisplayName
in interface PortletDefinitionComposite
public void addDisplayName(java.util.Locale locale, java.lang.String displayName)
addDisplayName
in interface PortletDefinitionComposite
public ParameterComposite addInitParameter(java.lang.String name, java.lang.String value, org.apache.pluto.om.common.DescriptionSet description)
PortletDefinitionComposite
setInitParameter(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.PortletApplicationComposite#addInitParameter(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)
PortletDefinitionComposite
setInitParameter(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:
org.apache.jetspeed.om.common.portlet.PortletApplicationComposite#addInitParameter(java.lang.String, java.lang.String)
public ParameterComposite addInitParameter(java.lang.String name, java.lang.String value)
PortletDefinitionComposite
PortletDefinition.
. This has the
same affect as
((ParameterSetCtrl)PortletDefinition.getInitParamaterSet()).add()
addInitParameter
in interface PortletDefinitionComposite
name
- Name of parameter to setvalue
- new value of said parameter
public void addLanguage(org.apache.pluto.om.common.Language lang)
addLanguage
in interface PortletDefinitionComposite
public void addLanguage(java.lang.String title, java.lang.String shortTitle, java.lang.String keywords, java.util.Locale locale)
addLanguage
in interface PortletDefinitionComposite
public void addPreference(org.apache.pluto.om.common.Preference preference)
addPreference
in interface PortletDefinitionComposite
public PreferenceComposite addPreference(java.lang.String name, java.lang.String[] values)
addPreference
in interface PortletDefinitionComposite
public void addSecurityRoleRef(org.apache.pluto.om.common.SecurityRoleRef securityRef)
PortletDefinitionComposite
addSecurityRoleRef
Adds thesecurityRef
to the existing
set of SecurityRoleRefs of this PortletDefinition
addSecurityRoleRef
in interface PortletDefinitionComposite
securityRef
- SecurityRoleRef to add.public org.apache.pluto.om.common.SecurityRoleRef addSecurityRoleRef(java.lang.String roleName, java.lang.String roleLink)
addSecurityRoleRef
in interface PortletDefinitionComposite
public java.lang.String getClassName()
getClassName
in interface org.apache.pluto.om.portlet.PortletDefinition
public org.apache.pluto.om.portlet.ContentTypeSet getContentTypeSet()
getContentTypeSet
in interface org.apache.pluto.om.portlet.PortletDefinition
public org.apache.pluto.om.common.Description getDescription(java.util.Locale arg0)
getDescription
in interface org.apache.pluto.om.portlet.PortletDefinition
public org.apache.pluto.om.common.DescriptionSet getDescriptionSet()
getDescriptionSet
in interface PortletDefinitionComposite
public java.lang.String getDescriptionText(java.util.Locale locale)
PortletDefinitionComposite
getDescriptionText
in interface PortletDefinitionComposite
locale
- Locale to get the description for
null
if no Description exists for this localepublic org.apache.pluto.om.common.DisplayName getDisplayName(java.util.Locale arg0)
getDisplayName
in interface org.apache.pluto.om.portlet.PortletDefinition
public org.apache.pluto.om.common.DisplayNameSet getDisplayNameSet()
getDisplayNameSet
in interface PortletDefinitionComposite
public java.lang.String getDisplayNameText(java.util.Locale locale)
PortletDefinitionComposite
getDisplayNameText
in interface PortletDefinitionComposite
locale
- Locale to get the display name for
null
if no DisplayName exists for this localepublic java.lang.String getExpirationCache()
getExpirationCache
in interface org.apache.pluto.om.portlet.PortletDefinition
public org.apache.pluto.om.common.ObjectID getId()
getId
in interface org.apache.pluto.om.portlet.PortletDefinition
public org.apache.pluto.om.common.ParameterSet getInitParameterSet()
getInitParameterSet
in interface org.apache.pluto.om.portlet.PortletDefinition
public org.apache.pluto.om.common.SecurityRoleRefSet getInitSecurityRoleRefSet()
getInitSecurityRoleRefSet
in interface org.apache.pluto.om.portlet.PortletDefinition
public org.apache.pluto.om.common.LanguageSet getLanguageSet()
getLanguageSet
in interface org.apache.pluto.om.portlet.PortletDefinition
public GenericMetadata getMetadata()
getMetadata
in interface PortletDefinitionComposite
public java.lang.String getName()
getName
in interface org.apache.pluto.om.portlet.PortletDefinition
public org.apache.pluto.om.portlet.PortletApplicationDefinition getPortletApplicationDefinition()
getPortletApplicationDefinition
in interface org.apache.pluto.om.portlet.PortletDefinition
public java.lang.ClassLoader getPortletClassLoader()
getPortletClassLoader
in interface org.apache.pluto.om.portlet.PortletDefinition
public java.lang.String getPortletIdentifier()
getPortletIdentifier
in interface PortletDefinitionComposite
public org.apache.pluto.om.common.PreferenceSet getPreferenceSet()
getPreferenceSet
in interface org.apache.pluto.om.portlet.PortletDefinition
public java.lang.String getPreferenceValidatorClassname()
getPreferenceValidatorClassname
in interface PortletDefinitionComposite
public java.lang.String getResourceBundle()
getResourceBundle
in interface PortletDefinitionComposite
public org.apache.pluto.om.servlet.ServletDefinition getServletDefinition()
getServletDefinition
in interface org.apache.pluto.om.portlet.PortletDefinition
public java.util.Collection getSupportedLocales()
getSupportedLocales
in interface PortletDefinitionComposite
public java.lang.String getUniqueName()
PortletDefinitionComposite
getUniqueName
in interface PortletDefinitionComposite
null
or this portlet has not
yet been assigned to an portlet application, null
is returned.public void setClassName(java.lang.String arg0)
setClassName
in interface org.apache.pluto.om.portlet.PortletDefinitionCtrl
public void setContentTypeSet(org.apache.pluto.om.portlet.ContentTypeSet contentTypes)
setContentTypeSet
in interface PortletDefinitionComposite
public void setDescriptions(org.apache.pluto.om.common.DescriptionSet arg0)
setDescriptions
in interface org.apache.pluto.om.portlet.PortletDefinitionCtrl
public void setDisplayNames(org.apache.pluto.om.common.DisplayNameSet arg0)
setDisplayNames
in interface org.apache.pluto.om.portlet.PortletDefinitionCtrl
public void setExpirationCache(java.lang.String cache)
PortletDefinitionComposite
setExpirationCache
in interface PortletDefinitionComposite
public void setId(java.lang.String arg0)
setId
in interface org.apache.pluto.om.portlet.PortletDefinitionCtrl
public void setInitParameterSet(org.apache.pluto.om.common.ParameterSet parameters)
setInitParameterSet
in interface PortletDefinitionComposite
public void setInitSecurityRoleRefSet(org.apache.pluto.om.common.SecurityRoleRefSet securityRefs)
setInitSecurityRoleRefSet
in interface PortletDefinitionComposite
public void setLanguageSet(org.apache.pluto.om.common.LanguageSet languages)
setLanguageSet
in interface PortletDefinitionComposite
public void setMetadata(GenericMetadata metadata)
setMetadata
in interface PortletDefinitionComposite
public void setName(java.lang.String arg0)
setName
in interface org.apache.pluto.om.portlet.PortletDefinitionCtrl
public void setPortletApplicationDefinition(org.apache.pluto.om.portlet.PortletApplicationDefinition pad)
setPortletApplicationDefinition
in interface PortletDefinitionComposite
public void setPortletClassLoader(java.lang.ClassLoader arg0)
setPortletClassLoader
in interface org.apache.pluto.om.portlet.PortletDefinitionCtrl
public void setPortletIdentifier(java.lang.String portletIndentifier)
setPortletIdentifier
in interface PortletDefinitionComposite
public void setPreferenceSet(org.apache.pluto.om.common.PreferenceSet preferences)
PortletDefinitionComposite
setPreferenceSet
in interface PortletDefinitionComposite
public void setPreferenceValidatorClassname(java.lang.String classname)
setPreferenceValidatorClassname
in interface PortletDefinitionComposite
public void store() throws java.io.IOException
store
in interface org.apache.pluto.om.portlet.PortletDefinitionCtrl
java.io.IOException
public java.lang.String getJetspeedSecurityConstraint()
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.
getJetspeedSecurityConstraint
in interface PortletDefinitionComposite
public void setJetspeedSecurityConstraint(java.lang.String constraint)
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.
setJetspeedSecurityConstraint
in interface PortletDefinitionComposite
constraint
- 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 |