HornetQItemReaderWriterBase (jberet-support 1.2.0.Final API)

java.lang.Object
- org.jberet.support.io.ItemReaderWriterBase
- - org.jberet.support.io.HornetQItemReaderWriterBase

Direct Known Subclasses:

HornetQItemReader, HornetQItemWriter
```
public abstract class HornetQItemReaderWriterBase
extends ItemReaderWriterBase
```
The base class for HornetQItemReader and HornetQItemWriter.

Since:

1.1.0

See Also:

HornetQItemReader, HornetQItemWriter

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map`	`connectorFactoryParams` Key-value pairs to identify and configure HornetQ `org.hornetq.api.core.TransportConfiguration`, which is used to create HornetQ `ServerLocator`.
`protected static String`	`FACTORY_CLASS_KEY`
`protected static String`	`NAME_KEY`
`protected static String`	`QUEUE_ADDRESS_KEY`
`protected static String`	`QUEUE_DURABLE_KEY`
`protected static String`	`QUEUE_FILTER_KEY`
`protected static String`	`QUEUE_NAME_KEY`
`protected static String`	`QUEUE_SHARED_KEY`
`protected static String`	`QUEUE_TEMPORARY_KEY`
`protected org.hornetq.api.core.SimpleString`	`queueAddress`
`protected org.hornetq.api.core.SimpleString`	`queueName`
`protected Map`	`queueParams` Key-value pairs to identify and configure the target HornetQ queue.
`protected Class`	`sendAcknowledgementHandler` The fully-qualified name of a class that implements `org.hornetq.api.core.client.SendAcknowledgementHandler`.
`protected static String`	`SERVER_LOCATOR_HA_KEY`
`protected org.hornetq.api.core.client.ServerLocator`	`serverLocator`
`protected javax.enterprise.inject.Instance<org.hornetq.api.core.client.ServerLocator>`	`serverLocatorInstance` This field holds an optional injection of HornetQ `ServerLocator`.
`protected Map`	`serverLocatorParams` Key-value pairs to configure HornetQ `ServerLocator`.
`protected org.hornetq.api.core.client.ClientSession`	`session`
`protected org.hornetq.api.core.client.ClientSessionFactory`	`sessionFactory`
`protected javax.enterprise.inject.Instance<org.hornetq.api.core.client.ClientSessionFactory>`	`sessionFactoryInstance` This field holds an optional injection of HornetQ `ClientSessionFactory`.

Fields inherited from class org.jberet.support.io.ItemReaderWriterBase
NEW_LINE, resource, skipBeanValidation

Constructor Summary

Constructors
Constructor and Description

HornetQItemReaderWriterBase()

Constructors
Constructor and Description
`HornetQItemReaderWriterBase()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected static Serializable`	`bytesToSerializableObject(byte[] bytes)`
`Serializable`	`checkpointInfo()`
`protected void`	`close()`
`protected void`	`configureServerLocator()`
`protected static byte[]`	`objectToBytes(Object obj)`
`void`	`open(Serializable checkpoint)`

Methods inherited from class org.jberet.support.io.ItemReaderWriterBase
getInputStream, getOutputStream, getValidator, validate

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

- Field Detail
  - QUEUE_NAME_KEY
```
protected static final String QUEUE_NAME_KEY
```
    See Also:
    
    Constant Field Values
  - QUEUE_ADDRESS_KEY
```
protected static final String QUEUE_ADDRESS_KEY
```
    See Also:
    
    Constant Field Values
  - QUEUE_FILTER_KEY
```
protected static final String QUEUE_FILTER_KEY
```
    See Also:
    
    Constant Field Values
  - QUEUE_DURABLE_KEY
```
protected static final String QUEUE_DURABLE_KEY
```
    See Also:
    
    Constant Field Values
  - QUEUE_SHARED_KEY
```
protected static final String QUEUE_SHARED_KEY
```
    See Also:
    
    Constant Field Values
  - QUEUE_TEMPORARY_KEY
```
protected static final String QUEUE_TEMPORARY_KEY
```
    See Also:
    
    Constant Field Values
  - SERVER_LOCATOR_HA_KEY
```
protected static final String SERVER_LOCATOR_HA_KEY
```
    See Also:
    
    Constant Field Values
  - NAME_KEY
```
protected static final String NAME_KEY
```
    See Also:
    
    Constant Field Values
  - FACTORY_CLASS_KEY
```
protected static final String FACTORY_CLASS_KEY
```
    See Also:
    
    Constant Field Values
  - serverLocatorInstance
```
@Inject
protected javax.enterprise.inject.Instance<org.hornetq.api.core.client.ServerLocator> serverLocatorInstance
```
    This field holds an optional injection of HornetQ ServerLocator. When connectorFactoryParams is not specified, and sessionFactoryInstance is not satisfied, this field will be queried to obtain an instance of HornetQ ServerLocator. The application may implement a javax.enterprise.inject.Produces method to satisfy this dependency injection.
  - sessionFactoryInstance
```
@Inject
protected javax.enterprise.inject.Instance<org.hornetq.api.core.client.ClientSessionFactory> sessionFactoryInstance
```
    This field holds an optional injection of HornetQ ClientSessionFactory. If this injection is satisfied, serverLocatorInstance will be ignored. The application may implement a javax.enterprise.inject.Produces method to satisfy this dependency injection.
  - connectorFactoryParams
```
@Inject
protected Map connectorFactoryParams
```
    Key-value pairs to identify and configure HornetQ org.hornetq.api.core.TransportConfiguration, which is used to create HornetQ ServerLocator. Optional property and defaults to null. When this property is present, it will be used to create HornetQ ServerLocator, and the injection fields serverLocatorInstance and sessionFactoryInstance will be ignored. Valid keys and values are:
    - "factory-class", the fully-qualified class name of a HornetQ connector factory, required if this property is present
    - any param keys and values appropriate for the above-named HornetQ connector factory class
    An example of this property in job xml:
    <property name="connectorFactoryParams" value="factory-class=org.hornetq.core.remoting.impl.netty.NettyConnectorFactory, host=localhost, port=5445"/>
  - serverLocatorParams
```
@Inject
protected Map serverLocatorParams
```
    Key-value pairs to configure HornetQ ServerLocator. Optional property and defaults to null. Valid keys are:
    - HA: true or false (default), true if the ServerLocator receives topology updates from the cluster
    - Properties in ServerLocator class that have corresponding setter method, starting with either upper or lower case character
    See the current version of HornetQ ServerLocator javadoc for supported keys and values, e.g., ServerLocator
    An example of this property in job xml:
    <property name="serverLocatorParams" value="HA=false, AckBatchSize=5, ProducerMaxRate=10, BlockOnAcknowledge=false, ConfirmationWindowSize=5"/>
  - queueParams
```
@Inject
protected Map queueParams
```
    Key-value pairs to identify and configure the target HornetQ queue. Required property.
    The following keys are supported:
    - "address", required
    - "durable", optional
    - "filter", optional
    - "name", optional
    - "shared", optional
    - "temporary", optional
    An example of queueParams property in job xml:
    <property name="queueParams" value="address=example, durable=false"/>
  - sendAcknowledgementHandler
```
@Inject
protected Class sendAcknowledgementHandler
```
    The fully-qualified name of a class that implements org.hornetq.api.core.client.SendAcknowledgementHandler. A SendAcknowledgementHandler notifies a client when an message sent asynchronously has been received by the server. See current version of HornetQ documentation for details, e.g., SendAcknowledgementHandler
    An example sendAcknowledgementHandler property in job xml:
    <property name="sendAcknowledgementHandler" value="org.jberet.support.io.HornetQReaderWriterTest$HornetQSendAcknowledgementHandler"/>
  - queueAddress
```
protected org.hornetq.api.core.SimpleString queueAddress
```
  - queueName
```
protected org.hornetq.api.core.SimpleString queueName
```
  - serverLocator
```
protected org.hornetq.api.core.client.ServerLocator serverLocator
```
  - sessionFactory
```
protected org.hornetq.api.core.client.ClientSessionFactory sessionFactory
```
  - session
```
protected org.hornetq.api.core.client.ClientSession session
```
- Constructor Detail
  - HornetQItemReaderWriterBase
```
public HornetQItemReaderWriterBase()
```
- Method Detail
  - open
```
public void open(Serializable checkpoint)
          throws Exception
