public interface IPortletProvider extends IComponentProvider, IPortletWatch
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
KEY
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
|
exists, getComponent, getComponent, getComponent, getComponentQueryString, getComponents, getDefaultComponent, getLogger, initDeferredWebAppComponents, lookup, registerComponent, reloadComponent, reloadComponent, unregisterComponent, upgradeComponentDataFromBootstrapComponentData
getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider
init, shutdown
acquireURI, acquireURI
addPortletToWatch, getPortletWatch, startPortletWatch, stopPortletWatch
IPortletInfo getPortletInfo(IURI portletUri) throws PortalException
IThingID
that references either an installed portlet type or
a published portlet instance, or may be a portlet type name. ex: /portlet/wm_installserviceadmin_v1portletUri
- the uri for the portlet type or instanceIPortletInfo
for the portletPortalException
IPortletInfo getPortletInfo(File portletFile, File wmPortletFile) throws PortalException
portletFile
- the portlet.xml descriptor filewmPortletFile
- the wm-portlet.xml descriptor filePortalException
default IPortletInfo getPortletInfo(InputStream portleStream, InputStream wmPortletStream) throws PortalException
portletFile
- the portlet.xml descriptor filewmPortletFile
- the wm-portlet.xml descriptor filePortalException
IListView<IPortletInfo> listPortletInfos() throws PortalException
IPortletInfo
objectsPortalException
IPortletType getPortletType(IURI portletUri) throws PortalException
portletUri
- PortalException
IPortletBean getPortletBean(IURI portletUri, IThingID userId) throws PortalException
portletUri
- PortalException
String getResourceLocation(IURI portletUri, String resource, boolean isWebResource)
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').String getResourceLocation(IURI portletUri, String resource, boolean isWebResource, Locale locale)
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.