com.webmethods.portal.service.portlet

Interface IPortletProvider

All Superinterfaces:

IComponent, IComponentProvider, IInitializable, IPortletWatch, IURIResolver

public interface IPortletProvider
extends IComponentProvider, IPortletWatch

Field Summary

Fields inherited from interface com.webmethods.portal.system.IComponentProvider

ATTR_APP_NAME, ATTR_BEG_QUERY, ATTR_END_QUERY, ATTR_MID_QUERY, BIZPOLICY_MANAGER, CACHE_PROVIDER, COMMAND_PROVIDER, COMPONENTS_QUERY, INSTALL_PROVIDER, MECH_PROVIDER, METACONTEXT_PROVIDER, PHASE_PROVIDER, POLICY_PROVIDER, SEARCH_PROVIDER

Fields inherited from interface com.webmethods.portal.service.portlet.IPortletWatch

KEY

Method Summary

Modifier and Type	Method and Description
IPortletBean	getPortletBean(IURI portletUri, IThingID userId) Returns an new instance of portlet bean for specified portlet uri, loads its persisted properties
IPortletInfo	getPortletInfo(File portletFile, File wmPortletFile) Returns portlet info loaded from a portlet descriptor file (widget.tldx)
default IPortletInfo	getPortletInfo(InputStream portleStream, InputStream wmPortletStream) Returns portlet info loaded from a portlet descriptor file (widget.tldx)
IPortletInfo	getPortletInfo(IURI portletUri) Returns portlet info for specified portlet uri.
IPortletType	getPortletType(IURI portletUri)
String	getResourceLocation(IURI portletUri, String resource, boolean isWebResource) Returns full path to specified resource for specified portlet.
String	getResourceLocation(IURI portletUri, String resource, boolean isWebResource, Locale locale) Returns full path to specified resource for specified portlet.
IListView<IPortletInfo>	listPortletInfos() Returns list of all portlet infos in the system

Methods inherited from interface com.webmethods.portal.system.IComponentProvider

exists, getComponent, getComponent, getComponent, getComponentQueryString, getComponents, getDefaultComponent, getLogger, initDeferredWebAppComponents, lookup, registerComponent, reloadComponent, reloadComponent, unregisterComponent, upgradeComponentDataFromBootstrapComponentData

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Methods inherited from interface com.webmethods.portal.system.IURIResolver

acquireURI, acquireURI

Methods inherited from interface com.webmethods.portal.service.portlet.IPortletWatch

addPortletToWatch, getPortletWatch, startPortletWatch, stopPortletWatch

Method Detail

getPortletInfo

IPortletInfo getPortletInfo(IURI portletUri)
                     throws PortalException

Returns portlet info for specified portlet uri. The portlet uri may be in a IThingID that references either an installed portlet type or a published portlet instance, or may be a portlet type name. ex: /portlet/wm_installserviceadmin_v1

Parameters:

portletUri - the uri for the portlet type or instance

Returns:

IPortletInfo for the portlet

Throws:

PortalException

getPortletInfo

IPortletInfo getPortletInfo(File portletFile,
                            File wmPortletFile)
                     throws PortalException

Returns portlet info loaded from a portlet descriptor file (widget.tldx)

Parameters:

portletFile - the portlet.xml descriptor file

wmPortletFile - the wm-portlet.xml descriptor file

Returns:

IPortletInfo for the portlet

Throws:

PortalException

getPortletInfo

default IPortletInfo getPortletInfo(InputStream portleStream,
                                    InputStream wmPortletStream)
                             throws PortalException

Returns portlet info loaded from a portlet descriptor file (widget.tldx)

Parameters:

portletFile - the portlet.xml descriptor file

wmPortletFile - the wm-portlet.xml descriptor file

Returns:

IPortletInfo for the portlet

Throws:

PortalException

listPortletInfos

IListView<IPortletInfo> listPortletInfos()
                                  throws PortalException

Returns list of all portlet infos in the system

Returns:

list of IPortletInfo objects

Throws:

PortalException

getPortletType

IPortletType getPortletType(IURI portletUri)
                     throws PortalException

Parameters:

portletUri -

Returns:

Throws:

PortalException

getPortletBean

IPortletBean getPortletBean(IURI portletUri,
                            IThingID userId)
                     throws PortalException

Returns an new instance of portlet bean for specified portlet uri, loads its persisted properties

Parameters:

portletUri -

Returns:

portlet bean with loaded properties

Throws:

PortalException

getResourceLocation

String getResourceLocation(IURI portletUri,
                           String resource,
                           boolean isWebResource)

Returns full path to specified resource for specified portlet.

Parameters:

portletUri - Portlet id.

resource - Resource path relative to the portlet base folder (ex: 'images/icon.gif' or 'page2.jsp').

isWebResource - If true, returns the web-addressable path to the resource; if false, returns the internal portal path (ex: true - '/portalcontext/ui/portlets/wm_sample/images/icon.gif' false - '/ui/portlets/wm_sample/page2.jsp').

Returns:

Full path to resource.

getResourceLocation

String getResourceLocation(IURI portletUri,
                           String resource,
                           boolean isWebResource,
                           Locale locale)

Returns full path to specified resource for specified portlet.

Parameters:

portletUri - Portlet id.

resource - Resource path relative to the portlet base folder (ex: 'images/icon.gif' or 'page2.jsp').

isWebResource - If true, returns the web-addressable path to the resource; if false, returns the internal portal path (ex: true - '/portalcontext/ui/NLS/ja/JP/portlets/wm_sample/images/icon.gif' false - '/ui/portlets/wm_sample/page2.jsp').

locale - Locale.

Returns:

Full path to resource.