org.ow2.petals.component.framework.api.notification
Interface NotificationBrokerController

public interface NotificationBrokerController

The controller of the Broker into the bus

Author:

Frederic Gardes

Method Summary

void	destroyRegistration() Destroy the registration of the publisher on the broker
String	getCurrentMessage() Get the current message for the consumer on the broker
NotificationConsumer	getNotificationConsumer() Get the notificationConsumer
NotificationProducer	getNotificationProducer() Get the notificationProducer
Transformer	getTransformer()
boolean	isBrokeredNotification(javax.jbi.messaging.MessageExchange messageExchange) Check if the JBI exchange is a brokered notification exchange
boolean	isInternalNotification(String address) Check if the address is the default cdk address
void	notify(Document document, String topic, com.ebmwebsourcing.wsstar.addressing.definition.api.EndpointReferenceType subscriptionReference) notify from the publisher to the broker
void	processRegisterPublisherResponse(com.ebmwebsourcing.wsstar.notification.definition.brokerednotification.api.RegisterPublisherResponse response) Persist publisher registration ref and notification consumer ref in notification context
void	registerPublisher() register the publisher on the broker
void	renew() Manage the renew on a subscription from the consumer
void	setNotificationBrokerReferenceAddress(String notificationBrokerReferenceAddress) Set the notificationBrokerReferenceAddress
void	setPublisherRegistrationManagerReferenceAddress(String publisherRegistrationManagerReferenceAddress) Set the publisherRegistrationManagerReferenceAddress
void	setSubscriptionManagerReferenceAddress(String subscriptionManagerReferenceAddress) Set the subscriptionManagerReferenceAddress
void	subscribe() subscribe the consumer on the broker
void	unsubscribe() unsubscribe the consumer on the broker

Method Detail

registerPublisher

void registerPublisher()
                       throws com.ebmwebsourcing.wsstar.notification.definition.utils.WSNotificationException,
                              javax.jbi.messaging.MessagingException,
                              PEtALSCDKException,
                              com.ebmwebsourcing.wsstar.addressing.definition.api.WSAddressingException,
                              com.ebmwebsourcing.wsstar.notification.extension.utils.WSNotificationExtensionException

register the publisher on the broker

Throws:

com.ebmwebsourcing.wsstar.notification.definition.utils.WSNotificationException

javax.jbi.messaging.MessagingException

PEtALSCDKException

com.ebmwebsourcing.wsstar.addressing.definition.api.WSAddressingException

com.ebmwebsourcing.wsstar.notification.extension.utils.WSNotificationExtensionException

processRegisterPublisherResponse

void processRegisterPublisherResponse(com.ebmwebsourcing.wsstar.notification.definition.brokerednotification.api.RegisterPublisherResponse response)
                                      throws PEtALSCDKException

Persist publisher registration ref and notification consumer ref in notification context

Parameters:

response -

Throws:

PEtALSCDKException

subscribe

void subscribe()
               throws com.ebmwebsourcing.wsstar.notification.definition.utils.WSNotificationException,
                      javax.jbi.messaging.MessagingException,
                      PEtALSCDKException,
                      com.ebmwebsourcing.wsstar.addressing.definition.api.WSAddressingException

subscribe the consumer on the broker

Throws:

com.ebmwebsourcing.wsstar.notification.definition.utils.WSNotificationException

javax.jbi.messaging.MessagingException

PEtALSCDKException

com.ebmwebsourcing.wsstar.addressing.definition.api.WSAddressingException

unsubscribe

void unsubscribe()
                 throws com.ebmwebsourcing.wsstar.notification.definition.utils.WSNotificationException,
                        javax.jbi.messaging.MessagingException,
                        PEtALSCDKException,
                        com.ebmwebsourcing.wsstar.addressing.definition.api.WSAddressingException

unsubscribe the consumer on the broker

Throws:

com.ebmwebsourcing.wsstar.notification.definition.utils.WSNotificationException

javax.jbi.messaging.MessagingException

PEtALSCDKException

com.ebmwebsourcing.wsstar.addressing.definition.api.WSAddressingException

getCurrentMessage

String getCurrentMessage()
                         throws com.ebmwebsourcing.wsstar.notification.definition.utils.WSNotificationException,
                                javax.jbi.messaging.MessagingException,
                                PEtALSCDKException,
                                com.ebmwebsourcing.wsstar.addressing.definition.api.WSAddressingException

Get the current message for the consumer on the broker

Returns:

the current message

Throws:

com.ebmwebsourcing.wsstar.notification.definition.utils.WSNotificationException

javax.jbi.messaging.MessagingException

PEtALSCDKException

com.ebmwebsourcing.wsstar.addressing.definition.api.WSAddressingException

destroyRegistration

void destroyRegistration()
                         throws com.ebmwebsourcing.wsstar.notification.definition.utils.WSNotificationException,
                                com.ebmwebsourcing.wsstar.notification.extension.utils.WSNotificationExtensionException,
                                com.ebmwebsourcing.wsstar.addressing.definition.api.WSAddressingException,
                                javax.jbi.messaging.MessagingException,
                                PEtALSCDKException

Destroy the registration of the publisher on the broker

Throws:

com.ebmwebsourcing.wsstar.notification.extension.utils.WSNotificationExtensionException

javax.jbi.messaging.MessagingException

PEtALSCDKException

com.ebmwebsourcing.wsstar.notification.definition.utils.WSNotificationException

com.ebmwebsourcing.wsstar.addressing.definition.api.WSAddressingException

notify

void notify(Document document,
            String topic,
            com.ebmwebsourcing.wsstar.addressing.definition.api.EndpointReferenceType subscriptionReference)
            throws com.ebmwebsourcing.wsstar.notification.definition.utils.WSNotificationException,
                   javax.jbi.messaging.MessagingException,
                   PEtALSCDKException,
                   com.ebmwebsourcing.wsstar.addressing.definition.api.WSAddressingException,
                   org.ow2.easywsdl.wsdl.api.WSDLException,
                   com.ebmwebsourcing.wsstar.notification.extension.utils.WSNotificationExtensionException

notify from the publisher to the broker

Parameters:

document - The message document payload into the notification

topic - The topic into the notification

subscriptionReference -

Throws:

com.ebmwebsourcing.wsstar.notification.definition.utils.WSNotificationException

com.ebmwebsourcing.wsstar.notification.extension.utils.WSNotificationExtensionException

javax.jbi.messaging.MessagingException

PEtALSCDKException

org.ow2.easywsdl.wsdl.api.WSDLException

com.ebmwebsourcing.wsstar.addressing.definition.api.WSAddressingException

renew

void renew()

Manage the renew on a subscription from the consumer

isBrokeredNotification

boolean isBrokeredNotification(javax.jbi.messaging.MessageExchange messageExchange)

Check if the JBI exchange is a brokered notification exchange

Parameters:

messageExchange - the JBI exchange

Returns:

true if the exchange is a brokered notification exchange, false else

setNotificationBrokerReferenceAddress

void setNotificationBrokerReferenceAddress(String notificationBrokerReferenceAddress)

Set the notificationBrokerReferenceAddress

Parameters:

notificationBrokerReferenceAddress - the notificationBrokerReferenceAddress to set

setPublisherRegistrationManagerReferenceAddress

void setPublisherRegistrationManagerReferenceAddress(String publisherRegistrationManagerReferenceAddress)

Set the publisherRegistrationManagerReferenceAddress

Parameters:

publisherRegistrationManagerReferenceAddress - the publisherRegistrationManagerReferenceAddress to set

setSubscriptionManagerReferenceAddress

void setSubscriptionManagerReferenceAddress(String subscriptionManagerReferenceAddress)

Set the subscriptionManagerReferenceAddress

Parameters:

subscriptionManagerReferenceAddress - the subscriptionManagerReferenceAddress to set

getNotificationProducer

NotificationProducer getNotificationProducer()

Get the notificationProducer

Returns:

the notificationProducer

getNotificationConsumer

NotificationConsumer getNotificationConsumer()

Get the notificationConsumer

Returns:

the notificationConsumer

isInternalNotification

boolean isInternalNotification(String address)

Check if the address is the default cdk address

Parameters:

address - The address to check

Returns:

true if the address is the default cdk address

getTransformer

Transformer getTransformer()