ONSFactory (ons-api 1.8.7.1.Final 1.8.7.1.Final API)

java.lang.Object
- com.aliyun.openservices.ons.api.ONSFactory

```
public class ONSFactory
extends Object
```
ONS客户端工厂类，用来创建客户端对象

Constructor Summary

Constructors
Constructor and Description

ONSFactory()

Constructors
Constructor and Description
`ONSFactory()`

Method Summary

Methods
Modifier and Type	Method and Description
`static BatchConsumer`	`createBatchConsumer(Properties properties)` 创建BatchConsumer `properties`应该至少包含以下几项配置内容: `PropertyKeyConst.ConsumerId` `PropertyKeyConst.AccessKey` `PropertyKeyConst.SecretKey` `PropertyKeyConst.ONSAddr` 以下为可选配置项: `PropertyKeyConst.ConsumeThreadNums` `PropertyKeyConst.ConsumeTimeout` `PropertyKeyConst.ConsumeMessageBatchMaxSize` `PropertyKeyConst.OnsChannel`
`static Consumer`	`createConsumer(Properties properties)` 创建Consumer `properties`应该至少包含以下几项配置内容: `PropertyKeyConst.ConsumerId` `PropertyKeyConst.AccessKey` `PropertyKeyConst.SecretKey` `PropertyKeyConst.ONSAddr` 以下为可选配置项: `PropertyKeyConst.ConsumeThreadNums` `PropertyKeyConst.ConsumeTimeout` `PropertyKeyConst.OnsChannel`
`static OrderConsumer`	`createOrderedConsumer(Properties properties)` 创建顺序Consumer `properties`应该至少包含以下几项必须配置内容: `PropertyKeyConst.ProducerId` `PropertyKeyConst.AccessKey` `PropertyKeyConst.SecretKey` `PropertyKeyConst.ONSAddr` 以下为可选配置项: `PropertyKeyConst.ConsumeThreadNums` `PropertyKeyConst.ConsumeTimeout` `PropertyKeyConst.OnsChannel`
`static OrderProducer`	`createOrderProducer(Properties properties)` 创建顺序Producer `properties`应该至少包含以下几项配置内容: `PropertyKeyConst.ProducerId` `PropertyKeyConst.AccessKey` `PropertyKeyConst.SecretKey` `PropertyKeyConst.ONSAddr` 以下为可选配置项: `PropertyKeyConst.NAMESRV_ADDR` `PropertyKeyConst.OnsChannel` `PropertyKeyConst.SendMsgTimeoutMillis`
`static Producer`	`createProducer(Properties properties)` 创建Producer `properties` 应该至少包含以下几项必选配置内容: `PropertyKeyConst.ProducerId` `PropertyKeyConst.AccessKey` `PropertyKeyConst.SecretKey` `PropertyKeyConst.ONSAddr` 以下为可选内容 `PropertyKeyConst.OnsChannel` `PropertyKeyConst.SendMsgTimeoutMillis` `PropertyKeyConst.NAMESRV_ADDR` 该属性会覆盖`PropertyKeyConst.ONSAddr` 返回创建的`Producer`实例是线程安全, 可复用, 发送各个主题.
`static PullConsumer`	`createPullConsumer(Properties properties)` 创建主动拉取的Consumer `properties`应该至少包含以下几项必须配置内容: `PropertyKeyConst.ProducerId` `PropertyKeyConst.AccessKey` `PropertyKeyConst.SecretKey` `PropertyKeyConst.ONSAddr` 以下为可选配置项: `PropertyKeyConst.AUTO_COMMIT`
`static TransactionProducer`	`createTransactionProducer(Properties properties, LocalTransactionChecker checker)` 创建事务Producer `properties`应该至少包含以下几项配置内容: `PropertyKeyConst.ProducerId` `PropertyKeyConst.AccessKey` `PropertyKeyConst.SecretKey` `PropertyKeyConst.ONSAddr` 以下为可选配置项: `PropertyKeyConst.NAMESRV_ADDR` `PropertyKeyConst.OnsChannel` `PropertyKeyConst.SendMsgTimeoutMillis` `PropertyKeyConst.CheckImmunityTimeInSeconds`

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

- Constructor Detail
  - ONSFactory
```
public ONSFactory()
```
- Method Detail
  - createProducer
```
public static Producer createProducer(Properties properties)
```
    创建Producer
    properties 应该至少包含以下几项必选配置内容:
    以下为可选内容
    1. PropertyKeyConst.OnsChannel
    2. PropertyKeyConst.SendMsgTimeoutMillis
    3. PropertyKeyConst.NAMESRV_ADDR 该属性会覆盖PropertyKeyConst.ONSAddr
    返回创建的Producer实例是线程安全, 可复用, 发送各个主题. 一般情况下, 一个进程中构建一个实例足够满足发送消息的需求.
    
    示例代码:
```
        Properties props = ...;
        // 设置必要的属性
        Producer producer = ONSFactory.createProducer(props);
        producer.start();

        //producer之后可以当成单例使用

        // 发送消息
        Message msg = ...;
        SendResult result = produer.send(msg);

        // 应用程序关闭退出时
        producer.shutdown();
   
```
    Parameters:
    properties - Producer的配置参数
    
    Returns:
    Producer 实例
  - createOrderProducer
```
public static OrderProducer createOrderProducer(Properties properties)
```
    创建顺序Producer
    properties应该至少包含以下几项配置内容:
    以下为可选配置项:
    Parameters:
    properties - Producer的配置参数
    
    Returns:
    OrderProducer 实例
  - createTransactionProducer
```
public static TransactionProducer createTransactionProducer(Properties properties,
                                            LocalTransactionChecker checker)
```
    创建事务Producer
    properties应该至少包含以下几项配置内容:
    以下为可选配置项:
    Parameters:
    properties - Producer的配置参数
    
    Returns:
    TransactionProducer 实例
  - createConsumer
```
public static Consumer createConsumer(Properties properties)
```
    创建Consumer
    properties应该至少包含以下几项配置内容:
    以下为可选配置项:
    Parameters:
    properties - Consumer的配置参数
    
    Returns:
    Consumer 实例
  - createBatchConsumer
```
public static BatchConsumer createBatchConsumer(Properties properties)
```
    创建BatchConsumer
    properties应该至少包含以下几项配置内容:
    以下为可选配置项:
    Parameters:
    properties - BatchConsumer的配置参数
    
    Returns:
    BatchConsumer 实例
  - createOrderedConsumer
```
public static OrderConsumer createOrderedConsumer(Properties properties)
```
    创建顺序Consumer
    properties应该至少包含以下几项必须配置内容:
    以下为可选配置项:
    Parameters:
    properties - Consumer的配置参数
    
    Returns:
    OrderConsumer 实例
  - createPullConsumer
```
public static PullConsumer createPullConsumer(Properties properties)
```
    创建主动拉取的Consumer
    properties应该至少包含以下几项必须配置内容:
    以下为可选配置项:
    - PropertyKeyConst.AUTO_COMMIT
    Parameters:
    properties - Consumer的配置参数
    
    Returns:
    PullConsumer 实例

Class ONSFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ONSFactory

Method Detail

createProducer

createOrderProducer

createTransactionProducer

createConsumer

createBatchConsumer

createOrderedConsumer

createPullConsumer