com.webmethods.portal.mech.storage.page

Class PortletHelper

java.lang.Object

com.webmethods.portal.mech.storage.page.PortletHelper

public class PortletHelper
extends Object

Helps instantiate portlet beans and render portlets in the context of the portal page.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CUSTOM_ERROR_REPORTER_ALIAS_PROPERTY
protected Map<IURI,IPortletBean>	m_beans
protected List<PortletData>	m_circularStack
protected Map<IURI,Reader>	m_contents
protected IPortletBean	m_error
protected ConfigurableInstancePropertyFilter	m_instanceFilter
protected PageData	m_page
protected IPortletBean	m_pp
protected IThingID	m_ppid
protected WireablePropertyFilter	m_wireableFilter
static String	PORTLET_PROFILE
static String	PORTLET_PSEUDO
static String	PORTLET_PSEUDO_OLD
static String	RELATION_PSEUDO_PORTLET
static String	XTYPE_SHORTCUT

Constructor Summary

Constructors

Constructor and Description
PortletHelper()
PortletHelper(PageData page)

Method Summary

Modifier and Type	Method and Description
IPortletPropertyListFilter	getConfigurableInstancePropertyFilter(IContext ctx, IURI portlet) Filter for determining the wireable properties of a portlet on a per-user, per-portlet basis.
IPortletPropertyListFilter	getConfigurableInstancePropertyFilter(IContext ctx, IURI portlet, boolean checkAccess) Filter for determining the wireable properties of a portlet on a per-user, per-portlet basis.
IPortletBean	getErrorBean(IContext ctx) Gets the error portlet bean.
IPortletBean	getFullyInitializedBean(IContext ctx, PortletData portlet) Instantiates portlet bean and adds all (user, page, wired, and runtime) properties to it.
IPortletBean	getFullyInitializedBean(IContext ctx, PortletData portlet, List<PortletData> circularWiringStack, boolean resolveWiring)
IPortletBean	getInitializedBean(IContext ctx, PortletData portlet) Instantiates portlet bean and adds all (user, page, and wired) properties to it, except for runtime properties.
IPortletBean	getInitializedBean(IContext ctx, PortletData portlet, boolean resolveWiring)
protected IPortletBean	getInitializedBean(IContext ctx, PortletData portlet, boolean resolveWiring, List<PortletData> circularWiringStack)
PageData	getPage()
IPortletBean	getPersonalProfileBean(IContext ctx) Gets the bean for the personal profile portlet.
protected IThingID	getPersonalProfileId()
IPortletBean	getPseudoBean(IContext ctx, IURI target) Gets the pseudo portlet bean for the specified item.
IURI	getPseudoId(IContext ctx, IURI target) Gets the pseudo portlet id for the specified item.
IPortletBean	getTitlebar(IContext ctx, PortletData portlet)
IPortletPropertyListFilter	getWireablePropertyFilter(IContext ctx, IURI portlet) Filter for determining the wireable properties of a portlet on a per-user, per-portlet basis.
IPortletPropertyListFilter	getWireablePropertyFilter(IContext ctx, IURI portlet, boolean checkAccess) Filter for determining the wireable properties of a portlet on a per-user, per-portlet basis.
List<Object>	getWiringDestinationGroupsAndProperties(IContext ctx, IURI portlet) Returns a list of IPortletPropertyInfos to which the specified user can wire.
Map<String,Object>	getWiringPreferences(IContext ctx, IURI portlet)
List<Object>	getWiringSourceGroupsAndProperties(IContext ctx, IURI portlet) Returns a list of IPortletPropertyInfos from which the specified user can wire.
void	initializePageProperties(IContext ctx, IURI portlet, IPortletBean bean) Adds just page properties to the previously instantiated portlet bean.
void	initializePageProperties(IContext ctx, PortletData portlet, IPortletBean bean) Adds just page properties to the previously instantiated portlet bean.
void	initializeRuntimeProperties(IContext ctx, IURI portlet, IPortletBean bean) Adds just runtime properties to the previously instantiated portlet bean.
void	initializeRuntimeProperties(IContext ctx, PortletData portlet, IPortletBean bean) Adds just runtime properties to the previously instantiated portlet bean.
void	initializeUserProperties(IContext ctx, IURI portlet, IPortletBean bean) Adds just user properties to the previously instantiated portlet bean.
void	initializeUserProperties(IContext ctx, PortletData portlet, IPortletBean bean) Adds just user properties to the previously instantiated portlet bean.
void	initializeWiredProperties(IContext ctx, IURI portlet, IPortletBean bean, List<PortletData> circularWiringStack) Adds just wired properties to the previously instantiated portlet bean.
void	initializeWiredProperties(IContext ctx, PortletData portlet, IPortletBean bean, List<PortletData> circularWiringStack) Adds just wired properties to the previously instantiated portlet bean.
IPortletBean	instantiateBean(IContext ctx, IURI portlet) Instantiates the bean for the specified portlet without user, page, wired, or runtime properties.
IPortletBean	instantiateBean(IContext ctx, PortletData portlet) Instantiates the bean for the specified portlet without user, page, wired, or runtime properties.
Reader	renderContent(IContext ctx, IURI portlet, IPortletBean bean, boolean allowDirectOutput) Renders the specified portlet.
Reader	renderContent(IContext ctx, PortletData portlet, boolean allowDirectOutput) Renders the specified portlet.
void	setPage(PageData page)

Methods inherited from class java.lang.Object

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

Field Detail

XTYPE_SHORTCUT

public static final String XTYPE_SHORTCUT

See Also:

Constant Field Values

PORTLET_PSEUDO_OLD

public static final String PORTLET_PSEUDO_OLD

See Also:

Constant Field Values

PORTLET_PSEUDO

public static final String PORTLET_PSEUDO

See Also:

Constant Field Values

PORTLET_PROFILE

public static final String PORTLET_PROFILE

See Also:

Constant Field Values

RELATION_PSEUDO_PORTLET

public static final String RELATION_PSEUDO_PORTLET

See Also:

Constant Field Values

CUSTOM_ERROR_REPORTER_ALIAS_PROPERTY

public static final String CUSTOM_ERROR_REPORTER_ALIAS_PROPERTY

See Also:

Constant Field Values

m_ppid

protected IThingID m_ppid

m_pp

protected IPortletBean m_pp

m_error

protected IPortletBean m_error

m_instanceFilter

protected ConfigurableInstancePropertyFilter m_instanceFilter

m_wireableFilter

protected WireablePropertyFilter m_wireableFilter

m_circularStack

protected List<PortletData> m_circularStack

m_page

protected PageData m_page

m_beans

protected Map<IURI,IPortletBean> m_beans

m_contents

protected Map<IURI,Reader> m_contents

Constructor Detail

PortletHelper

public PortletHelper()

PortletHelper

public PortletHelper(PageData page)

Method Detail

instantiateBean

public IPortletBean instantiateBean(IContext ctx,
                                    IURI portlet)
                             throws PortalException

Instantiates the bean for the specified portlet without user, page, wired, or runtime properties.

Throws:

PortalException

instantiateBean

public IPortletBean instantiateBean(IContext ctx,
                                    PortletData portlet)
                             throws PortalException

Instantiates the bean for the specified portlet without user, page, wired, or runtime properties.

Throws:

PortalException

initializeUserProperties

public void initializeUserProperties(IContext ctx,
                                     IURI portlet,
                                     IPortletBean bean)
                              throws PortalException

Adds just user properties to the previously instantiated portlet bean.

Throws:

PortalException

initializeUserProperties

public void initializeUserProperties(IContext ctx,
                                     PortletData portlet,
                                     IPortletBean bean)
                              throws PortalException

Adds just user properties to the previously instantiated portlet bean.

Throws:

PortalException

initializePageProperties

public void initializePageProperties(IContext ctx,
                                     IURI portlet,
                                     IPortletBean bean)
                              throws PortalException

Adds just page properties to the previously instantiated portlet bean.

Throws:

PortalException

initializePageProperties

