Package org.apache.uima.aae.spi.transport

Interface UimaTransport

All Known Implementing Classes:

VmTransport

public interface UimaTransport

Method Summary

Modifier and Type	Method	Description
void	addSpiListener(SpiListener aListener)	This method registers a given SpiListener instance with the SPI.
UimaMessageDispatcher	getUimaMessageDispatcher()	Returns SPI Dispatcher
UimaMessageDispatcher	getUimaMessageDispatcher(java.lang.String aDelegateKey)
UimaMessageListener	getUimaMessageListener()
UimaVmMessage	produceMessage()
UimaVmMessage	produceMessage(int aCommand, int aMessageType, java.lang.String aMessageFrom)
UimaMessageDispatcher	produceUimaMessageDispatcher(UimaTransport aTransport)
UimaMessageListener	produceUimaMessageListener()
void	registerWithJMX(AnalysisEngineController aController, java.lang.String queueKind)
void	startIt()	This method is called to start SPI.
void	stopIt()	This method is called to stop SPI.

Method Detail

addSpiListener

void addSpiListener(SpiListener aListener)

This method registers a given SpiListener instance with the SPI. The SPI will call all registered listeners when the initialization is completed, when the start is completed, and when the stop is completed.

Parameters:

aListener - - SPI listener to receive events

startIt

void startIt()
      throws UimaSpiException

This method is called to start SPI.

Throws:

UimaSpiException - - any problems while starting the SPI

stopIt

void stopIt()
     throws UimaSpiException

This method is called to stop SPI.

Throws:

UimaSpiException - - any problems while stopping the SPI

getUimaMessageDispatcher

UimaMessageDispatcher getUimaMessageDispatcher()
                                        throws UimaSpiException

Returns SPI Dispatcher

Returns:

- instance of SPI Dispatcher

Throws:

UimaSpiException - - any problems while fetching Dispatcher

getUimaMessageListener

UimaMessageListener getUimaMessageListener()
                                    throws UimaSpiException

Throws:

UimaSpiException

getUimaMessageDispatcher

UimaMessageDispatcher getUimaMessageDispatcher(java.lang.String aDelegateKey)
                                        throws UimaSpiException

Throws:

UimaSpiException

produceUimaMessageListener

UimaMessageListener produceUimaMessageListener()
                                        throws UimaSpiException

Throws:

UimaSpiException

produceUimaMessageDispatcher

UimaMessageDispatcher produceUimaMessageDispatcher(UimaTransport aTransport)
                                            throws UimaSpiException

Throws:

UimaSpiException

produceMessage

UimaVmMessage produceMessage()

produceMessage

UimaVmMessage produceMessage(int aCommand,
                             int aMessageType,
                             java.lang.String aMessageFrom)

registerWithJMX

void registerWithJMX(AnalysisEngineController aController,
                     java.lang.String queueKind)