|
© 2005 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Manages proxy portlets for one or more producers.
Nested Class Summary | |
static class |
ProxyPortletManager.Factory
A ProxyPortletManager factory. |
Method Summary | |
void |
clearDestroyErrors(int[] proxyPortletIds)
Clears the delete errors associated with proxy portlets thus making them deletable. |
int |
createProxyPortlet(String producerHandle,
PortletDescription portletDescription,
Locale locale,
HttpServletRequest httpRequest,
String webAppName)
Creates a proxy portlet. |
byte[] |
getPortletState(int portletInstanceId)
Retrieves the portlet state byte array. |
ProxyPortletInfo[] |
getProxyPortletsWithDestroyErrors(String webAppName,
String producerHandle)
Returns PortletDescription s for proxy portlets
that had errors on delete for a given producer. |
Map |
getRemovableProxyPortlets(String webAppName)
Returns a map of ProxyPortletInfo arrays that are removable keyed by Integer producer ids. |
int[] |
listAddedProxyPortlets(String webAppName,
String producerHandle)
Lists all portlets that have been added for the specified producer. |
int[] |
listCustomizedProxyPortlets(String webAppName,
String producerHandle)
Lists all portlets that have been customized for the specified producer. |
int |
removeProxyPortlets(String webAppName,
int[] proxyPortletIds)
Removes proxy portlets marked for delete for a given webApp. |
int |
removeProxyPortlets(String webAppName,
int producerId,
boolean removePrimaryInstances)
Deletes ProxyPortlets for a given producer and web app. |
void |
setDestroyErrors(Map errorCauses)
Sets delete error causes on a set of proxy portlets Note: This method will fail silently for proxy portlets that don't exist. |
int |
updateProxyPortlet(HttpServletRequest httpRequest,
String webAppName,
String portalPath,
String desktopPath,
int portletInstanceId,
String portletHandle,
byte stateChangeFlag,
byte[] portletState,
boolean ensureSuccessor)
Updates specific attributes of a proxy portlet. |
Method Detail |
public void clearDestroyErrors(int[] proxyPortletIds) throws IllegalArgumentException, ProxyPortletManagerException
proxyPortletIds
- unique IDs for proxy portlets under
consideration
IllegalArgumentException
- thrown when input arguments are
not valid
ProxyPortletManagerException
- thrown when a general error
is encounteredpublic int createProxyPortlet(String producerHandle, PortletDescription portletDescription, Locale locale, HttpServletRequest httpRequest, String webAppName) throws IllegalArgumentException, ProxyPortletManagerException
Creates a proxy portlet.
producerHandle
- producer handleportletDescription
- portlet descriptionwebAppName
- name of the webapp in which proxy portlets reside
IllegalArgumentException
- thrown when input arguments are
not valid
ProxyPortletManagerException
- thrown when a general error
is encounteredpublic byte[] getPortletState(int portletInstanceId) throws IllegalArgumentException, ProxyPortletManagerException
portletInstanceId
- unique ID of proxy portlet
IllegalArgumentException
- thrown when input arguments are
not valid
ProxyPortletManagerException
- thrown when a general error
is encounteredpublic ProxyPortletInfo[] getProxyPortletsWithDestroyErrors(String webAppName, String producerHandle) throws IllegalArgumentException, ProxyPortletManagerException
PortletDescription
s for proxy portlets
that had errors on delete for a given producer.
webAppName
- web application nameproducerHandle
- consumer specific unique handle for a
producer
ProxyPortletInfo
representing proxy portlets
that encountered errors on destroy
IllegalArgumentException
- thrown when input arguments are
not valid
ProxyPortletManagerException
- thrown when a general error
is encounteredpublic Map getRemovableProxyPortlets(String webAppName) throws IllegalArgumentException, ProxyPortletManagerException
webAppName
- web application name
Map
of removable portlets keyed by producers
IllegalArgumentException
- thrown when input arguments are
not valid
ProxyPortletManagerException
- thrown when a general error
is encounteredpublic int[] listAddedProxyPortlets(String webAppName, String producerHandle) throws IllegalArgumentException, ProxyPortletManagerException
Lists all portlets that have been added for the specified producer. Returns an empty array if no portlets have been added.
webAppName
- webApp nameproducerHandle
- handle for the producer being queried
IllegalArgumentException
- thrown when input arguments are
not valid
ProxyPortletManagerException
- thrown when a general error
is encounteredpublic int[] listCustomizedProxyPortlets(String webAppName, String producerHandle) throws IllegalArgumentException, ProxyPortletManagerException
Lists all portlets that have been customized for the specified producer. Returns an empty array if no portlets have been customized.
webAppName
- web application nameproducerHandle
- handle for the producer being queried
IllegalArgumentException
- thrown when input arguments are
not valid
ProxyPortletManagerException
- thrown when a general error
is encounteredpublic int removeProxyPortlets(String webAppName, int[] proxyPortletIds) throws IllegalArgumentException, ProxyPortletManagerException
Removes proxy portlets marked for delete for a given webApp.
webAppName
- web application nameproxyPortletIds
- IDs for proxy portlets to be removed
IllegalArgumentException
- thrown when input arguments are
not valid
ProxyPortletManagerException
- thrown when a general error
is encounteredpublic int removeProxyPortlets(String webAppName, int producerId, boolean removePrimaryInstances) throws IllegalArgumentException, ProxyPortletManagerException
webAppName
- web application nameproducerId
- unique consumer specific producer IDremovePrimaryInstances
- Removes primary instances also if
set to true
IllegalArgumentException
- thrown when input arguments are
not valid
ProxyPortletManagerException
- thrown when a general error
is encounteredpublic void setDestroyErrors(Map errorCauses) throws IllegalArgumentException, ProxyPortletManagerException
errorCauses
- A map of string error causes keyed by Integer
proxyPortletIds
IllegalArgumentException
- thrown when input arguments are
not valid
ProxyPortletManagerException
- thrown when a general error
is encounteredpublic int updateProxyPortlet(HttpServletRequest httpRequest, String webAppName, String portalPath, String desktopPath, int portletInstanceId, String portletHandle, byte stateChangeFlag, byte[] portletState, boolean ensureSuccessor) throws IllegalArgumentException, ProxyPortletManagerException
httpRequest
- HttpServletRequestwebAppName
- web application nameportalPath
- portal path of desktop under considerationdesktopPath
- desktop path of desktop under considerationportletInstanceId
- portlet instance idportletHandle
- portlet handlestateChangeFlag
- portlet state change flagportletState
- portlet stateensureSuccessor
- boolean to specify if a successor needs to
be created
IllegalArgumentException
- thrown when input arguments are
not valid
ProxyPortletManagerException
- thrown when a general error
is encountered
|
© 2005 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |