Class LuckPermsMessagingService

java.lang.Object

me.lucko.luckperms.common.util.AsyncInterface

me.lucko.luckperms.common.messaging.LuckPermsMessagingService

All Implemented Interfaces:

InternalMessagingService, net.luckperms.api.messenger.IncomingMessageConsumer

public class LuckPermsMessagingService
extends AsyncInterface
implements InternalMessagingService, net.luckperms.api.messenger.IncomingMessageConsumer

Constructor Summary

Constructors

Constructor	Description
LuckPermsMessagingService(LuckPermsPlugin plugin, net.luckperms.api.messenger.MessengerProvider messengerProvider)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the messaging service
boolean	consumeIncomingMessage(@NonNull net.luckperms.api.messenger.message.Message message)
boolean	consumeIncomingMessageAsString(@NonNull String encodedString)
static String	encodeMessageAsString(String type, UUID id, @Nullable com.google.gson.JsonElement content)
net.luckperms.api.messenger.Messenger	getMessenger()
net.luckperms.api.messenger.MessengerProvider	getMessengerProvider()
String	getName()	Gets the name of this messaging service
BufferedRequest<Void>	getUpdateBuffer()	Gets the buffer for sending updates to other servers
CompletableFuture<Void>	pushCustomPayload(String channelId, String payload)	Pushes a custom payload to connected servers.
CompletableFuture<Void>	pushLog(net.luckperms.api.actionlog.Action logEntry)	Pushes a log entry to connected servers.
CompletableFuture<Void>	pushUpdate()	Uses the messaging service to inform other servers about a general change.
CompletableFuture<Void>	pushUserUpdate(User user)	Pushes an update for a specific user.

Methods inherited from class AsyncInterface

future, future

Methods inherited from class Object

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

Constructor Details

LuckPermsMessagingService

public LuckPermsMessagingService(LuckPermsPlugin plugin,
 net.luckperms.api.messenger.MessengerProvider messengerProvider)

Method Details

getName

public String getName()

Description copied from interface: InternalMessagingService

Gets the name of this messaging service

Specified by:

getName in interface InternalMessagingService

Returns:

the name of this messaging service

getMessenger

public net.luckperms.api.messenger.Messenger getMessenger()

Specified by:

getMessenger in interface InternalMessagingService

getMessengerProvider

public net.luckperms.api.messenger.MessengerProvider getMessengerProvider()

Specified by:

getMessengerProvider in interface InternalMessagingService

close

public void close()

Description copied from interface: InternalMessagingService

Closes the messaging service

Specified by:

close in interface InternalMessagingService

getUpdateBuffer

public BufferedRequest<Void> getUpdateBuffer()

Description copied from interface: InternalMessagingService

Gets the buffer for sending updates to other servers

Specified by:

getUpdateBuffer in interface InternalMessagingService

Returns:

the update buffer

pushUpdate

public CompletableFuture<Void> pushUpdate()

Description copied from interface: InternalMessagingService

Uses the messaging service to inform other servers about a general change.

Specified by:

pushUpdate in interface InternalMessagingService

pushUserUpdate

public CompletableFuture<Void> pushUserUpdate(User user)

Description copied from interface: InternalMessagingService

Pushes an update for a specific user.

Specified by:

pushUserUpdate in interface InternalMessagingService

Parameters:

user - the user

pushLog

public CompletableFuture<Void> pushLog(net.luckperms.api.actionlog.Action logEntry)

Description copied from interface: InternalMessagingService

Pushes a log entry to connected servers.

Specified by:

pushLog in interface InternalMessagingService

Parameters:

logEntry - the log entry

pushCustomPayload

public CompletableFuture<Void> pushCustomPayload(String channelId,
 String payload)

Description copied from interface: InternalMessagingService

Pushes a custom payload to connected servers.

Specified by:

pushCustomPayload in interface InternalMessagingService

Parameters:

channelId - the channel id

payload - the payload

consumeIncomingMessage

public boolean consumeIncomingMessage(@NonNull net.luckperms.api.messenger.message.Message message)

Specified by:

consumeIncomingMessage in interface net.luckperms.api.messenger.IncomingMessageConsumer

consumeIncomingMessageAsString

public boolean consumeIncomingMessageAsString(@NonNull String encodedString)

Specified by:

consumeIncomingMessageAsString in interface net.luckperms.api.messenger.IncomingMessageConsumer

encodeMessageAsString

public static String encodeMessageAsString(String type,
 UUID id,
 @Nullable com.google.gson.JsonElement content)