org.apache.servicemix.common

Interface Endpoint

All Known Implementing Classes:

AbstractEndpoint, ConsumerEndpoint, PollingEndpoint, ProviderEndpoint, SimpleEndpoint

public interface Endpoint

Method Summary

Methods

Modifier and Type	Method and Description
void	activate() Register this endpoint into the NMR and put the endpoint in a STOPPED state, where the endpoint is able to process incoming requests, but won't consume external requests such as JMS messages or HTTP requests.
void	deactivate() Unregister this endpoint from the NMR.
org.w3c.dom.Document	getDescription()
java.lang.String	getEndpoint()
javax.xml.namespace.QName	getInterfaceName()
java.lang.String	getKey()
javax.jbi.messaging.MessageExchange.Role	getRole()
javax.xml.namespace.QName	getService()
ServiceUnit	getServiceUnit()
boolean	isExchangeOkay(javax.jbi.messaging.MessageExchange exchange)
void	process(javax.jbi.messaging.MessageExchange exchange) Process an incoming JBI exchange.
void	setServiceUnit(ServiceUnit serviceUnit)
void	start() Start consumption of external requests.
void	stop() Stop consumption of external requests.
void	validate() Validation is a step which is done at deployment time to check that the endpoint definition is valid and that there is no missing properties.

Method Detail

getKey

java.lang.String getKey()

getInterfaceName

javax.xml.namespace.QName getInterfaceName()

getService

javax.xml.namespace.QName getService()

getEndpoint

java.lang.String getEndpoint()

getDescription

org.w3c.dom.Document getDescription()

getRole

javax.jbi.messaging.MessageExchange.Role getRole()

getServiceUnit

ServiceUnit getServiceUnit()

setServiceUnit

void setServiceUnit(ServiceUnit serviceUnit)

isExchangeOkay

boolean isExchangeOkay(javax.jbi.messaging.MessageExchange exchange)

activate

void activate()
              throws java.lang.Exception

Register this endpoint into the NMR and put the endpoint in a STOPPED state, where the endpoint is able to process incoming requests, but won't consume external requests such as JMS messages or HTTP requests.

Throws:

java.lang.Exception

start

void start()
           throws java.lang.Exception

Start consumption of external requests.

Throws:

java.lang.Exception

stop

void stop()
          throws java.lang.Exception

Stop consumption of external requests.

Throws:

java.lang.Exception

deactivate

void deactivate()
                throws java.lang.Exception

Unregister this endpoint from the NMR.

Throws:

java.lang.Exception

process

void process(javax.jbi.messaging.MessageExchange exchange)
             throws java.lang.Exception

Process an incoming JBI exchange.

Parameters:

exchange -

Throws:

java.lang.Exception

validate

void validate()
              throws javax.jbi.management.DeploymentException

Validation is a step which is done at deployment time to check that the endpoint definition is valid and that there is no missing properties.

Throws:

javax.jbi.management.DeploymentException