|
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 ProducerManager
Specifies an interface for managing producers for a given consumer.
Nested Class Summary | |
---|---|
static class |
ProducerManager.Factory
A ProducerManager factory. |
Method Summary | |
---|---|
com.bea.wsrp.config.ProducerInfo |
addAndRegisterProducer(com.bea.wsrp.config.ProducerRegistrationInfo registrationInformation,
String webappName,
javax.servlet.http.HttpServletRequest httpRequest,
javax.servlet.http.HttpServletResponse httpResponse,
javax.servlet.ServletContext servletContext)
Adds or updates a producer using the information supplied, and if the producer requires registration, registration is performed or updated. |
com.bea.wsrp.config.ProducerInfo |
addProducer(com.bea.wsrp.config.ProducerInfo producerInfo,
String webappName)
Adds a producer |
com.bea.wsrp.config.ProducerInfo |
addProducer(String wsdlUrl,
org.xmlsoap.schemas.wsdl.DefinitionsDocument wsdl,
com.bea.wsrp.types.ServiceDescription serviceDescription,
String producerHandle,
String description,
String vendorName,
String webappName,
javax.servlet.http.HttpServletRequest request)
Deprecated This method will be removed in a future release. |
com.bea.wsrp.config.ProducerInfo |
addProducer(String wsdlUrl,
String producerHandle,
String description,
String vendorName,
String webappName,
boolean storeRegistrationProperties,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
javax.servlet.ServletContext context)
Adds a producer |
com.bea.wsrp.config.ProducerInfo |
addProducer(String wsdlUrl,
String producerHandle,
String description,
String vendorName,
String webappName,
javax.servlet.http.HttpServletRequest request)
Deprecated This method will be removed in a future release. |
void |
deregisterProducer(String producerHandle,
String webappName,
javax.servlet.http.HttpServletRequest httpRequest)
Deprecated |
void |
deregisterProducer(String producerHandle,
String webappName,
javax.servlet.http.HttpServletRequest httpRequest,
javax.servlet.http.HttpServletResponse httpResponse,
javax.servlet.ServletContext servletContext)
Deregisters with the given producer. |
void |
disableProducer(String producerHandle,
String webappName,
javax.servlet.http.HttpServletRequest httpRequest)
Temporarily disables a producer. |
void |
enableProducer(String producerHandle,
String webappName,
javax.servlet.http.HttpServletRequest httpRequest)
Enables a producer which had been temporarily disabled. |
IPortletDescription |
getPortletDescription(String producerHandle,
String webappName,
String portletHandle)
Get a portlet's description |
IPortletDescription |
getPortletDescription(String producerHandle,
String webappName,
String portletHandle,
byte[] portletState)
Get a portlet's description |
com.bea.wsrp.config.ProducerInfo |
getProducer(String producerHandle,
String webappName)
Returns the producer, given its handle and the web app. |
com.bea.wsrp.config.ProducerRegistrationInfo |
getProducerRegistrationInformation(String producerHandle,
String webappName,
javax.servlet.http.HttpServletRequest httpRequest,
javax.servlet.http.HttpServletResponse httpResponse,
javax.servlet.ServletContext servletContext)
Retrieves the current state of this consumers' registration with the specified producer. |
SortableFilterablePagedResult<com.bea.wsrp.config.ProducerInfo> |
getProducers(javax.servlet.http.HttpServletRequest httpRequest,
WebAppSearchCriteria searchCriteria,
int pageSize)
Returns a paged set of currently added producers. |
com.bea.wsrp.config.ProducerInfo[] |
getProducers(String webappName)
Returns an array of currently added producers. |
com.bea.wsrp.config.ProducerInfo[] |
getProducersByWsdl(String wsdlUrl,
String webappName)
Returns all producers that point to the given WSDL URL. |
IServiceDescription |
getProducerServiceDescription(String wsdlUrl,
IRegistrationContext registrationContext,
String producerHandle,
javax.servlet.http.HttpServletRequest httpRequest,
javax.servlet.http.HttpServletResponse httpResponse,
javax.servlet.ServletContext servletContext)
Returns the service description for a producer, given its WSDL URL. |
IServiceDescription |
getProducerServiceDescription(String producerHandle,
String webappName,
javax.servlet.http.HttpServletRequest httpRequest,
javax.servlet.http.HttpServletResponse httpResponse,
javax.servlet.ServletContext servletContext)
Returns the service description for a specified producer. |
IServiceDescription |
getProducerServiceDescription(String producerHandle,
String webappName,
List<String> portletHandles,
javax.servlet.http.HttpServletRequest httpRequest,
javax.servlet.http.HttpServletResponse httpResponse,
javax.servlet.ServletContext servletContext)
Returns the service description for a specified producer, containing only the specified portlet handles. |
com.bea.wsrp.types.ServiceDescription |
getServiceDescription(String producerHandle,
String webappName)
Deprecated This method will be removed in a future version. Use getProducerServiceDescription. |
String |
modifyProducerRegistration(String producerHandle,
String webappName,
Map<String,Object> registrationProperties,
javax.servlet.http.HttpServletRequest httpRequest,
javax.servlet.http.HttpServletResponse httpResponse,
javax.servlet.ServletContext servletContext)
Modifies a current producer's registration. |
String |
modifyProducerRegistration(String producerHandle,
String webappName,
Map registrationProperties,
javax.servlet.http.HttpServletRequest httpRequest)
Deprecated |
String |
registerProducer(String producerHandle,
String webappName,
Map<String,Object> registrationProperties,
javax.servlet.http.HttpServletRequest httpRequest,
javax.servlet.http.HttpServletResponse httpResponse,
javax.servlet.ServletContext servletContext)
Registers this consumer with a producer. |
String |
registerProducer(String producerHandle,
String webappName,
Map registrationProperties,
javax.servlet.http.HttpServletRequest httpRequest)
Deprecated |
void |
removeProducer(String producerHandle,
String webappName)
Deprecated |
void |
removeProducer(String producerHandle,
String webappName,
javax.servlet.http.HttpServletRequest httpRequest,
javax.servlet.http.HttpServletResponse httpResponse,
javax.servlet.ServletContext servletContext)
Removes a producer. |
void |
removeProducerCascade(String producerHandle,
String webappName,
boolean disconnected,
javax.servlet.http.HttpServletRequest httpRequest,
javax.servlet.http.HttpServletResponse httpResponse,
javax.servlet.ServletContext servletContext)
Removes a producer, first removing any added portlets for the producer. |
void |
removeProducerCascade(String producerHandle,
String webappName,
javax.servlet.http.HttpServletRequest httpRequest)
Deprecated |
void |
removeProducerCascade(String producerHandle,
String webappName,
javax.servlet.http.HttpServletRequest httpRequest,
javax.servlet.http.HttpServletResponse httpResponse,
javax.servlet.ServletContext servletContext)
Removes a producer, first removing any added portlets for the producer. |
void |
updateProducer(com.bea.wsrp.config.ProducerInfo producer,
String webappName)
Updates the given producer |
Methods inherited from interface com.bea.wsrp.client.ProducerAgent |
---|
deregister, getPortletDescription, getPortletDescription, getServiceDescription, modifyRegistration, register |
Method Detail |
---|
@Deprecated com.bea.wsrp.config.ProducerInfo addProducer(String wsdlUrl, org.xmlsoap.schemas.wsdl.DefinitionsDocument wsdl, com.bea.wsrp.types.ServiceDescription serviceDescription, String producerHandle, String description, String vendorName, String webappName, javax.servlet.http.HttpServletRequest request) throws ProducerManagerException, ProducerAlreadyExistsException
Adds a producer
This method sets the ProducerInfo storeRegistrationProperties flag totrue
.
wsdlUrl
- WSDL URLwsdl
- WSDL documentserviceDescription
- service descriptionproducerHandle
- producer handledescription
- descriptionvendorName
- vendorwebappName
- web apprequest
- HTTP request
ProducerAlreadyExistsException
- thrown if the given producer data already exists on this consumer
ProducerManagerException
- thrown due to an error performing the
operationaddProducer(String, String, String, String, String, boolean, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.ServletContext)
@Deprecated com.bea.wsrp.config.ProducerInfo addProducer(String wsdlUrl, String producerHandle, String description, String vendorName, String webappName, javax.servlet.http.HttpServletRequest request) throws ProducerManagerException, ProducerAlreadyExistsException
Adds a producer
This method sets the ProducerInfo storeRegistrationProperties flag totrue
.
wsdlUrl
- WSDL URLproducerHandle
- producer handledescription
- descriptionvendorName
- vendorwebappName
- web app to which this producer is being addedrequest
- HTTP request
ProducerAlreadyExistsException
- thrown if the given producer data already exists on this consumer
ProducerManagerException
- thrown due to an error performing the
operationaddProducer(String, String, String, String, String, boolean, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.ServletContext)
com.bea.wsrp.config.ProducerInfo addProducer(String wsdlUrl, String producerHandle, String description, String vendorName, String webappName, boolean storeRegistrationProperties, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletContext context) throws ProducerManagerException, ProducerAlreadyExistsException
Adds a producer
wsdlUrl
- WSDL URLproducerHandle
- producer handledescription
- descriptionvendorName
- vendorwebappName
- web app to which this producer is being addedstoreRegistrationProperties
- if true
, registration properties
used with this producer will be stored on the consumer for later use.request
- HTTP requestcontext
- Servlet context
ProducerAlreadyExistsException
- thrown if the given producer data already exists on this consumer
ProducerManagerException
- thrown due to an error performing the operationcom.bea.wsrp.config.ProducerInfo addProducer(com.bea.wsrp.config.ProducerInfo producerInfo, String webappName) throws ProducerManagerException, ProducerAlreadyExistsException
Adds a producer
producerInfo
- producer infowebappName
- web app
ProducerAlreadyExistsException
- thrown if the given producer data already exists on this consumer
ProducerManagerException
- thrown due to an error performing the operationcom.bea.wsrp.config.ProducerInfo[] getProducers(String webappName) throws ProducerManagerException
webappName
- webapp name
ProducerManagerException
- thrown due to an error performing the
operationSortableFilterablePagedResult<com.bea.wsrp.config.ProducerInfo> getProducers(javax.servlet.http.HttpServletRequest httpRequest, WebAppSearchCriteria searchCriteria, int pageSize) throws ProducerManagerException
httpRequest
- http requestpageSize
- page size
ProducerManagerException
- thrown due to an error performing the operation.com.bea.wsrp.config.ProducerInfo[] getProducersByWsdl(String wsdlUrl, String webappName) throws ProducerManagerException
Returns all producers that point to the given WSDL URL.
wsdlUrl
- webappName
-
ProducerManagerException
com.bea.wsrp.config.ProducerInfo getProducer(String producerHandle, String webappName) throws ProducerManagerException
ProducerManagerException
- thrown due to an error performing the
operationvoid updateProducer(com.bea.wsrp.config.ProducerInfo producer, String webappName) throws ProducerManagerException
Updates the given producer
producer
- webappName
-
ProducerManagerException
@Deprecated com.bea.wsrp.types.ServiceDescription getServiceDescription(String producerHandle, String webappName) throws ProducerManagerException
producerHandle
- producer handle
ProducerManagerException
- thrown due to an error performing the
operation
IllegalArgumentException
- thrown if the given producer handle is
invalidIServiceDescription getProducerServiceDescription(String producerHandle, String webappName, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, javax.servlet.ServletContext servletContext) throws ProducerManagerException
Returns the service description for a specified producer.
producerHandle
- webappName
- name of the consumerhttpRequest
- requesthttpResponse
- responseservletContext
- context
ProducerManagerException
IServiceDescription getProducerServiceDescription(String producerHandle, String webappName, List<String> portletHandles, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, javax.servlet.ServletContext servletContext) throws ProducerManagerException
Returns the service description for a specified producer, containing only the specified portlet handles. For WSRP v2 clients only.
producerHandle
- webappName
- name of the consumerportletHandles
- list of portlet handles to returnhttpRequest
- requesthttpResponse
- responseservletContext
- context
ProducerManagerException
IServiceDescription getProducerServiceDescription(String wsdlUrl, IRegistrationContext registrationContext, String producerHandle, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, javax.servlet.ServletContext servletContext) throws InvalidRegistrationException, OperationFailedException, IOException
Returns the service description for a producer, given its WSDL URL.
wsdlUrl
- registrationContext
- producerHandle
- httpRequest
- httpResponse
- servletContext
-
InvalidRegistrationException
OperationFailedException
IOException
@Deprecated String registerProducer(String producerHandle, String webappName, Map registrationProperties, javax.servlet.http.HttpServletRequest httpRequest) throws IllegalArgumentException, RegistrationNotSupportedException, ProducerAlreadyRegisteredException, ProducerManagerException
Registers this consumer with a producer.
producerHandle
- producer handleregistrationProperties
- registration properties
IllegalArgumentException
- if the given producer handle is invalid
RegistrationNotSupportedException
- thrown if the given producer does not
support registration
ProducerAlreadyRegisteredException
- throw if the given producer is already registered
ProducerManagerException
- thrown due to an error performing the
operationString registerProducer(String producerHandle, String webappName, Map<String,Object> registrationProperties, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, javax.servlet.ServletContext servletContext) throws IllegalArgumentException, RegistrationNotSupportedException, ProducerAlreadyRegisteredException, ProducerManagerException, com.bea.wsrp.config.ProducerUnavailableException
Registers this consumer with a producer.
producerHandle
- producer handlewebappName
- name of the consumerregistrationProperties
- registration propertieshttpRequest
- requesthttpResponse
- responseservletContext
- context
IllegalArgumentException
- if the given producer handle is invalid
RegistrationNotSupportedException
- thrown if the given producer does not
support registration
ProducerAlreadyRegisteredException
- throw if the given producer is already registered
ProducerManagerException
- thrown due to an error performing the
operation
com.bea.wsrp.config.ProducerUnavailableException
@Deprecated String modifyProducerRegistration(String producerHandle, String webappName, Map registrationProperties, javax.servlet.http.HttpServletRequest httpRequest) throws IllegalArgumentException, RegistrationNotSupportedException, ProducerManagerException
producerHandle
- producer handlewebappName
- name of the consumer webappregistrationProperties
- new registration propertieshttpRequest
- request
IllegalArgumentException
- if the given producer handle is invalid
RegistrationNotSupportedException
- thrown if the given producer does not
support registration
ProducerManagerException
- thrown due to an error performing the
operationString modifyProducerRegistration(String producerHandle, String webappName, Map<String,Object> registrationProperties, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, javax.servlet.ServletContext servletContext) throws IllegalArgumentException, RegistrationNotSupportedException, ProducerManagerException
producerHandle
- producer handlewebappName
- name of the consumer webappregistrationProperties
- new registration propertieshttpRequest
- requesthttpResponse
- responseservletContext
- context
IllegalArgumentException
- if the given producer handle is invalid
RegistrationNotSupportedException
- thrown if the given producer does not
support registration
ProducerManagerException
- thrown due to an error performing the
operation@Deprecated void deregisterProducer(String producerHandle, String webappName, javax.servlet.http.HttpServletRequest httpRequest) throws IllegalArgumentException, RegistrationNotSupportedException, ProducerManagerException
Deregisters with the given producer.
producerHandle
- webappName
-
IllegalArgumentException
- if the given producer handle is invalid
RegistrationNotSupportedException
ProducerManagerException
void deregisterProducer(String producerHandle, String webappName, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, javax.servlet.ServletContext servletContext) throws IllegalArgumentException, RegistrationNotSupportedException, ProducerManagerException
Deregisters with the given producer.
producerHandle
- webappName
-
IllegalArgumentException
- if the given producer handle is invalid
RegistrationNotSupportedException
ProducerManagerException
@Deprecated void removeProducer(String producerHandle, String webappName) throws IllegalArgumentException, com.bea.wsrp.config.ProducerInUseException, ProducerManagerException
Removes a producer. If the producer still has added portlets, an exception is thrown. The producer being
removed must be known by the RemotePortletManager
.
producerHandle
- The handle for the producer being removedwebappName
- the webapp name
ProducerManagerException
- thrown due to an error performing the
operation
com.bea.wsrp.config.ProducerInUseException
- thrown if the given producer can not be
removed
IllegalArgumentException
- if the given producer handle is invalidvoid removeProducer(String producerHandle, String webappName, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, javax.servlet.ServletContext servletContext) throws IllegalArgumentException, com.bea.wsrp.config.ProducerInUseException, ProducerManagerException
Removes a producer. If the producer still has added portlets, an exception is thrown. The producer being
removed must be known by the RemotePortletManager
.
producerHandle
- The handle for the producer being removedwebappName
- the webapp name
ProducerManagerException
- thrown due to an error performing the
operation
com.bea.wsrp.config.ProducerInUseException
- thrown if the given producer can not be
removed
IllegalArgumentException
- if the given producer handle is invalid@Deprecated void removeProducerCascade(String producerHandle, String webappName, javax.servlet.http.HttpServletRequest httpRequest) throws IllegalArgumentException, ProducerManagerException
Removes a producer, first removing any added portlets for the producer.
producerHandle
- The handle for the producer being removedwebappName
- the webapp namehttpRequest
- HttpServletRequest
ProducerManagerException
- thrown due to an error performing the
operation
IllegalArgumentException
- if the given producer handle is invalidvoid removeProducerCascade(String producerHandle, String webappName, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, javax.servlet.ServletContext servletContext) throws IllegalArgumentException, ProducerManagerException
Removes a producer, first removing any added portlets for the producer.
producerHandle
- The handle for the producer being removedwebappName
- the webapp namehttpRequest
- HttpServletRequest
ProducerManagerException
- thrown due to an error performing the
operation
IllegalArgumentException
- if the given producer handle is invalidvoid removeProducerCascade(String producerHandle, String webappName, boolean disconnected, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, javax.servlet.ServletContext servletContext) throws IllegalArgumentException, ProducerManagerException
Removes a producer, first removing any added portlets for the producer.
producerHandle
- The handle for the producer being removedwebappName
- the webapp namedisconnected
- when this is set to true, this API will not attempt to talk to the producer for tasks such
as deregistrationhttpRequest
- HttpServletRequest
ProducerManagerException
- thrown due to an error performing the
operation
IllegalArgumentException
- if the given producer handle is invalidvoid disableProducer(String producerHandle, String webappName, javax.servlet.http.HttpServletRequest httpRequest) throws IllegalArgumentException, ProducerManagerException
Temporarily disables a producer.
While the producer is disabled, no attempts to retrieve remote portlets from it will be made by this consumer.
producerHandle
- The handle for the producer being disabled.webappName
- the webapp namehttpRequest
- HttpServletRequest
ProducerManagerException
- thrown due to an error performing the
operation
IllegalArgumentException
- if the given producer handle is invalidvoid enableProducer(String producerHandle, String webappName, javax.servlet.http.HttpServletRequest httpRequest) throws IllegalArgumentException, ProducerManagerException
Enables a producer which had been temporarily disabled.
producerHandle
- The handle for the producer being enabled.webappName
- the webapp namehttpRequest
- HttpServletRequest
ProducerManagerException
- thrown due to an error performing the
operation
IllegalArgumentException
- if the given producer handle is invalidIPortletDescription getPortletDescription(String producerHandle, String webappName, String portletHandle) throws ProducerManagerException
producerHandle
- The handle for the producer to get the portlet
description fromwebappName
- the webapp nameportletHandle
- portlet's handle
ProducerManagerException
- thrown due to an error performing the
operationIPortletDescription getPortletDescription(String producerHandle, String webappName, String portletHandle, byte[] portletState) throws ProducerManagerException
producerHandle
- The handle for the producer to get the portlet
description fromwebappName
- the webapp nameportletHandle
- portlet's handleportletState
- The portlet's state (may be null)
ProducerManagerException
- thrown due to an error performing the
operationcom.bea.wsrp.config.ProducerRegistrationInfo getProducerRegistrationInformation(String producerHandle, String webappName, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, javax.servlet.ServletContext servletContext) throws IllegalArgumentException, ProducerManagerException
null
map of registration properties, and the
registration property source will be indicated as noSource
.
If the specified producer supports retrieval of registration properties,
the current set of registration properties is retrieved from the producer.
Otherwise, if the consumer is storing the registration properties locally,
that set of registration properties is returned. If neither source is
available, the registration properties are unknown and will be set as a
null
map.
producerHandle
- the handle for the producer to retrieve
registration information from.webappName
- the webapp name.httpRequest
- the HttpServletRequest.httpResponse
- the HttpServletResponse.servletContext
- the ServletContext.
IllegalArgumentException
- if any arguments are invalid.
ProducerManagerException
- if an unexpected error occurred.com.bea.wsrp.config.ProducerInfo addAndRegisterProducer(com.bea.wsrp.config.ProducerRegistrationInfo registrationInformation, String webappName, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, javax.servlet.ServletContext servletContext) throws IllegalArgumentException, ProducerManagerException, RegistrationNotSupportedException, com.bea.wsrp.config.ProducerUnavailableException
false
,
registration is not performed or updated.
If the ProducerInfo requiresRegistration flag is true
and the consumer is not registered with the producer, registration is
performed.
If the ProducerInfo requiresRegistration flag is true
and the consumer is registered with the producer, registration is
updated.
If the registration properties map in the ProducerRegistrationInfo object
is null, registration will be performed / updated with no registration
properties.
The producer registration handle and registration state supplied in the
ProducerRegistrationInfo's ProducerInfo object are ignored. If these
fields are not to be ignored, use addProducer() or updateProducer() instead.
registrationInformation
- the ProducerRegistrationInfo to use,
cannot be null
.webappName
- the webapp name, cannot be null
httpRequest
- the HttpServletRequest.httpResponse
- the HttpServletResponse.servletContext
- the ServletContext.
IllegalArgumentException
- if any arguments are invalid.
ProducerManagerException
- if an unexpected error occurred.
RegistrationNotSupportedException
- if registration is attempted and
the given producer does not support registration
com.bea.wsrp.config.ProducerUnavailableException
- if the producer is not available to register with.
|
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 |