|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BulkPortletManager
Manages bulk portlet operations on producers.
Nested Class Summary | |
---|---|
static class |
BulkPortletManager.Factory
A BulkPortletManager factory. |
Method Summary | |
---|---|
ExportPortletsResponse |
exportPortlets(String producerHandle,
List<PortletInstanceId> portlets,
boolean exportByValueRequired,
String webappName)
Performs a bulk portlet export operation, exporting portlet state and preference information from the specified producer's portlet instances in a form which may be subsequently imported to the producer. |
ExportPortletsResponse |
exportPortlets(String producerHandle,
List<PortletInstanceId> portlets,
boolean exportByValueRequired,
String webappName,
javax.servlet.http.HttpServletRequest httpRequest,
javax.servlet.http.HttpServletResponse httpResponse,
javax.servlet.ServletContext servletContext)
Performs a bulk portlet export operation, exporting portlet state and preference information from the specified producer's portlet instances in a form which may be subsequently imported to the producer. |
int |
getExportBatchSize(List<PortletInstanceId> portlets)
Determines the batch size for a bulk portlet export operation- the number of portlets which would be exported from the producer given the arguments. |
ImportPortletsResponse |
importPortlets(String producerHandle,
ExportedPortlets exportedPortlets,
Map<PortletInstanceId,String> receivingProxyPortlets,
String webappName)
Performs a bulk portlet import operation, importing portlet state and preference information from previously exported portlets. |
ImportPortletsResponseImpl |
importPortlets(String producerHandle,
ExportedPortlets exportedPortlets,
Map<PortletInstanceId,String> receivingProxyPortlets,
String webappName,
javax.servlet.http.HttpServletRequest httpRequest,
javax.servlet.http.HttpServletResponse httpResponse,
javax.servlet.ServletContext servletContext)
Performs a bulk portlet import operation, importing portlet state and preference information from previously exported portlets. |
boolean |
isExportSupported(String producerHandle,
String webappName,
javax.servlet.http.HttpServletRequest httpRequest,
javax.servlet.http.HttpServletResponse httpResponse,
javax.servlet.ServletContext servletContext)
Test whether the producer supports the export operation |
boolean |
isImportSupported(String producerHandle,
String webappName,
javax.servlet.http.HttpServletRequest httpRequest,
javax.servlet.http.HttpServletResponse httpResponse,
javax.servlet.ServletContext servletContext)
Test whether the producer supports the import operation |
void |
releaseExport(String producerHandle,
ExportedPortlets export)
Indicates to the Producer that it no longer needs to maintain any stored artifacts relative to a particular export, if the producer stored any such artifacts. |
Method Detail |
---|
int getExportBatchSize(List<PortletInstanceId> portlets) throws BulkPortletManagerException
BulkPortletManagerException
ExportPortletsResponse exportPortlets(String producerHandle, List<PortletInstanceId> portlets, boolean exportByValueRequired, String webappName, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, javax.servlet.ServletContext servletContext) throws BulkPortletManagerException
producerHandle
- the handle for the producer to export from.portlets
- the list of portlets (associated with proxy portlets)
to export. This list should not be larger than the producer's
recommended export batch size or a ExportBatchTooLargeException
may be thrown. To determine the maximum recommended export batch
size for a producer, get the producer's service description from
the com.bea.wsrp.consumer.management.producer.ProducerManager
getProducerServiceDescription() method and then determine the
maximum batch size from
IServiceDescription.getRecommendedExportBatchSize()exportByValueRequired
- if true
, the producer
is required to export the portlets by value (as opposed to
keeping the exported portlets on the producer somehow).webappName
- the name of the web apphttpRequest
- the HttpServletRequesthttpResponse
- the HttpServletResponseservletContext
- the servlet context.
BulkPortletManagerException
ImportPortletsResponseImpl importPortlets(String producerHandle, ExportedPortlets exportedPortlets, Map<PortletInstanceId,String> receivingProxyPortlets, String webappName, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, javax.servlet.ServletContext servletContext) throws IllegalArgumentException, BulkPortletManagerException
producerHandle
- the handle for the producer to import to.exportedPortlets
- the previously-exported portlets to import.receivingProxyPortlets
- a map of portlet instance IDs (as keys)
of the proxy portlets to "receive" the imported portlet instances,
where the String value is the portlet handle the portlet was
exported under (in the ExportedPortlets object).
As the portlets are imported, the proxy portlets (specified
as the key in this map) will have their portlet handles updated
to the newly created imported portlets' portlet handles.
In addition, the proxy portlets' producer handles and
producerOfferedPortlet state will be updated as appropriate.
If the map is null or empty, no proxy portlets will be updated
but the import operation still proceeds.
Portlets which fail to import properly will NOT be assigned to
proxy portlets-- only portlets which import successfully will be
mapped.
If the map contains portlet handles for portlets which do not
exist in the ExportedPortlets object, an IllegalArgumentException is
thrown.webappName
- the name of the web apphttpRequest
- the HttpServletRequesthttpResponse
- the HttpServletResponseservletContext
- the servlet context.
IllegalArgumentException
- if the map of receiving proxy
portlets contains any portlet handles not contained in the
exported portlets.
BulkPortletManagerException
void releaseExport(String producerHandle, ExportedPortlets export)
producerHandle
- the handle for the producer that was exported
from.export
- the previously-exported portlets to release.ExportPortletsResponse exportPortlets(String producerHandle, List<PortletInstanceId> portlets, boolean exportByValueRequired, String webappName) throws BulkPortletManagerException
producerHandle
- the handle for the producer to export from.portlets
- the list of portlets (associated with proxy portlets)
to export. This list should not be larger than the producer's
recommended export batch size or a ExportBatchTooLargeException
may be thrown. To determine the maximum recommended export batch
size for a producer, get the producer's service description from
the com.bea.wsrp.consumer.management.producer.ProducerManager
getProducerServiceDescription() method and then determine the
maximum batch size from
IServiceDescription.getRecommendedExportBatchSize()exportByValueRequired
- if true
, the producer
is required to export the portlets by value (as opposed to
keeping the exported portlets on the producer somehow).webappName
- the name of the web app
BulkPortletManagerException
ImportPortletsResponse importPortlets(String producerHandle, ExportedPortlets exportedPortlets, Map<PortletInstanceId,String> receivingProxyPortlets, String webappName) throws IllegalArgumentException, BulkPortletManagerException
producerHandle
- the handle for the producer to import to.exportedPortlets
- the previously-exported portlets to import.receivingProxyPortlets
- a map of portlet instance IDs (as keys)
of the proxy portlets to "receive" the imported portlet instances,
where the String value is the portlet handle the portlet was
exported under (in the ExportedPortlets object).
As the portlets are imported, the proxy portlets (specified
as the key in this map) will have their portlet handles updated
to the newly created imported portlets' portlet handles.
In addition, the proxy portlets' producer handles and
producerOfferedPortlet state will be updated as appropriate.
If the map is null or empty, no proxy portlets will be updated
but the import operation still proceeds.
Portlets which fail to import properly will NOT be assigned to
proxy portlets-- only portlets which import successfully will be
mapped.
If the map contains portlet handles for portlets which do not
exist in the ExportedPortlets object, an IllegalArgumentException is
thrown.webappName
- the name of the web app
IllegalArgumentException
- if the map of receiving proxy
portlets contains any portlet handles not contained in the
exported portlets.
BulkPortletManagerException
boolean isExportSupported(String producerHandle, String webappName, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, javax.servlet.ServletContext servletContext) throws BulkPortletManagerException
producerHandle
- the handle for the producer to test.webappName
- the name of the web applicationhttpRequest
- the HttpServletRequesthttpResponse
- the HttpServletResponseservletContext
- the servlet context.
BulkPortletManagerException
- if support cannot be determinedboolean isImportSupported(String producerHandle, String webappName, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, javax.servlet.ServletContext servletContext) throws BulkPortletManagerException
producerHandle
- the handle for the producer to test.webappName
- the name of the web applicationhttpRequest
- the HttpServletRequesthttpResponse
- the HttpServletResponseservletContext
- the servlet context.
BulkPortletManagerException
- if support cannot be determined
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |