程序包 cn.afternode.commons.bungee.messaging

类 BungeeMessagingHelper

java.lang.Object

cn.afternode.commons.bungee.messaging.BungeeMessagingHelper

public class BungeeMessagingHelper
extends Object

Messaging helper with signing support

构造器概要

构造器

构造器	说明
BungeeMessagingHelper(net.md_5.bungee.api.plugin.Plugin plugin)	Primary constructor

方法概要

修饰符和类型	方法	说明
byte[]	combineSign(NBungeeByteBuf buf)	Sign data and combine to a byte array
net.md_5.bungee.api.plugin.Plugin	getPlugin()	Get context plugin
MessageChannelContext	register(String channel, IMessageListener listener)	Register an incoming and outgoing channel
void	setKey(String key)	Set signing key (HmacSHA256)
byte[]	sign(byte[] data)	Generate data sign
boolean	signingAvailable()	Check if signing is available
boolean	validate(byte[] sign, byte[] data)	Validate a sign
NBungeeByteBuf	validateCombined(NBungeeByteBuf buf)	Validate combined signed data

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

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

构造器详细资料

BungeeMessagingHelper

public BungeeMessagingHelper(net.md_5.bungee.api.plugin.Plugin plugin)

Primary constructor

参数:

plugin - Context plugin

方法详细资料

register

public MessageChannelContext register(String channel,
 IMessageListener listener)

Register an incoming and outgoing channel

参数:

channel - Channel name

listener - Message listener

返回:

Channel context

signingAvailable

public boolean signingAvailable()

Check if signing is available

返回:

Is signing available

setKey

public void setKey(String key)

Set signing key (HmacSHA256)

参数:

key - HmacSHA256 key, the recommended size is 64 bytes

sign

public byte[] sign(byte[] data)
            throws NoSuchAlgorithmException,
InvalidKeyException

Generate data sign

参数:

data - Data

返回:

Sign

抛出:

NoSuchAlgorithmException - Mac.getInstance error

InvalidKeyException - If the given key is inappropriate for initializing this MAC

IllegalStateException - Signing not available

另请参阅:

• setKey(String)
• Mac.getInstance(String)
• Mac.init(Key)

combineSign

public byte[] combineSign(NBungeeByteBuf buf)
                   throws NoSuchAlgorithmException,
InvalidKeyException

Sign data and combine to a byte array

参数:

buf - Data

返回:

Combined sign and data

抛出:

NoSuchAlgorithmException - Mac.getInstance error

InvalidKeyException - If the given key is inappropriate for initializing this MAC

另请参阅:

• sign(byte[])
• validateCombined(NBungeeByteBuf)

validate

public boolean validate(byte[] sign,
 byte[] data)
                 throws InvalidKeyException,
NoSuchAlgorithmException

Validate a sign

参数:

sign - Sign

data - Data

返回:

If sign is valid

抛出:

NoSuchAlgorithmException - Mac.getInstance error

InvalidKeyException - If the given key is inappropriate for initializing this MAC

validateCombined

public NBungeeByteBuf validateCombined(NBungeeByteBuf buf)
                                throws NoSuchAlgorithmException,
InvalidKeyException

Validate combined signed data

参数:

buf - Data

返回:

Data body, or null if sign is invalid

抛出:

NoSuchAlgorithmException - Mac.getInstance error

InvalidKeyException - If the given key is inappropriate for initializing this MAC

另请参阅:

• combineSign(NBungeeByteBuf)
• validate(byte[], byte[])

getPlugin

public net.md_5.bungee.api.plugin.Plugin getPlugin()

Get context plugin

返回:

Context plugin