org.apache.axis2.transport.xmpp
Class XMPPSender

java.lang.Object
  org.apache.axis2.handlers.AbstractHandler
      org.apache.axis2.transport.xmpp.XMPPSender

All Implemented Interfaces:

Handler, TransportSender

public class XMPPSender
extends AbstractHandler
implements TransportSender

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.axis2.engine.Handler

Handler.InvocationResponse

Field Summary

Fields inherited from class org.apache.axis2.handlers.AbstractHandler

handlerDesc

Constructor Summary

XMPPSender()

Method Summary

void	cleanup(MessageContext msgContext) Clean up
void	init(ConfigurationContext confContext, TransportOutDescription transportOut) Initialize the transport sender by reading pre-defined connection factories for outgoing messages.
Handler.InvocationResponse	invoke(MessageContext msgContext) This method will be called on each registered handler when a message needs to be processed.
void	sendMessage(MessageContext msgCtx, java.lang.String targetAddress, OutTransportInfo outTransportInfo) Send the given message over XMPP transport
void	stop()

Methods inherited from class org.apache.axis2.handlers.AbstractHandler

cleanup, flowComplete, getHandlerDesc, getName, getParameter, init, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.axis2.engine.Handler

cleanup, flowComplete, getHandlerDesc, getName, getParameter, init

Constructor Detail

XMPPSender

public XMPPSender()

Method Detail

cleanup

public void cleanup(MessageContext msgContext)
             throws AxisFault

Description copied from interface: TransportSender

Clean up

Specified by:

cleanup in interface TransportSender

Throws:

AxisFault

init

public void init(ConfigurationContext confContext,
                 TransportOutDescription transportOut)
          throws AxisFault

Initialize the transport sender by reading pre-defined connection factories for outgoing messages. These will create sessions (one per each destination dealt with) to be used when messages are being sent.

Specified by:

init in interface TransportSender

Parameters:

confContext - the configuration context

transportOut - the transport sender definition from axis2.xml

Throws:

AxisFault - on error

stop

public void stop()

Specified by:

stop in interface TransportSender

invoke

public Handler.InvocationResponse invoke(MessageContext msgContext)
                                  throws AxisFault

Description copied from interface: Handler

This method will be called on each registered handler when a message needs to be processed. If the message processing is paused by the handler, then this method will be called again for the handler that paused the processing once it is resumed.

This method may be called concurrently from multiple threads.

Handlers that want to determine the type of message that is to be processed (e.g. response vs request, inbound vs. outbound, etc.) can retrieve that information from the MessageContext via MessageContext.getFLOW() and MessageContext.getAxisOperation().getMessageExchangePattern() APIs.

Specified by:

invoke in interface Handler

Parameters:

msgContext - the MessageContext to process with this Handler.

Returns:

An InvocationResponse that indicates what the next step in the message processing should be.

Throws:

AxisFault - if the handler encounters an error

sendMessage

public void sendMessage(MessageContext msgCtx,
                        java.lang.String targetAddress,
                        OutTransportInfo outTransportInfo)
                 throws AxisFault

Send the given message over XMPP transport

Parameters:

msgCtx - the axis2 message context

Throws:

AxisFault - on error