org.apache.jetspeed.om.common.portlet
Interface PortletDefinitionComposite

All Superinterfaces:

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

public interface PortletDefinitionComposite
extends org.apache.pluto.om.portlet.PortletDefinition, org.apache.pluto.om.portlet.PortletDefinitionCtrl, Serializable

PortletDefinitionComposite

Version:

$Id: PortletDefinitionComposite.java 516448 2007-03-09 16:25:47Z ate $

Author:

Scott T. Weaver

Field Summary

static String

PORTLETS_PREFS_ROOT

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) addDisplayName
void	addDisplayName(Locale locale, String displayName)
ParameterComposite	addInitParameter(String name, String value) Convenience method for directly adding init parameters to this PortletDefinition..
ParameterComposite	addInitParameter(String name, String value, org.apache.pluto.om.common.DescriptionSet description) Same as setInitParameter(name, title) plus allows a description to inlcuded.
ParameterComposite	addInitParameter(String name, String value, String description, 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(String title, String shortTitle, String keywords, Locale locale)
void	addPreference(org.apache.pluto.om.common.Preference preference)
PreferenceComposite	addPreference(String name, String[] values)
void	addSecurityRoleRef(org.apache.pluto.om.common.SecurityRoleRef securityRef) addSecurityRoleRef
org.apache.pluto.om.common.SecurityRoleRef	addSecurityRoleRef(String roleName, String roleLink)
org.apache.pluto.om.common.DescriptionSet	getDescriptionSet()
String	getDescriptionText(Locale locale) Returns localized text of this PortletDefinitions description.
org.apache.pluto.om.common.DisplayNameSet	getDisplayNameSet()
String	getDisplayNameText(Locale locale) Returns localized text of this PortletDefinitions display name.
String	getJetspeedSecurityConstraint() Get the Jetspeed Security Constraint reference for this portlet.
GenericMetadata	getMetadata()
String	getPortletIdentifier()
String	getPreferenceValidatorClassname()
String	getResourceBundle()
Collection	getSupportedLocales()
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	setContentTypeSet(org.apache.pluto.om.portlet.ContentTypeSet contentTypes)
void	setExpirationCache(String cache) Setter for setting expiration cache time for this portlet
void	setInitParameterSet(org.apache.pluto.om.common.ParameterSet parameters)
void	setInitSecurityRoleRefSet(org.apache.pluto.om.common.SecurityRoleRefSet securityRefs)
void	setJetspeedSecurityConstraint(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	setPortletApplicationDefinition(org.apache.pluto.om.portlet.PortletApplicationDefinition pad)
void	setPortletIdentifier(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(String classname)

Methods inherited from interface org.apache.pluto.om.portlet.PortletDefinition

getClassName, getContentTypeSet, getDescription, getDisplayName, getExpirationCache, getId, getInitParameterSet, getInitSecurityRoleRefSet, getLanguageSet, getName, getPortletApplicationDefinition, getPortletClassLoader, getPreferenceSet, getServletDefinition

Methods inherited from interface org.apache.pluto.om.portlet.PortletDefinitionCtrl

setClassName, setDescriptions, setDisplayNames, setId, setName, setPortletClassLoader, store

Field Detail

PORTLETS_PREFS_ROOT

static final String PORTLETS_PREFS_ROOT

See Also:

Constant Field Values

Method Detail

getMetadata

GenericMetadata getMetadata()

setMetadata

void setMetadata(GenericMetadata metadata)

addLanguage

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

addLanguage

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

addContentType

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

addContentType

void addContentType(String contentType,
                    Collection modes)

setLanguageSet

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

getResourceBundle

String getResourceBundle()

getSupportedLocales

Collection getSupportedLocales()

setPreferenceSet

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.

Parameters:

preferences -

setInitParameterSet

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

setContentTypeSet

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

setInitSecurityRoleRefSet

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

addInitParameter

ParameterComposite addInitParameter(String name,
                                    String value)

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

Parameters:

name - Name of parameter to set

value - new value of said parameter

Returns:

ParameterComposite newly created parameter

addInitParameter

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

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

Parameters:

name - Name of parameter to set

value - new value of the parameter

DescriptionSet - containing locale-specific descriptions 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

ParameterComposite addInitParameter(String name,
                                    String value,
                                    String description,
                                    Locale locale)

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

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)

setExpirationCache

void setExpirationCache(String cache)

Setter for setting expiration cache time for this portlet

setPortletApplicationDefinition

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

addPreference

PreferenceComposite addPreference(String name,
                                  String[] values)

addPreference

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

setPortletIdentifier

void setPortletIdentifier(String portletIndentifier)

getPortletIdentifier

String getPortletIdentifier()

getUniqueName

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.
FORMAT: application name:portlet name
EXAMPLE: com.myapp.portletApp1:weather-portlet

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.

getDisplayNameText

String getDisplayNameText(Locale locale)

Returns localized text of this PortletDefinitions display name.

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

getDescriptionText

String getDescriptionText(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

addDescription

void addDescription(Locale locale,
                    String description)

getDescriptionSet

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

addDisplayName

void addDisplayName(Locale locale,
                    String displayName)

addDisplayName

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

addDisplayName

Parameters:

displayName -

getDisplayNameSet

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

getPreferenceValidatorClassname

String getPreferenceValidatorClassname()

setPreferenceValidatorClassname

void setPreferenceValidatorClassname(String classname)

addSecurityRoleRef

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

addSecurityRoleRef

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

Parameters:

securityRef - SecurityRoleRef to add.

addSecurityRoleRef

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

getJetspeedSecurityConstraint

String getJetspeedSecurityConstraint()

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.

Returns:

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

setJetspeedSecurityConstraint

void setJetspeedSecurityConstraint(String constraint)

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.

Parameters:

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