public void initializePageProperties(IContext ctx,
                                     PortletData portlet,
                                     IPortletBean bean)
                              throws PortalException

Adds just page properties to the previously instantiated portlet bean.

Throws:

PortalException

initializeWiredProperties

public void initializeWiredProperties(IContext ctx,
                                      IURI portlet,
                                      IPortletBean bean,
                                      List<PortletData> circularWiringStack)
                               throws PortalException

Adds just wired properties to the previously instantiated portlet bean.

Parameters:

circularWiringStack - An array used internally to catch circular wiring. Simply pass in a blank array.

Throws:

PortalException

initializeWiredProperties

public void initializeWiredProperties(IContext ctx,
                                      PortletData portlet,
                                      IPortletBean bean,
                                      List<PortletData> circularWiringStack)
                               throws PortalException

Adds just wired properties to the previously instantiated portlet bean.

Parameters:

circularWiringStack - An array used internally to catch circular wiring. Simply pass in a blank array.

Throws:

PortalException

initializeRuntimeProperties

public void initializeRuntimeProperties(IContext ctx,
                                        IURI portlet,
                                        IPortletBean bean)
                                 throws PortalException

Adds just runtime properties to the previously instantiated portlet bean.

Throws:

PortalException

getWiringPreferences

public Map<String,Object> getWiringPreferences(IContext ctx,
                                               IURI portlet)

initializeRuntimeProperties

public void initializeRuntimeProperties(IContext ctx,
                                        PortletData portlet,
                                        IPortletBean bean)
                                 throws PortalException

Adds just runtime properties to the previously instantiated portlet bean.

Throws:

PortalException

getInitializedBean

public IPortletBean getInitializedBean(IContext ctx,
                                       PortletData portlet)
                                throws PortalException

Instantiates portlet bean and adds all (user, page, and wired) properties to it, except for runtime properties. This is useful when you want to initialize the portlet bean and manipulate it before rendering it.

Throws:

PortalException

getInitializedBean

public IPortletBean getInitializedBean(IContext ctx,
                                       PortletData portlet,
                                       boolean resolveWiring)
                                throws PortalException

Throws:

PortalException

getInitializedBean

protected IPortletBean getInitializedBean(IContext ctx,
                                          PortletData portlet,
                                          boolean resolveWiring,
                                          List<PortletData> circularWiringStack)
                                   throws PortalException

Throws:

PortalException

getFullyInitializedBean

public IPortletBean getFullyInitializedBean(IContext ctx,
                                            PortletData portlet)
                                     throws PortalException

Instantiates portlet bean and adds all (user, page, wired, and runtime) properties to it.

Throws:

PortalException

getFullyInitializedBean

public IPortletBean getFullyInitializedBean(IContext ctx,
                                            PortletData portlet,
                                            List<PortletData> circularWiringStack,
                                            boolean resolveWiring)
                                     throws PortalException

Throws:

PortalException

renderContent

public Reader renderContent(IContext ctx,
                            PortletData portlet,
                            boolean allowDirectOutput)
                     throws PortalException

Renders the specified portlet.

Parameters:

allowDirectOutput - If true, the portlet may render its content directly to the output stream. If the portlet does render directly to the output stream, the returned Reader will be null. Otherwise, the portlet will not render its content directly, and it will return a non-null Reader containing its content.

Throws:

PortalException

renderContent

public Reader renderContent(IContext ctx,
                            IURI portlet,
                            IPortletBean bean,
                            boolean allowDirectOutput)
                     throws PortalException

Renders the specified portlet.

Parameters:

allowDirectOutput - If true, the portlet may render its content directly to the output stream. If the portlet does render directly to the output stream, the returned Reader will be null. Otherwise, the portlet will not render its content directly, and it will return a non-null Reader containing its content.

Throws:

PortalException

getConfigurableInstancePropertyFilter

public IPortletPropertyListFilter getConfigurableInstancePropertyFilter(IContext ctx,
                                                                        IURI portlet)
                                                                 throws PortalException

Filter for determining the wireable properties of a portlet on a per-user, per-portlet basis. Properties from which the specified user can wire are those that the filter determines aren't hidden; properties to which the specified user can wire are those that the filter determines aren't hidden and aren't read-only.

