Specifies an interface for managing producers for a given consumer.
Nested Class Summary |
public static class | ProducerManager.Factory
A ProducerManager factory. |
Method Summary |
public |
|
public |
|
public void |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public void |
|
public void |
|
public void |
|
Method Detail |
publicProducerInfo
addProducer(String
wsdlUrl,DefinitionsDocument
wsdl,ServiceDescription
serviceDescription,String
producerHandle,String
description,String
vendorName,String
webappName,HttpServletRequest
request)
throwsProducerManagerException
Adds a producer
* * @param wsdlUrl WSDL URL * @param wsdl WSDL document * @param serviceDescription service description * @param producerHandle producer handle * @param description description * @param vendorName vendor * @param webappName web app * @param request HTTP request * @return producer info * @throws ProducerManagerException thrown due to an error performing the * operationProducerManagerException
publicProducerInfo
addProducer(ProducerInfo
producerInfo,String
webappName)
throwsProducerManagerException
Adds a producer
* * @param producerInfo producer info * @param webappName web app * @return producer info * @throws ProducerManagerException thrown due to an error performing the * operationProducerManagerException
public void deregisterProducer(String
producerHandle,String
webappName,HttpServletRequest
httpRequest)
throwsIllegalArgumentException
,RegistrationNotSupportedException
,ProducerManagerException
Deregisters with the given producer.
* * @param producerHandle * @param webappName * @throws IllegalArgumentException if the given producer handle is invalid * @throws RegistrationNotSupportedException * @throws ProducerManagerExceptionIllegalArgumentException
RegistrationNotSupportedException
ProducerManagerException
publicReturns the producer, given its handle and the web app. * * @return producer * @throws ProducerManagerException thrown due to an error performing the * operationProducerInfo
getProducer(String
producerHandle,String
webappName)
throwsProducerManagerException
ProducerManagerException
publicReturns an array of currently added producers. * * @return an array of producers * @throws ProducerManagerException thrown due to an error performing the * operationProducerInfo
[] getProducers(String
webappName)
throwsProducerManagerException
ProducerManagerException
publicReturns the service description for a specified producer WSDL URL. * * @param producerHandle producer handle * @return service description * @throws ProducerManagerException thrown due to an error performing the * operation * @throws IllegalArgumentException thrown if the given producer handle is * invalidServiceDescription
getServiceDescription(String
producerHandle,String
webappName)
throwsProducerManagerException
ProducerManagerException
publicModifies a current producer's registration. * * @param producerHandle producer handle * @param registrationProperties new registration properties * @throws IllegalArgumentException if the given producer handle is invalid * @throws RegistrationNotSupportedException thrown if the given producer does not * support registration * @throws ProducerManagerException thrown due to an error performing the * operationString
modifyProducerRegistration(String
producerHandle,String
webappName,Map
registrationProperties,HttpServletRequest
httpRequest)
throwsIllegalArgumentException
,RegistrationNotSupportedException
,ProducerManagerException
IllegalArgumentException
RegistrationNotSupportedException
ProducerManagerException
publicString
registerProducer(String
producerHandle,String
webappName,Map
registrationProperties,HttpServletRequest
httpRequest)
throwsIllegalArgumentException
,RegistrationNotSupportedException
,ProducerManagerException
Registers this consumer with a producer.
* * @param producerHandle producer handle * @param registrationProperties registration properties * @return the generated registration handle * @throws IllegalArgumentException if the given producer handle is invalid * @throws RegistrationNotSupportedException thrown if the given producer does not * support registration * @throws ProducerManagerException thrown due to an error performing the * operationIllegalArgumentException
RegistrationNotSupportedException
ProducerManagerException
public void removeProducer(String
producerHandle,String
webappName)
throwsIllegalArgumentException
,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
.
IllegalArgumentException
ProducerInUseException
ProducerManagerException
public void removeProducerCascade(String
producerHandle,String
webappName,HttpServletRequest
httpRequest)
throwsIllegalArgumentException
,ProducerManagerException
Removes a producer, first removing any added portlets for the producer.
* * @param producerHandle The handle for the producer being removed * @param webappName the webapp name * @param httpRequest HttpServletRequest * @throws ProducerManagerException thrown due to an error performing the * operation * @throws IllegalArgumentException if the given producer handle is invalidIllegalArgumentException
ProducerManagerException
public void updateProducer(ProducerInfo
producer,String
webappName)
throwsProducerManagerException
Updates the given producer
* * @param producer * @param webappName * @throws ProducerManagerExceptionProducerManagerException