```
    Throws:
    
    Exception
  - checkpointInfo
```
public Serializable checkpointInfo()
                            throws Exception
```
    Throws:
    
    Exception
  - configureServerLocator
```
protected void configureServerLocator()
                               throws Exception
```
    Throws:
    
    Exception
  - close
```
protected void close()
```
  - objectToBytes
```
protected static byte[] objectToBytes(Object obj)
                               throws IOException
```
    Throws:
    
    IOException
  - bytesToSerializableObject
```
protected static Serializable bytesToSerializableObject(byte[] bytes)
                                                 throws IOException,
                                                        ClassNotFoundException
```
    Throws:
    
    IOException
    
    ClassNotFoundException

Class HornetQItemReaderWriterBase

Field Summary

Fields inherited from class org.jberet.support.io.ItemReaderWriterBase

Constructor Summary

Method Summary

Methods inherited from class org.jberet.support.io.ItemReaderWriterBase

Methods inherited from class java.lang.Object

Field Detail

QUEUE_NAME_KEY

QUEUE_ADDRESS_KEY

QUEUE_FILTER_KEY

QUEUE_DURABLE_KEY

QUEUE_SHARED_KEY

QUEUE_TEMPORARY_KEY

SERVER_LOCATOR_HA_KEY

NAME_KEY

FACTORY_CLASS_KEY

serverLocatorInstance

sessionFactoryInstance

connectorFactoryParams

serverLocatorParams

queueParams

sendAcknowledgementHandler

queueAddress

queueName

serverLocator

sessionFactory

session

Constructor Detail

HornetQItemReaderWriterBase

Method Detail

open

checkpointInfo

configureServerLocator

close

objectToBytes

bytesToSerializableObject