me.ahoo.pigeon.core.message

类 MessageHeader

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<java.lang.String,java.lang.Object>

me.ahoo.pigeon.core.message.MessageHeader

所有已实现的接口:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public class MessageHeader
extends java.util.HashMap<java.lang.String,java.lang.Object>

另请参阅:

序列化表格

嵌套类概要

嵌套类

限定符和类型	类和说明
static interface	MessageHeader.Headers

从类继承的嵌套类/接口 java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

从接口继承的嵌套类/接口 java.util.Map

java.util.Map.Entry<K,V>

构造器概要

构造器

构造器和说明
MessageHeader()

方法概要

限定符和类型	方法和说明
java.lang.String	getApp(boolean required)
java.lang.String	getClientIp(boolean required)
java.lang.String	getClientMessageId(boolean required) 用于 服务端 发送 ACK 消息 给客户端
java.lang.String	getCommandType(boolean required)
java.lang.Long	getCreateTime(boolean required)
RouteDirection	getDirection(boolean required)
java.lang.String	getErrorCode(boolean required)
java.lang.String	getErrorMsg(boolean required)
java.lang.String	getFilterExpression(boolean required)
<TValue> TValue	getGenericValue(java.lang.String key, java.lang.Class<TValue> valClass, boolean required, com.google.common.base.Function<java.lang.Object,TValue> converter)
java.lang.Long	getId(boolean required)
java.lang.Integer	getIntegerValue(java.lang.String key, boolean required)
java.lang.Long	getLongValue(java.lang.String key, boolean required)
java.lang.String	getReceiverChannelId(boolean required)
java.lang.Integer	getReceiverConnectorId(boolean required)
java.lang.Long	getReceiverDeviceId(boolean required)
java.lang.Long	getReceiverGroupId(boolean required)
java.lang.Long	getReceiverRoomId(boolean required)
java.lang.Long	getReceiverUserId(boolean required)
java.lang.Integer	getRetryTimes(boolean required)
java.lang.String	getSenderChannelId(boolean required)
java.lang.Integer	getSenderConnectorId(boolean required)
java.lang.Long	getSenderDeviceId(boolean required)
java.lang.Long	getSenderUserId(boolean required)
SendMode	getSendMode(boolean required)
java.lang.Long	getServerMessageId(boolean required) 用于 客户端 发送 ACK 消息 给服务端
java.lang.String	getStringValue(java.lang.String key, boolean required)
boolean	isRetry()
MessageHeader	ofNow() set System.currentTimeMillis() to create time
MessageHeader	setApp(java.lang.String app)
MessageHeader	setClientIp(java.lang.String clientIp)
MessageHeader	setClientMessageId(java.lang.String clientMessageId)
MessageHeader	setCommandType(java.lang.String commandType)
MessageHeader	setCreateTime(java.lang.Long createTime)
MessageHeader	setDirection(RouteDirection direction)
MessageHeader	setErrorCode(java.lang.String errorCode)
MessageHeader	setErrorMsg(java.lang.String errorMsg)
MessageHeader	setFilterExpression(java.lang.String filterExpression)
MessageHeader	setId(java.lang.Long id)
MessageHeader	setReceiverChannelId(java.lang.String receiverChannelId) set MessageHeader.Headers.RECEIVER_CHANNEL_ID and setSendModeIfAbsent SendMode.TO_CHANNEL
MessageHeader	setReceiverConnectorId(java.lang.Integer receiverConnectorId)
MessageHeader	setReceiverDeviceId(java.lang.Long receiverDeviceId) set MessageHeader.Headers.RECEIVER_DEVICE_ID and setSendModeIfAbsent SendMode.TO_DEVICE
MessageHeader	setReceiverGroupId(java.lang.Long receiverGroupId) set MessageHeader.Headers.RECEIVER_GROUP_ID and setSendModeIfAbsent SendMode.TO_GROUP
MessageHeader	setReceiverRoomId(java.lang.Long receiverRoomId) set MessageHeader.Headers.RECEIVER_ROOM_ID and setSendModeIfAbsent SendMode.TO_ROOM
MessageHeader	setReceiverUserId(java.lang.Long receiverUserId) set MessageHeader.Headers.RECEIVER_USER_ID and setSendModeIfAbsent SendMode.TO_USER
MessageHeader	setRetryTimes(java.lang.Integer retryTimes)
MessageHeader	setSenderChannelId(java.lang.String senderChannelId)
MessageHeader	setSenderConnectorId(java.lang.Integer senderConnectorId)
MessageHeader	setSenderDeviceId(java.lang.Long senderDeviceId)
MessageHeader	setSenderUserId(java.lang.Long senderUserId)
MessageHeader	setSendMode(SendMode sendMode)
MessageHeader	setSendModeIfAbsent(SendMode sendMode)
MessageHeader	setServerMessageId(java.lang.Long serverMessageId)

从类继承的方法 java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

从类继承的方法 java.util.AbstractMap

equals, hashCode, toString

从类继承的方法 java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 java.util.Map

equals, hashCode

构造器详细资料

MessageHeader

public MessageHeader()

方法详细资料

getGenericValue

public <TValue> TValue getGenericValue(java.lang.String key,
                                       java.lang.Class<TValue> valClass,
                                       boolean required,
                                       com.google.common.base.Function<java.lang.Object,TValue> converter)

getStringValue

