Tags for Portlet Management Tasks

obtainPortletAdmin

All the portlet administration tags should be called from within this nested tag and will be operating on the base distinguished node specified here. For example, <dtportletadmin:obtainPortletAdmin baseDN="$baseDN">...</dtportletadmin:obtainPortletAdmin> .

The baseDN attribute is required and must be a valid node in Directory Server. For example, dc=red,dc=iplanet,dc=com.

createPortletChannel

Allows creation of a portlet channel based on a portlet. For example, <dtportletadmin:createPortletChannel channelName="myPortletChannel" portletName="portletsamples.JSPPortlet"/> .

The channelName attribute is required and must contain the name of the channel. The portletName attribute is required and must contains the name of the base portlet.

getExistingPortlets

Gets the list of existing portlets. For example, <dtportletadmin:getExistingPortlets id="ExistingPortlets"/>.

The id attribute is optional and takes the name of the exported scoped variable for the resulting value. The scope attribute is optional and takes the scope for id.

Returns java.util.Set.

getPortletPreferenceNames

Gets the list of portlet preference names. For example, <dtportletadmin:getPortletPreferenceNames id="prefNames" portletName="BookmarkPortlet"/> .

The id attribute is optional and takes the name of the exported scoped variable for the resulting value. The scope attribute is optional and takes the scope for id. The portletName attribute is required and must contain the name of the portlet channel.

Returns java.util.Set.

getPortletPreferenceStringValue

Gets the portlet preference value as a string given a portlet channel name and the preference key. For example, <dtportletadmin:getPortletPreferenceStringValue id="targetstring" portletName="BookmarkPortlet" prefNam e="targets"/>.

The id attribute is optional and takes the name of the exported scoped variable for the resulting value. The scope attribute is optional and takes the scope for id. The portletName attribute is required and must contain the name of the portlet channel. The prefName attribute is required and must contain the preference key.

Returns java.lang.String.

getPortletPreferenceValues

Gets the portlet preference values given a portlet channel name and the preference key. For example, <dtportletadmin:getPortletPreferenceValues id="targets" portletName="BookmarkPortlet" prefName="targets"/>.

The id attribute is optional and takes the name of the exported scoped variable for the resulting value. The scope attribute is optional and takes the scope for id. The portletName attribute is required and must contain the name of the portlet channel. The prefName attribute is required and must contain the preference key.

Returns java.util.List.

setPortletPreferenceStringValue

Sets the portlet preference value as a string given a portlet channel name and the preference key and value. For example, <dtportletadmin:setPortletPreferenceStringValue portletName="JSPPortlet" prefName="contentpage" value="content.jsp"/>.

The portletName attribute is required and must contain the name of the portlet channel. The prefName attribute is required and must contain the preference key. The value attribute is required and must contain a string value.

setPortletPreferenceValues

Sets the portlet preference values given a portlet channel name and the preference key and an array of String values. For example, <dtportletadmin:setPortletPreferenceValues portletName="BookmarkPortlet" prefName="targets" prefValues= "$prefnamesvalues"/> .

The portletName attribute is required and must contain the name of the portlet channel. The prefName attribute is required and must contain the preference key. The prefvalues attribute is required and must contain a string array of values.