Class WebEditorSocket

java.lang.Object

me.lucko.luckperms.common.webeditor.socket.WebEditorSocket

public class WebEditorSocket
extends Object

Constructor Summary

Constructors

Constructor	Description
WebEditorSocket(LuckPermsPlugin plugin, Sender sender, WebEditorSession session)

Method Summary

Modifier and Type	Method	Description
void	appendDetailToRequest(WebEditorRequest request)	Adds detail about the socket channel and the plugin public key to the editor request payload that gets sent via bytebin to the viewer.
void	close()
LuckPermsPlugin	getPlugin()
PublicKey	getRemotePublicKey()
Sender	getSender()
WebEditorSession	getSession()
BytesocksClient.Socket	getSocket()
void	initialize(BytesocksClient client)	Initializes the socket connection.
boolean	isClosed()
void	scheduleCleanupIfUnused()
void	send(com.google.gson.JsonObject msg)	Send a message to the socket.
void	setRemotePublicKey(PublicKey remotePublicKey)
boolean	trustConnection(String nonce)
void	waitForConnect(long timeout, TimeUnit unit)	Waits the specified amount of time for the socket to connect, before throwing an exception if a timeout occurs.

Methods inherited from class Object

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

Constructor Details

WebEditorSocket

public WebEditorSocket(LuckPermsPlugin plugin,
 Sender sender,
 WebEditorSession session)

Method Details

initialize

public void initialize(BytesocksClient client)
                throws UnsuccessfulRequestException,
IOException

Initializes the socket connection.

Parameters:

client - the bytesocks client to connect to

Throws:

UnsuccessfulRequestException - if the request fails

IOException - if an i/o error occurs

waitForConnect

public void waitForConnect(long timeout,
 TimeUnit unit)

Waits the specified amount of time for the socket to connect, before throwing an exception if a timeout occurs.

Parameters:

timeout - the timeout

unit - the timeout unit

appendDetailToRequest

public void appendDetailToRequest(WebEditorRequest request)

Adds detail about the socket channel and the plugin public key to the editor request payload that gets sent via bytebin to the viewer.

Parameters:

request - the request

send

public void send(com.google.gson.JsonObject msg)

Send a message to the socket.

The message will be encoded as JSON and signed using the public public key.

Parameters:

msg - the message

trustConnection

public boolean trustConnection(String nonce)

scheduleCleanupIfUnused

public void scheduleCleanupIfUnused()

close

public void close()

getPlugin

public LuckPermsPlugin getPlugin()

getSender

public Sender getSender()

getSession

public WebEditorSession getSession()

getSocket

public BytesocksClient.Socket getSocket()

getRemotePublicKey

public PublicKey getRemotePublicKey()

setRemotePublicKey

public void setRemotePublicKey(PublicKey remotePublicKey)

isClosed

public boolean isClosed()