Throws:

PortalException

getConfigurableInstancePropertyFilter

public IPortletPropertyListFilter getConfigurableInstancePropertyFilter(IContext ctx,
                                                                        IURI portlet,
                                                                        boolean checkAccess)
                                                                 throws PortalException

Filter for determining the wireable properties of a portlet on a per-user, per-portlet basis. Properties from which the specified user can wire are those that the filter determines aren't hidden; properties to which the specified user can wire are those that the filter determines aren't hidden and aren't read-only.

Throws:

PortalException

getWireablePropertyFilter

public IPortletPropertyListFilter getWireablePropertyFilter(IContext ctx,
                                                            IURI portlet)
                                                     throws PortalException

Filter for determining the wireable properties of a portlet on a per-user, per-portlet basis. Properties from which the specified user can wire are those that the filter determines aren't hidden; properties to which the specified user can wire are those that the filter determines aren't hidden and aren't read-only.

Throws:

PortalException

getWireablePropertyFilter

public IPortletPropertyListFilter getWireablePropertyFilter(IContext ctx,
                                                            IURI portlet,
                                                            boolean checkAccess)
                                                     throws PortalException

Filter for determining the wireable properties of a portlet on a per-user, per-portlet basis. Properties from which the specified user can wire are those that the filter determines aren't hidden; properties to which the specified user can wire are those that the filter determines aren't hidden and aren't read-only.

Throws:

PortalException

getWiringSourceGroupsAndProperties

public List<Object> getWiringSourceGroupsAndProperties(IContext ctx,
                                                       IURI portlet)
                                                throws PortalException

Returns a list of IPortletPropertyInfos from which the specified user can wire. Before each group of IPortletPropertyInfos in the returned list is a IPortletPropertyGroupInfo that contains information about the following IPortletPropertyInfo's group. Empty groups are omitted.

An example of the result list follows:

1. IPortletPropertyGroupInfo: Group 1
2. IPortletPropertyInfo: Property A
3. IPortletPropertyInfo: Property B
4. IPortletPropertyGroupInfo: Group 2
5. IPortletPropertyInfo: Property C

Throws:

PortalException

getWiringDestinationGroupsAndProperties

public List<Object> getWiringDestinationGroupsAndProperties(IContext ctx,
                                                            IURI portlet)
                                                     throws PortalException

Returns a list of IPortletPropertyInfos to which the specified user can wire. Before each group of IPortletPropertyInfos in the returned list is a IPortletPropertyGroupInfo that contains information about the following IPortletPropertyInfo's group. Empty groups are omitted.

An example of the result list follows:

1. IPortletPropertyGroupInfo: Group 1
2. IPortletPropertyInfo: Property A
3. IPortletPropertyInfo: Property B
4. IPortletPropertyGroupInfo: Group 2
5. IPortletPropertyInfo: Property C

Throws:

PortalException

getPersonalProfileId

protected IThingID getPersonalProfileId()
                                 throws PortalException

Throws:

PortalException

getPersonalProfileBean

public IPortletBean getPersonalProfileBean(IContext ctx)
                                    throws PortalException

Gets the bean for the personal profile portlet. Returns null if no personal profile portlet is installed in the portal.

Throws:

PortalException

getErrorBean

public IPortletBean getErrorBean(IContext ctx)
                          throws PortalException

Gets the error portlet bean.

Throws:

PortalException

getPseudoId

public IURI getPseudoId(IContext ctx,
                        IURI target)
                 throws PortalException

Gets the pseudo portlet id for the specified item.

Throws:

PortalException

getPseudoBean

public IPortletBean getPseudoBean(IContext ctx,
                                  IURI target)
                           throws PortalException

Gets the pseudo portlet bean for the specified item.

Throws:

PortalException

getTitlebar

public IPortletBean getTitlebar(IContext ctx,
                                PortletData portlet)
                         throws PortalException

Throws:

PortalException

getPage

public PageData getPage()

setPage

public void setPage(PageData page)