com.structure.message.plugin.api

Class AbstractMessageChannelPlugin

java.lang.Object

com.structure.message.plugin.api.AbstractMessageChannelPlugin

All Implemented Interfaces:

MessageChannelPlugin

public abstract class AbstractMessageChannelPlugin
extends Object
implements MessageChannelPlugin

消息通道插件抽象基类

Nested Class Summary

Nested classes/interfaces inherited from interface com.structure.message.common.plugin.MessageChannelPlugin

MessageChannelPlugin.ChannelType

Field Summary

Fields

Modifier and Type	Field and Description
protected MessageChannelConfig	config
protected boolean	healthy
protected boolean	initialized

Constructor Summary

Constructors

Constructor and Description
AbstractMessageChannelPlugin()

Method Summary

Modifier and Type	Method and Description
protected MessageResult	createFailureResult(MessageContext context, String errorCode, String errorMsg) 创建失败的消息结果
protected MessageResult	createSuccessResult(MessageContext context, Object responseData) 创建成功的消息结果
void	destroy()
protected abstract void	doDestroy() 具体的销毁逻辑，子类实现
protected abstract void	doInitialize(MessageChannelConfig config) 具体的初始化逻辑，子类实现
protected abstract MessageResult	doSend(MessageContext context) 具体的发送逻辑，子类实现
protected abstract boolean	doValidate(MessageContext context) 具体的验证逻辑，子类实现
void	initialize(MessageChannelConfig config)
boolean	isHealthy()
MessageResult	send(MessageContext context)
List<MessageResult>	sendBatch(List<MessageContext> contexts)
boolean	validate(MessageContext context)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.structure.message.common.plugin.MessageChannelPlugin

getChannelCode, getChannelName, getChannelType

Field Detail

config

protected MessageChannelConfig config

initialized

protected volatile boolean initialized

healthy

protected volatile boolean healthy

Constructor Detail

AbstractMessageChannelPlugin

public AbstractMessageChannelPlugin()

Method Detail

initialize

public void initialize(MessageChannelConfig config)
                throws MessageException

Specified by:

initialize in interface MessageChannelPlugin

Throws:

MessageException

send

public MessageResult send(MessageContext context)
                   throws MessageException

Specified by:

send in interface MessageChannelPlugin

Throws:

MessageException

sendBatch

public List<MessageResult> sendBatch(List<MessageContext> contexts)
                              throws MessageException

Specified by:

sendBatch in interface MessageChannelPlugin

Throws:

MessageException

validate

public boolean validate(MessageContext context)

Specified by:

validate in interface MessageChannelPlugin

isHealthy

public boolean isHealthy()

Specified by:

isHealthy in interface MessageChannelPlugin

destroy

public void destroy()

Specified by:

destroy in interface MessageChannelPlugin

doInitialize

protected abstract void doInitialize(MessageChannelConfig config)
                              throws Exception

具体的初始化逻辑，子类实现

Throws:

Exception

doSend

protected abstract MessageResult doSend(MessageContext context)
                                 throws Exception

具体的发送逻辑，子类实现

Throws:

Exception

doValidate

protected abstract boolean doValidate(MessageContext context)

具体的验证逻辑，子类实现

doDestroy

protected abstract void doDestroy()
                           throws Exception

具体的销毁逻辑，子类实现

Throws:

Exception

createSuccessResult

protected MessageResult createSuccessResult(MessageContext context,
                                            Object responseData)

创建成功的消息结果

createFailureResult

protected MessageResult createFailureResult(MessageContext context,
                                            String errorCode,
                                            String errorMsg)

创建失败的消息结果