JMSDestination (Apache CXF Runtime JMS Transport 2.7.0.redhat-611476 API)

java.lang.Object
- org.apache.cxf.transport.AbstractObservable
- - org.apache.cxf.transport.AbstractDestination
  - - org.apache.cxf.transport.AbstractMultiplexDestination
    - - org.apache.cxf.transport.jms.JMSDestination

All Implemented Interfaces:

javax.jms.MessageListener, org.apache.cxf.transport.Destination, org.apache.cxf.transport.DestinationWithEndpoint, org.apache.cxf.transport.MultiplexDestination, org.apache.cxf.transport.Observable, org.springframework.jms.listener.SessionAwareMessageListener<javax.jms.Message>
```
public class JMSDestination
extends org.apache.cxf.transport.AbstractMultiplexDestination
implements org.springframework.jms.listener.SessionAwareMessageListener<javax.jms.Message>, javax.jms.MessageListener
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class JMSDestination.BackChannelConduit
Conduit for sending the reply back to the client
- Nested classes/interfaces inherited from class org.apache.cxf.transport.AbstractDestination
  org.apache.cxf.transport.AbstractDestination.AbstractBackChannelConduit

Nested Classes
Modifier and Type	Class and Description
`protected class`	`JMSDestination.BackChannelConduit` Conduit for sending the reply back to the client

Field Summary
- Fields inherited from class org.apache.cxf.transport.AbstractDestination
  endpointInfo, reference
- Fields inherited from class org.apache.cxf.transport.AbstractObservable
  incomingObserver

Constructor Summary

Constructors
Constructor and Description

JMSDestination(org.apache.cxf.Bus b, org.apache.cxf.service.model.EndpointInfo info, JMSConfiguration jmsConfig)

Constructors
Constructor and Description
`JMSDestination(org.apache.cxf.Bus b, org.apache.cxf.service.model.EndpointInfo info, JMSConfiguration jmsConfig)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`activate()` Initialize jmsTemplate and jmsListener from jms configuration data in jmsConfig
`void`	`deactivate()`
`String`	`determineCorrelationID(javax.jms.Message request)` Decides what correlationId to use for the reply by looking at the request headers.
`protected org.apache.cxf.transport.Conduit`	`getInbuiltBackChannel(org.apache.cxf.message.Message inMessage)`
`JMSConfiguration`	`getJmsConfig()`
`protected Logger`	`getLogger()`
`javax.jms.Destination`	`getReplyToDestination(org.springframework.jms.core.JmsTemplate jmsTemplate, org.apache.cxf.message.Message inMessage)`
`void`	`onMessage(javax.jms.Message message)` Convert JMS message received by ListenerThread to CXF message and inform incomingObserver that a message was received.
`void`	`onMessage(javax.jms.Message message, javax.jms.Session session)`
`void`	`sendExchange(org.apache.cxf.message.Exchange exchange, Object replyObj)` Is called from JMSOutputStream.doClose() when the stream is fully written.
`void`	`setJmsConfig(JMSConfiguration jmsConfig)`
`void`	`shutdown()`

Methods inherited from class org.apache.cxf.transport.AbstractMultiplexDestination
getAddressWithId, getId

Methods inherited from class org.apache.cxf.transport.AbstractDestination
getAddress, getBackChannel, getEndpointInfo

Methods inherited from class org.apache.cxf.transport.AbstractObservable
getMessageObserver, getTargetReference, getTargetReference, setMessageObserver

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.cxf.transport.Destination
getAddress, getBackChannel, getMessageObserver

Methods inherited from interface org.apache.cxf.transport.Observable
setMessageObserver

- Constructor Detail
  - JMSDestination
```
public JMSDestination(org.apache.cxf.Bus b,
              org.apache.cxf.service.model.EndpointInfo info,
              JMSConfiguration jmsConfig)
```
- Method Detail
  - getInbuiltBackChannel
```
protected org.apache.cxf.transport.Conduit getInbuiltBackChannel(org.apache.cxf.message.Message inMessage)
```
    Specified by:
    
    getInbuiltBackChannel in class org.apache.cxf.transport.AbstractDestination
    
    Parameters:
    inMessage - the incoming message
    
    Returns:
    the inbuilt backchannel
  - activate
```
public void activate()
```
    Initialize jmsTemplate and jmsListener from jms configuration data in jmsConfig
    
    Overrides:
    
    activate in class org.apache.cxf.transport.AbstractObservable
  - deactivate
```
public void deactivate()
```
    Overrides:
    
    deactivate in class org.apache.cxf.transport.AbstractObservable
  - shutdown
```
public void shutdown()
```
    Specified by:
    
    shutdown in interface org.apache.cxf.transport.Destination
    
    Overrides:
    
    shutdown in class org.apache.cxf.transport.AbstractDestination
  - getReplyToDestination
```
public javax.jms.Destination getReplyToDestination(org.springframework.jms.core.JmsTemplate jmsTemplate,
                                          org.apache.cxf.message.Message inMessage)
                                            throws javax.jms.JMSException
```
    Throws:
    
    javax.jms.JMSException
  - determineCorrelationID
```
public String determineCorrelationID(javax.jms.Message request)
                              throws javax.jms.JMSException
```
    Decides what correlationId to use for the reply by looking at the request headers. If the request has a correlationId set this is taken. Else the messageId from the request message is used as correlation Id
    
    Parameters:
    request -
    
    Returns:
    
    Throws:
    
    javax.jms.JMSException
  - onMessage
```
public void onMessage(javax.jms.Message message)
```
    Convert JMS message received by ListenerThread to CXF message and inform incomingObserver that a message was received. The observer will call the service and then send the response CXF message by using the BackChannelConduit
    
    Specified by:
    
    onMessage in interface javax.jms.MessageListener
    
    Parameters:
    message -
    
    Throws:
    
    IOException
  - onMessage
```
public void onMessage(javax.jms.Message message,
             javax.jms.Session session)
```
    Specified by:
    
    onMessage in interface org.springframework.jms.listener.SessionAwareMessageListener<javax.jms.Message>
  - sendExchange
```
public void sendExchange(org.apache.cxf.message.Exchange exchange,
                Object replyObj)
```
    Is called from JMSOutputStream.doClose() when the stream is fully written. Sends the outMessage of the given exchange with the given payload from the JMSOutputStream. If the exchange is not oneway a reply should be recieved and set as inMessage
  - getLogger
```
protected Logger getLogger()
```
    Specified by:
    
    getLogger in class org.apache.cxf.transport.AbstractObservable
  - getJmsConfig
```
public JMSConfiguration getJmsConfig()
```
  - setJmsConfig
```
public void setJmsConfig(JMSConfiguration jmsConfig)
```

Class JMSDestination

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.cxf.transport.AbstractDestination

Field Summary

Fields inherited from class org.apache.cxf.transport.AbstractDestination

Fields inherited from class org.apache.cxf.transport.AbstractObservable

Constructor Summary

Method Summary

Methods inherited from class org.apache.cxf.transport.AbstractMultiplexDestination

Methods inherited from class org.apache.cxf.transport.AbstractDestination

Methods inherited from class org.apache.cxf.transport.AbstractObservable

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.cxf.transport.Destination

Methods inherited from interface org.apache.cxf.transport.Observable

Constructor Detail

JMSDestination

Method Detail

getInbuiltBackChannel

activate

deactivate

shutdown

getReplyToDestination

determineCorrelationID

onMessage

onMessage

sendExchange

getLogger

getJmsConfig

setJmsConfig