org.apache.airavata.wsmg.client
Interface MessageBrokerClient

All Known Implementing Classes:
WseMsgBrokerClient, WsntMsgBrokerClient

public interface MessageBrokerClient


Method Summary
 org.apache.axis2.addressing.EndpointReference createPullMsgBox(String msgBoxServerLoc)
           
 org.apache.axis2.addressing.EndpointReference createPullMsgBox(String msgBoxLocation, long timeout)
           
 String[] getConsumerServiceEndpointReference()
           
 void init(String brokerLocation)
          May be we just use a constructor here
 void publish(String topic, org.apache.axiom.om.OMElement message)
           
 void publish(String topic, String plainText)
           
 void shutdownConsumerService()
          This method can be used to shutdown the consumer server started
 String[] startConsumerService(int port, ConsumerNotificationHandler handler)
           
 MessagePuller startPullingEventsFromMsgBox(org.apache.axis2.addressing.EndpointReference msgBoxAddr, NotificationHandler handler, long backoff, long timeout)
           
 MessagePuller startPullingFromExistingMsgBox(org.apache.axis2.addressing.EndpointReference msgBoxAddr, NotificationHandler handler, long backoff, long timeout)
           
 void stopPullingEventsFromMsgBox(MessagePuller msgPuller)
           
 String subscribe(org.apache.axis2.addressing.EndpointReference eventSinkLocation, String topicExpression, String xpathExpression)
           
 String subscribe(org.apache.axis2.addressing.EndpointReference eventSinkLocation, String topicExpression, String xpathExpression, long expireTime)
           
 String subscribe(String eventSinkLocation, String topicExpression, String xpathExpression)
           
 String subscribeMsgBox(org.apache.axis2.addressing.EndpointReference msgBoxEpr, String topicExpression, String xpathExpression, long expireTime)
           
 String subscribeMsgBox(String brokerService, org.apache.axis2.addressing.EndpointReference msgBoxEpr, String topic, String xpath)
           
 boolean unSubscribe(String subscriptionId)
           
 

Method Detail

init

void init(String brokerLocation)
May be we just use a constructor here

Parameters:
brokerLocation -

unSubscribe

boolean unSubscribe(String subscriptionId)
                    throws MsgBrokerClientException
Parameters:
subscriptionId -
Returns:
Throws:
MsgBrokerClientException

subscribe

String subscribe(String eventSinkLocation,
                 String topicExpression,
                 String xpathExpression)
                 throws MsgBrokerClientException
Parameters:
eventSinkLocation -
topicExpression -
xpathExpression -
Returns:
Throws:
org.apache.axis2.AxisFault
MsgBrokerClientException

subscribe

String subscribe(org.apache.axis2.addressing.EndpointReference eventSinkLocation,
                 String topicExpression,
                 String xpathExpression)
                 throws MsgBrokerClientException
Throws:
MsgBrokerClientException

subscribe

String subscribe(org.apache.axis2.addressing.EndpointReference eventSinkLocation,
                 String topicExpression,
                 String xpathExpression,
                 long expireTime)
                 throws MsgBrokerClientException
Parameters:
eventSinkLocation -
topicExpression -
xpathExpression -
expireTime - with -1, it never expires
Returns:
Throws:
org.apache.axis2.AxisFault
MsgBrokerClientException

publish

void publish(String topic,
             String plainText)
             throws MsgBrokerClientException
Throws:
MsgBrokerClientException

publish

void publish(String topic,
             org.apache.axiom.om.OMElement message)
             throws MsgBrokerClientException
Throws:
MsgBrokerClientException

subscribeMsgBox

String subscribeMsgBox(org.apache.axis2.addressing.EndpointReference msgBoxEpr,
                       String topicExpression,
                       String xpathExpression,
                       long expireTime)
                       throws MsgBrokerClientException
Parameters:
brokerLocation -
msgBoxEpr -
topicExpression -
xpathExpression -
expireTime - with -1, it never expires
Returns:
Throws:
MsgBrokerClientException

shutdownConsumerService

void shutdownConsumerService()
This method can be used to shutdown the consumer server started


startConsumerService

String[] startConsumerService(int port,
                              ConsumerNotificationHandler handler)
                              throws MsgBrokerClientException
Parameters:
port -
handler -
Returns:
Throws:
MsgBrokerClientException

startPullingFromExistingMsgBox

MessagePuller startPullingFromExistingMsgBox(org.apache.axis2.addressing.EndpointReference msgBoxAddr,
                                             NotificationHandler handler,
                                             long backoff,
                                             long timeout)
                                             throws MsgBrokerClientException
Parameters:
msgBoxAddr -
handler -
backoff -
timeout -
Returns:
Throws:
org.apache.axis2.AxisFault
MsgBrokerClientException

startPullingEventsFromMsgBox

MessagePuller startPullingEventsFromMsgBox(org.apache.axis2.addressing.EndpointReference msgBoxAddr,
                                           NotificationHandler handler,
                                           long backoff,
                                           long timeout)
                                           throws MsgBrokerClientException
Parameters:
msgBoxAddr -
handler -
backoff -
timeout -
Returns:
Throws:
RemoteException
MsgBrokerClientException

stopPullingEventsFromMsgBox

void stopPullingEventsFromMsgBox(MessagePuller msgPuller)
                                 throws MsgBrokerClientException
Parameters:
msgPuller -
Throws:
MsgBrokerClientException

getConsumerServiceEndpointReference

String[] getConsumerServiceEndpointReference()
Returns:

subscribeMsgBox

String subscribeMsgBox(String brokerService,
                       org.apache.axis2.addressing.EndpointReference msgBoxEpr,
                       String topic,
                       String xpath)
                       throws MsgBrokerClientException
Parameters:
brokerService -
msgBoxEpr -
topic -
xpath -
Returns:
Throws:
MsgBrokerClientException

createPullMsgBox

org.apache.axis2.addressing.EndpointReference createPullMsgBox(String msgBoxLocation,
                                                               long timeout)
                                                               throws MsgBrokerClientException
Parameters:
msgBoxLocation -
timeout -
Returns:
Throws:
MsgBrokerClientException

createPullMsgBox

org.apache.axis2.addressing.EndpointReference createPullMsgBox(String msgBoxServerLoc)
                                                               throws MsgBrokerClientException
Parameters:
msgBoxServerLoc -
Returns:
Throws:
MsgBrokerClientException


Copyright © 2011-2012 The Apache Software Foundation. All Rights Reserved.