org.ow2.petals.component.framework.listener
Class AbstractExternalListener

java.lang.Object
  org.ow2.petals.component.framework.listener.AbstractListener
      org.ow2.petals.component.framework.listener.AbstractExternalListener

public abstract class AbstractExternalListener
extends AbstractListener

The abstract methods for an external listener.

Author:

alouis, ofabre - EBM Websourcing

Field Summary

Fields inherited from class org.ow2.petals.component.framework.listener.AbstractListener

component, factory, messageInterceptorProcessor

Constructor Summary

AbstractExternalListener()

Method Summary

org.ow2.petals.component.framework.api.message.Exchange	createConsumeExchange() Create a message exchange with all the information set in the related Consumes Su configuration. - service information (itf, srv, ep) - MEP - operation - Properties
abstract void	start() Starts the listener.
abstract void	stop() Stops the listener.

Methods inherited from class org.ow2.petals.component.framework.listener.AbstractListener

createConsumeExchange, createConsumeExchange, createExchange, getComponent, getComponentContext, getConsumes, getCurrentTransaction, getExtensions, getInstallRoot, getLogger, getMessageInterceptorProcessor, getProvides, init, init, retrievePattern, send, sendAsync, sendSync, sendSync, setConsumes, setCurrentTransaction, setExtensions, setProvides

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractExternalListener

public AbstractExternalListener()

Method Detail

start

public abstract void start()
                    throws org.ow2.petals.component.framework.api.exception.PEtALSCDKException

Starts the listener. This method is called when the SU that causes this listener instantiation is started.

Throws:

org.ow2.petals.component.framework.api.exception.PEtALSCDKException - if an error occurs during external listener starting process

stop

public abstract void stop()
                   throws org.ow2.petals.component.framework.api.exception.PEtALSCDKException

Stops the listener. This method is called when the SU that causes this listener instantiation is stopped.

Throws:

org.ow2.petals.component.framework.api.exception.PEtALSCDKException - if an error occurs during external listener stopping process

createConsumeExchange

public org.ow2.petals.component.framework.api.message.Exchange createConsumeExchange()
                                                                              throws javax.jbi.messaging.MessagingException,
                                                                                     org.ow2.petals.component.framework.api.exception.PEtALSCDKException

Create a message exchange with all the information set in the related Consumes Su configuration.
- service information (itf, srv, ep)
- MEP
- operation
- Properties

Returns:

The message exchange

Throws:

javax.jbi.messaging.MessagingException - The message exchange can't be created or no pattern specified in extensions

org.ow2.petals.component.framework.api.exception.PEtALSCDKException - The current Transaction has failed to return its status

org.ow2.petals.component.framework.api.exception.PEtALSCDKException