com.aliyun.openservices.ons.api.ONSFactory Maven / Gradle / Ivy
package com.aliyun.openservices.ons.api;
import com.aliyun.openservices.ons.api.batch.BatchConsumer;
import com.aliyun.openservices.ons.api.order.OrderConsumer;
import com.aliyun.openservices.ons.api.order.OrderProducer;
import com.aliyun.openservices.ons.api.transaction.LocalTransactionChecker;
import com.aliyun.openservices.ons.api.transaction.TransactionProducer;
import java.util.Properties;
/**
* ONS客户端工厂类，用来创建客户端对象
*/
public class ONSFactory {
/**
* 工厂实现类实例. 单例模式.
*/
private static ONSFactoryAPI onsFactory = null;
static {
try {
// ons client 优先加载
Class factoryClass =
ONSFactory.class.getClassLoader().loadClass(
"com.aliyun.openservices.ons.api.impl.ONSFactoryNotifyAndMetaQImpl");
onsFactory = (ONSFactoryAPI) factoryClass.newInstance();
} catch (Throwable e) {
try {
Class factoryClass =
ONSFactory.class.getClassLoader().loadClass(
"com.aliyun.openservices.ons.api.impl.ONSFactoryImpl");
onsFactory = (ONSFactoryAPI) factoryClass.newInstance();
} catch (Throwable e1) {
e.printStackTrace();
e1.printStackTrace();
}
}
}
/**
* 创建Producer
*
*
* properties
* 应该至少包含以下几项必选配置内容:
*
* - {@link PropertyKeyConst#ProducerId}
* - {@link PropertyKeyConst#AccessKey}
* - {@link PropertyKeyConst#SecretKey}
* - {@link PropertyKeyConst#ONSAddr}
*
* 以下为可选内容
*
* - {@link PropertyKeyConst#OnsChannel}
* - {@link PropertyKeyConst#SendMsgTimeoutMillis}
* - {@link PropertyKeyConst#NAMESRV_ADDR} 该属性会覆盖{@link PropertyKeyConst#ONSAddr}
*
*
*
*
* 返回创建的{@link Producer}实例是线程安全, 可复用, 发送各个主题. 一般情况下, 一个进程中构建一个实例足够满足发送消息的需求.
*
*
*
* 示例代码:
*
* Properties props = ...;
* // 设置必要的属性
* Producer producer = ONSFactory.createProducer(props);
* producer.start();
*
* //producer之后可以当成单例使用
*
* // 发送消息
* Message msg = ...;
* SendResult result = produer.send(msg);
*
* // 应用程序关闭退出时
* producer.shutdown();
*
*
*
* @param properties Producer的配置参数
* @return {@link Producer} 实例
*/
public static Producer createProducer(final Properties properties) {
return onsFactory.createProducer(properties);
}
/**
* 创建顺序Producer
*
* properties应该至少包含以下几项配置内容:
*
* - {@link PropertyKeyConst#ProducerId}
* - {@link PropertyKeyConst#AccessKey}
* - {@link PropertyKeyConst#SecretKey}
* - {@link PropertyKeyConst#ONSAddr}
*
* 以下为可选配置项:
*
* - {@link PropertyKeyConst#NAMESRV_ADDR}
* - {@link PropertyKeyConst#OnsChannel}
* - {@link PropertyKeyConst#SendMsgTimeoutMillis}
*
*
*
* @param properties Producer的配置参数
* @return {@code OrderProducer} 实例
*/
public static OrderProducer createOrderProducer(final Properties properties) {
return onsFactory.createOrderProducer(properties);
}
/**
* 创建事务Producer
*
* properties应该至少包含以下几项配置内容:
*
* - {@link PropertyKeyConst#ProducerId}
* - {@link PropertyKeyConst#AccessKey}
* - {@link PropertyKeyConst#SecretKey}
* - {@link PropertyKeyConst#ONSAddr}
*
* 以下为可选配置项:
*
* - {@link PropertyKeyConst#NAMESRV_ADDR}
* - {@link PropertyKeyConst#OnsChannel}
* - {@link PropertyKeyConst#SendMsgTimeoutMillis}
* - {@link PropertyKeyConst#CheckImmunityTimeInSeconds}
*
*
* @param properties Producer的配置参数
* @return {@code TransactionProducer} 实例
*/
public static TransactionProducer createTransactionProducer(final Properties properties,
final LocalTransactionChecker checker) {
return onsFactory.createTransactionProducer(properties, checker);
}
/**
* 创建Consumer
*
* properties应该至少包含以下几项配置内容:
*
* - {@link PropertyKeyConst#ConsumerId}
* - {@link PropertyKeyConst#AccessKey}
* - {@link PropertyKeyConst#SecretKey}
* - {@link PropertyKeyConst#ONSAddr}
*
* 以下为可选配置项:
*
* - {@link PropertyKeyConst#ConsumeThreadNums}
* - {@link PropertyKeyConst#ConsumeTimeout}
* - {@link PropertyKeyConst#OnsChannel}
*
*
* @param properties Consumer的配置参数
* @return {@code Consumer} 实例
*/
public static Consumer createConsumer(final Properties properties) {
return onsFactory.createConsumer(properties);
}
/**
* 创建BatchConsumer
*
* properties应该至少包含以下几项配置内容:
*
* - {@link PropertyKeyConst#ConsumerId}
* - {@link PropertyKeyConst#AccessKey}
* - {@link PropertyKeyConst#SecretKey}
* - {@link PropertyKeyConst#ONSAddr}
*
* 以下为可选配置项:
*
* - {@link PropertyKeyConst#ConsumeThreadNums}
* - {@link PropertyKeyConst#ConsumeTimeout}
* - {@link PropertyKeyConst#ConsumeMessageBatchMaxSize}
* - {@link PropertyKeyConst#OnsChannel}
*
*
* @param properties BatchConsumer的配置参数
* @return {@code BatchConsumer} 实例
*/
public static BatchConsumer createBatchConsumer(final Properties properties) {
return onsFactory.createBatchConsumer(properties);
}
/**
* 创建顺序Consumer
*
* properties应该至少包含以下几项必须配置内容:
*
* - {@link PropertyKeyConst#ProducerId}
* - {@link PropertyKeyConst#AccessKey}
* - {@link PropertyKeyConst#SecretKey}
* - {@link PropertyKeyConst#ONSAddr}
*
* 以下为可选配置项:
*
* - {@link PropertyKeyConst#ConsumeThreadNums}
* - {@link PropertyKeyConst#ConsumeTimeout}
* - {@link PropertyKeyConst#OnsChannel}
*
*
* @param properties Consumer的配置参数
* @return {@code OrderConsumer} 实例
*/
public static OrderConsumer createOrderedConsumer(final Properties properties) {
return onsFactory.createOrderedConsumer(properties);
}
/**
* 创建主动拉取的Consumer
*
* properties应该至少包含以下几项必须配置内容:
*
* - {@link PropertyKeyConst#ProducerId}
* - {@link PropertyKeyConst#AccessKey}
* - {@link PropertyKeyConst#SecretKey}
* - {@link PropertyKeyConst#ONSAddr}
*
* 以下为可选配置项:
*
* - {@link PropertyKeyConst#AUTO_COMMIT}
*
*
* @param properties Consumer的配置参数
* @return {@code PullConsumer} 实例
*/
public static PullConsumer createPullConsumer(final Properties properties) {
return onsFactory.createPullConsumer(properties);
}
}