public java.lang.String getStringValue(java.lang.String key,
                                       boolean required)

getIntegerValue

public java.lang.Integer getIntegerValue(java.lang.String key,
                                         boolean required)

getLongValue

public java.lang.Long getLongValue(java.lang.String key,
                                   boolean required)

getDirection

public RouteDirection getDirection(boolean required)

setDirection

public MessageHeader setDirection(RouteDirection direction)

getCommandType

public java.lang.String getCommandType(boolean required)

setCommandType

public MessageHeader setCommandType(java.lang.String commandType)

getId

public java.lang.Long getId(boolean required)

setId

public MessageHeader setId(java.lang.Long id)

setSendMode

public MessageHeader setSendMode(SendMode sendMode)

setSendModeIfAbsent

public MessageHeader setSendModeIfAbsent(SendMode sendMode)

getSendMode

public SendMode getSendMode(boolean required)

getClientMessageId

public java.lang.String getClientMessageId(boolean required)

用于 服务端 发送 ACK 消息 给客户端

参数:

required -

返回:

setClientMessageId

public MessageHeader setClientMessageId(java.lang.String clientMessageId)

getServerMessageId

public java.lang.Long getServerMessageId(boolean required)

用于 客户端 发送 ACK 消息 给服务端

参数:

required -

返回:

setServerMessageId

public MessageHeader setServerMessageId(java.lang.Long serverMessageId)

getSenderConnectorId

public java.lang.Integer getSenderConnectorId(boolean required)

setSenderConnectorId

public MessageHeader setSenderConnectorId(java.lang.Integer senderConnectorId)

getSenderUserId

public java.lang.Long getSenderUserId(boolean required)

setSenderUserId

public MessageHeader setSenderUserId(java.lang.Long senderUserId)

getSenderChannelId

public java.lang.String getSenderChannelId(boolean required)

setSenderChannelId

public MessageHeader setSenderChannelId(java.lang.String senderChannelId)

getSenderDeviceId

public java.lang.Long getSenderDeviceId(boolean required)

setSenderDeviceId

public MessageHeader setSenderDeviceId(java.lang.Long senderDeviceId)

getCreateTime

public java.lang.Long getCreateTime(boolean required)

setCreateTime

public MessageHeader setCreateTime(java.lang.Long createTime)

ofNow

public MessageHeader ofNow()

set System.currentTimeMillis() to create time

返回:

getReceiverChannelId

public java.lang.String getReceiverChannelId(boolean required)

setReceiverChannelId

public MessageHeader setReceiverChannelId(java.lang.String receiverChannelId)

set MessageHeader.Headers.RECEIVER_CHANNEL_ID and setSendModeIfAbsent SendMode.TO_CHANNEL

参数:

receiverChannelId -

返回:

getReceiverDeviceId

public java.lang.Long getReceiverDeviceId(boolean required)

setReceiverDeviceId

public MessageHeader setReceiverDeviceId(java.lang.Long receiverDeviceId)

set MessageHeader.Headers.RECEIVER_DEVICE_ID and setSendModeIfAbsent SendMode.TO_DEVICE

参数:

receiverDeviceId -

返回:

getReceiverUserId

public java.lang.Long getReceiverUserId(boolean required)

setReceiverUserId

public MessageHeader setReceiverUserId(java.lang.Long receiverUserId)

set MessageHeader.Headers.RECEIVER_USER_ID and setSendModeIfAbsent SendMode.TO_USER

参数:

receiverUserId -

返回:

getReceiverGroupId

public java.lang.Long getReceiverGroupId(boolean required)

setReceiverGroupId

public MessageHeader setReceiverGroupId(java.lang.Long receiverGroupId)

set MessageHeader.Headers.RECEIVER_GROUP_ID and setSendModeIfAbsent SendMode.TO_GROUP

参数:

receiverGroupId -

返回:

getReceiverRoomId

public java.lang.Long getReceiverRoomId(boolean required)

setReceiverRoomId

public MessageHeader setReceiverRoomId(java.lang.Long receiverRoomId)

set MessageHeader.Headers.RECEIVER_ROOM_ID and setSendModeIfAbsent SendMode.TO_ROOM

参数:

receiverRoomId -

返回:

getReceiverConnectorId

public java.lang.Integer getReceiverConnectorId(boolean required)

setReceiverConnectorId

public MessageHeader setReceiverConnectorId(java.lang.Integer receiverConnectorId)

getFilterExpression

public java.lang.String getFilterExpression(boolean required)

setFilterExpression

public MessageHeader setFilterExpression(java.lang.String filterExpression)

getErrorCode

public java.lang.String getErrorCode(boolean required)

setErrorCode

public MessageHeader setErrorCode(java.lang.String errorCode)

getErrorMsg

public java.lang.String getErrorMsg(boolean required)

setErrorMsg

public MessageHeader setErrorMsg(java.lang.String errorMsg)

getClientIp

public java.lang.String getClientIp(boolean required)

setClientIp

public MessageHeader setClientIp(java.lang.String clientIp)

getRetryTimes

public java.lang.Integer getRetryTimes(boolean required)

setRetryTimes

public MessageHeader setRetryTimes(java.lang.Integer retryTimes)

isRetry

public boolean isRetry()

getApp

public java.lang.String getApp(boolean required)

setApp

public MessageHeader setApp(java.lang.String app)