|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ServiceMixClient
Represents a client API which allows users to programatically send messages into the JBI container or to receive them using the regular JBI API together with a collection of helper methods making it easier to interact with the JBI API.
Method Summary | |
---|---|
void |
close()
Close this client. |
Destination |
createDestination(java.lang.String uri)
Creates a destination which represents some JBI endpoint that message exchanges can be created with. |
javax.jbi.messaging.InOnly |
createInOnlyExchange()
Creates an InOnly (one way) message exchange. |
javax.jbi.messaging.InOnly |
createInOnlyExchange(EndpointResolver resolver)
Creates an InOnly (one way) message exchange with the given resolver. |
javax.jbi.messaging.InOptionalOut |
createInOptionalOutExchange()
Creates an InOptionalOut (optional request-reply) message exchange. |
javax.jbi.messaging.InOptionalOut |
createInOptionalOutExchange(EndpointResolver resolver)
Creates an InOptionalOut (optional request-reply) message exchange with the given resolver. |
javax.jbi.messaging.InOut |
createInOutExchange()
Creates an InOut (request-reply) message exchange. |
javax.jbi.messaging.InOut |
createInOutExchange(EndpointResolver resolver)
Creates an InOut (request-reply) message exchange with the given resolver. |
EndpointResolver |
createResolverForExternalInterface(javax.xml.namespace.QName interfaceName)
Creates an endpoint for the given external interface |
EndpointResolver |
createResolverForExternalInterface(javax.xml.namespace.QName service,
java.lang.String endpoint)
Creates an endpoint resolver for the given service and endpoint name |
EndpointResolver |
createResolverForExternalService(javax.xml.namespace.QName service)
Creates an endpoint for the given external service name |
EndpointResolver |
createResolverForService(javax.xml.namespace.QName service)
Creates an endpoint resolver for the given service name |
EndpointResolver |
createResolverInterface(javax.xml.namespace.QName interfaceName)
Creates an endpoint resolver for the given interface name |
javax.jbi.messaging.RobustInOnly |
createRobustInOnlyExchange()
Creates an RobustInOnly (one way) message exchange. |
javax.jbi.messaging.RobustInOnly |
createRobustInOnlyExchange(EndpointResolver resolver)
Creates an RobustInOnly (one way) message exchange with the given resolver. |
void |
done(javax.jbi.messaging.MessageExchange exchange)
A helper method to indicate that the message exchange is complete which will set the status to ExchangeStatus.DONE and send the message
on the delivery channel. |
void |
fail(javax.jbi.messaging.MessageExchange exchange,
java.lang.Exception error)
A helper method which fails and completes the given exchange with the specified exception |
void |
fail(javax.jbi.messaging.MessageExchange exchange,
javax.jbi.messaging.Fault fault)
A helper method which fails and completes the given exchange with the specified fault |
javax.jbi.component.ComponentContext |
getContext()
Returns the current component context which can be used to activate endpoints, components and query the available service endpoints. |
javax.jbi.messaging.DeliveryChannel |
getDeliveryChannel()
Returns the delivery channel for this client's message exchanges |
javax.jbi.messaging.MessageExchangeFactory |
getExchangeFactory()
Returns the default message exchange factory. |
javax.jbi.messaging.MessageExchange |
receive()
Receives an inbound message exchange, blocking forever until one is available. |
javax.jbi.messaging.MessageExchange |
receive(long timeout)
Receives an inbound message exchange, blocking until the given timeout period. |
java.lang.Object |
request(EndpointResolver resolver,
java.util.Map exchangeProperties,
java.util.Map inMessageProperties,
java.lang.Object content)
Performs a request-response (using an InOut to the endpoint denoted by the given resolver,
blocking until the response is received and then returning the result. |
java.lang.Object |
request(java.util.Map inMessageProperties,
java.lang.Object content)
Performs a request-response (using an InOut to the endpoint denoted by the given resolver,
blocking until the response is received and then returning the result. |
javax.jbi.servicedesc.ServiceEndpoint |
resolveEndpointReference(java.lang.String uri)
Resolves a WS-Addressing endpoint reference String into a JBI ServiceEndpoint
reference so that message exchanges can be directed to an endpoint |
void |
send(EndpointResolver resolver,
java.util.Map exchangeProperties,
java.util.Map inMessageProperties,
java.lang.Object content)
Sends a one way message exchange to the endpoint denoted by the given resolver |
void |
send(java.util.Map inMessageProperties,
java.lang.Object content)
Sends a one way message exchange to the endpoint denoted by the given resolver |
void |
send(Message message)
Sends an In-Only message |
void |
send(javax.jbi.messaging.MessageExchange exchange)
Sends the message exchange to the endpoint. |
boolean |
sendSync(EndpointResolver resolver,
java.util.Map exchangeProperties,
java.util.Map inMessageProperties,
java.lang.Object content)
Sends a one way message exchange to the endpoint denoted by the given resolver and blocks until the send is completed. |
boolean |
sendSync(java.util.Map inMessageProperties,
java.lang.Object content)
Sends a one way message exchange to the endpoint denoted by the given resolver and blocks until the send is completed. |
boolean |
sendSync(javax.jbi.messaging.MessageExchange exchange)
Sends the message exchange to the endpoint, blocking until the send has completed. |
boolean |
sendSync(javax.jbi.messaging.MessageExchange exchange,
long timeout)
Sends the message exchange to the endpoint, blocking until the send has completed or the specified timeout has elapsed. |
Method Detail |
---|
void send(javax.jbi.messaging.MessageExchange exchange) throws javax.jbi.messaging.MessagingException
exchange
-
javax.jbi.messaging.MessagingException
void send(Message message) throws javax.jbi.messaging.MessagingException
message
-
javax.jbi.messaging.MessagingException
boolean sendSync(javax.jbi.messaging.MessageExchange exchange) throws javax.jbi.messaging.MessagingException
exchange
-
javax.jbi.messaging.MessagingException
boolean sendSync(javax.jbi.messaging.MessageExchange exchange, long timeout) throws javax.jbi.messaging.MessagingException
exchange
- timeout
-
javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessageExchange receive() throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessageExchange receive(long timeout) throws javax.jbi.messaging.MessagingException
timeout
- the maximum amount of time to wait for a message
javax.jbi.messaging.MessagingException
java.lang.Object request(EndpointResolver resolver, java.util.Map exchangeProperties, java.util.Map inMessageProperties, java.lang.Object content) throws javax.jbi.JBIException
InOut
to the endpoint denoted by the given resolver,
blocking until the response is received and then returning the result.
resolver
- the resolver used to resolve and choose the endpoint, which if null is used
then the container configured routing rules are used to dispatch the message to the destinationexchangeProperties
- the properties used for the exchange or null if no properties are requiredinMessageProperties
- the properties used for the in message or null if no properties are requiredcontent
- the body of the message
javax.jbi.JBIException
- if the message could not be dispatched for some reason.void send(EndpointResolver resolver, java.util.Map exchangeProperties, java.util.Map inMessageProperties, java.lang.Object content) throws javax.jbi.JBIException
resolver
- the resolver used to resolve and choose the endpoint, which if null is used
then the container configured routing rules are used to dispatch the message to the destinationexchangeProperties
- the properties used for the exchange or null if no properties are requiredinMessageProperties
- the properties used for the in message or null if no properties are requiredcontent
- the body of the message
javax.jbi.JBIException
- if the message could not be dispatched for some reason.boolean sendSync(EndpointResolver resolver, java.util.Map exchangeProperties, java.util.Map inMessageProperties, java.lang.Object content) throws javax.jbi.JBIException
resolver
- the resolver used to resolve and choose the endpoint, which if null is used
then the container configured routing rules are used to dispatch the message to the destinationexchangeProperties
- the properties used for the exchange or null if no properties are requiredinMessageProperties
- the properties used for the in message or null if no properties are requiredcontent
- the body of the message
javax.jbi.JBIException
- if the message could not be dispatched for some reason.java.lang.Object request(java.util.Map inMessageProperties, java.lang.Object content) throws javax.jbi.JBIException
InOut
to the endpoint denoted by the given resolver,
blocking until the response is received and then returning the result.
inMessageProperties
- the properties used for the in message or null if no properties are requiredcontent
- the body of the message
javax.jbi.JBIException
- if the message could not be dispatched for some reason.void send(java.util.Map inMessageProperties, java.lang.Object content) throws javax.jbi.JBIException
inMessageProperties
- the properties used for the in message or null if no properties are requiredcontent
- the body of the message
javax.jbi.JBIException
- if the message could not be dispatched for some reason.boolean sendSync(java.util.Map inMessageProperties, java.lang.Object content) throws javax.jbi.JBIException
inMessageProperties
- the properties used for the in message or null if no properties are requiredcontent
- the body of the message
javax.jbi.JBIException
- if the message could not be dispatched for some reason.javax.jbi.messaging.InOnly createInOnlyExchange() throws javax.jbi.messaging.MessagingException
InOnly
(one way) message exchange.
javax.jbi.messaging.MessagingException
javax.jbi.messaging.InOnly createInOnlyExchange(EndpointResolver resolver) throws javax.jbi.JBIException
InOnly
(one way) message exchange with the given resolver.
javax.jbi.messaging.MessagingException
javax.jbi.JBIException
javax.jbi.messaging.InOut createInOutExchange() throws javax.jbi.messaging.MessagingException
InOut
(request-reply) message exchange.
javax.jbi.messaging.MessagingException
javax.jbi.messaging.InOut createInOutExchange(EndpointResolver resolver) throws javax.jbi.JBIException
InOut
(request-reply) message exchange with the given resolver.
javax.jbi.messaging.MessagingException
javax.jbi.JBIException
javax.jbi.messaging.InOptionalOut createInOptionalOutExchange() throws javax.jbi.messaging.MessagingException
InOptionalOut
(optional request-reply) message exchange.
javax.jbi.messaging.MessagingException
javax.jbi.messaging.InOptionalOut createInOptionalOutExchange(EndpointResolver resolver) throws javax.jbi.JBIException
InOptionalOut
(optional request-reply) message exchange with the given resolver.
javax.jbi.messaging.MessagingException
javax.jbi.JBIException
javax.jbi.messaging.RobustInOnly createRobustInOnlyExchange() throws javax.jbi.messaging.MessagingException
RobustInOnly
(one way) message exchange.
javax.jbi.messaging.MessagingException
javax.jbi.messaging.RobustInOnly createRobustInOnlyExchange(EndpointResolver resolver) throws javax.jbi.JBIException
RobustInOnly
(one way) message exchange with the given resolver.
javax.jbi.messaging.MessagingException
javax.jbi.JBIException
javax.jbi.servicedesc.ServiceEndpoint resolveEndpointReference(java.lang.String uri)
ServiceEndpoint
reference so that message exchanges can be directed to an endpoint
uri
- the WS-Addressing endpoint reference stringEndpointResolver createResolverForService(javax.xml.namespace.QName service)
service
-
EndpointResolver createResolverInterface(javax.xml.namespace.QName interfaceName)
interfaceName
-
EndpointResolver createResolverForExternalService(javax.xml.namespace.QName service)
service
-
EndpointResolver createResolverForExternalInterface(javax.xml.namespace.QName interfaceName)
interfaceName
-
EndpointResolver createResolverForExternalInterface(javax.xml.namespace.QName service, java.lang.String endpoint)
service
- endpoint
-
Destination createDestination(java.lang.String uri) throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingException
void done(javax.jbi.messaging.MessageExchange exchange) throws javax.jbi.messaging.MessagingException
ExchangeStatus.DONE
and send the message
on the delivery channel.
exchange
-
javax.jbi.messaging.MessagingException
void fail(javax.jbi.messaging.MessageExchange exchange, javax.jbi.messaging.Fault fault) throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingException
void fail(javax.jbi.messaging.MessageExchange exchange, java.lang.Exception error) throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingException
javax.jbi.component.ComponentContext getContext()
javax.jbi.messaging.DeliveryChannel getDeliveryChannel() throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessageExchangeFactory getExchangeFactory() throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingException
void close() throws javax.jbi.JBIException
javax.jbi.JBIException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |