Package org.eclipse.lsp4j.jsonrpc

Class RemoteEndpoint

java.lang.Object

org.eclipse.lsp4j.jsonrpc.RemoteEndpoint

All Implemented Interfaces:

Endpoint, MethodProvider, MessageConsumer, MessageIssueHandler

public class RemoteEndpoint
extends java.lang.Object
implements Endpoint, MessageConsumer, MessageIssueHandler, MethodProvider

An endpoint that can be used to send messages to a given MessageConsumer by calling request(String, Object) or notify(String, Object). When connected to a MessageProducer, this class forwards received messages to the local Endpoint given in the constructor.

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.function.Function<java.lang.Throwable,ResponseError>	DEFAULT_EXCEPTION_HANDLER

Constructor Summary

Constructors

Constructor	Description
RemoteEndpoint(MessageConsumer out, Endpoint localEndpoint)
RemoteEndpoint(MessageConsumer out, Endpoint localEndpoint, java.util.function.Function<java.lang.Throwable,ResponseError> exceptionHandler)

Method Summary

Modifier and Type	Method	Description
void	consume(Message message)	Consume a single message.
protected ResponseMessage	createErrorResponseMessage(RequestMessage requestMessage, ResponseError errorObject)
protected NotificationMessage	createNotificationMessage(java.lang.String method, java.lang.Object parameter)
protected RequestMessage	createRequestMessage(java.lang.String method, java.lang.Object parameter)
protected ResponseMessage	createResponseMessage(RequestMessage requestMessage)
protected ResponseMessage	createResultResponseMessage(RequestMessage requestMessage, java.lang.Object result)
MessageJsonHandler	getJsonHandler()
void	handle(Message message, java.util.List<MessageIssue> issues)	Handle issues found while parsing or validating a message.
protected boolean	handleCancellation(NotificationMessage notificationMessage)	Cancellation is handled inside this class and not forwarded to the local endpoint.
protected void	handleNotification(NotificationMessage notificationMessage)
protected void	handleRequest(RequestMessage requestMessage)
protected void	handleRequestIssues(RequestMessage requestMessage, java.util.List<MessageIssue> issues)
protected void	handleResponse(ResponseMessage responseMessage)
protected void	handleResponseIssues(ResponseMessage responseMessage, java.util.List<MessageIssue> issues)
protected boolean	isCancellation(java.lang.Throwable t)
protected void	logIssues(Message message, java.util.List<MessageIssue> issues)
void	notify(java.lang.String method, java.lang.Object parameter)	Send a notification to the remote endpoint.
java.util.concurrent.CompletableFuture<java.lang.Object>	request(java.lang.String method, java.lang.Object parameter)	Send a request to the remote endpoint.
java.lang.String	resolveMethod(java.lang.String requestId)	Returns the method name for a given request id, or null if such request id is unknown.
protected void	sendCancelNotification(Either<java.lang.String,java.lang.Number> id)
void	setJsonHandler(MessageJsonHandler jsonHandler)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EXCEPTION_HANDLER

public static final java.util.function.Function<java.lang.Throwable,ResponseError> DEFAULT_EXCEPTION_HANDLER

Constructor Detail

RemoteEndpoint

public RemoteEndpoint(MessageConsumer out,
                      Endpoint localEndpoint,
                      java.util.function.Function<java.lang.Throwable,ResponseError> exceptionHandler)

Parameters:

out - - a consumer that transmits messages to the remote service

localEndpoint - - the local service implementation

exceptionHandler - - an exception handler that should never return null.

RemoteEndpoint

public RemoteEndpoint(MessageConsumer out,
                      Endpoint localEndpoint)

Parameters:

out - - a consumer that transmits messages to the remote service

localEndpoint - - the local service implementation

Method Detail

setJsonHandler

public void setJsonHandler(MessageJsonHandler jsonHandler)

getJsonHandler

public MessageJsonHandler getJsonHandler()

notify

public void notify(java.lang.String method,
                   java.lang.Object parameter)

Send a notification to the remote endpoint.

Specified by:

notify in interface Endpoint

createNotificationMessage

protected NotificationMessage createNotificationMessage(java.lang.String method,
                                                        java.lang.Object parameter)

request

public java.util.concurrent.CompletableFuture<java.lang.Object> request(java.lang.String method,
                                                                        java.lang.Object parameter)

Send a request to the remote endpoint.

Specified by:

request in interface Endpoint

createRequestMessage

protected RequestMessage createRequestMessage(java.lang.String method,
                                              java.lang.Object parameter)

sendCancelNotification

protected void sendCancelNotification(Either<java.lang.String,java.lang.Number> id)

consume

public void consume(Message message)

Description copied from interface: MessageConsumer

Consume a single message.

Specified by:

consume in interface MessageConsumer

handleResponse

protected void handleResponse(ResponseMessage responseMessage)

handleNotification

protected void handleNotification(NotificationMessage notificationMessage)

handleCancellation

protected boolean handleCancellation(NotificationMessage notificationMessage)

Cancellation is handled inside this class and not forwarded to the local endpoint.

Returns:

true if the given message is a cancellation notification, false if it can be handled by the local endpoint

handleRequest

protected void handleRequest(RequestMessage requestMessage)

handle

public void handle(Message message,
                   java.util.List<MessageIssue> issues)

Description copied from interface: MessageIssueHandler

Handle issues found while parsing or validating a message. The list of issues must not be empty.

Specified by:

handle in interface MessageIssueHandler

logIssues

protected void logIssues(Message message,
                         java.util.List<MessageIssue> issues)

handleRequestIssues

protected void handleRequestIssues(RequestMessage requestMessage,
                                   java.util.List<MessageIssue> issues)

handleResponseIssues

protected void handleResponseIssues(ResponseMessage responseMessage,
                                    java.util.List<MessageIssue> issues)

createResponseMessage

protected ResponseMessage createResponseMessage(RequestMessage requestMessage)

createResultResponseMessage

protected ResponseMessage createResultResponseMessage(RequestMessage requestMessage,
                                                      java.lang.Object result)

createErrorResponseMessage

protected ResponseMessage createErrorResponseMessage(RequestMessage requestMessage,
                                                     ResponseError errorObject)

isCancellation

protected boolean isCancellation(java.lang.Throwable t)

resolveMethod

public java.lang.String resolveMethod(java.lang.String requestId)

Description copied from interface: MethodProvider

Returns the method name for a given request id, or null if such request id is unknown.

Specified by:

resolveMethod in interface MethodProvider

Returns:

method name or null