org.eclipse.lsp4j.services

Interface LanguageServer

public interface LanguageServer

Interface for implementations of https://github.com/Microsoft/vscode-languageserver-protocol

Method Summary

Modifier and Type	Method and Description
default void	cancelProgress(WorkDoneProgressCancelParams params) This notification is sent from the client to the server to cancel a progress initiated on the server side.
void	exit() A notification to ask the server to exit its process.
TextDocumentService	getTextDocumentService() Provides access to the textDocument services.
WorkspaceService	getWorkspaceService() Provides access to the workspace services.
java.util.concurrent.CompletableFuture<InitializeResult>	initialize(InitializeParams params) The initialize request is sent as the first request from the client to the server.
default void	initialized() Deprecated. Use initialized(InitializedParams) instead.
default void	initialized(InitializedParams params) The initialized notification is sent from the client to the server after the client received the result of the initialize request, but before the client is sending any other request or notification to the server.
default void	setTrace(SetTraceParams params) A notification that should be used by the client to modify the trace setting of the server.
java.util.concurrent.CompletableFuture<java.lang.Object>	shutdown() The shutdown request is sent from the client to the server.

Method Detail

initialize

java.util.concurrent.CompletableFuture<InitializeResult> initialize(InitializeParams params)

The initialize request is sent as the first request from the client to the server.

If the server receives requests or notifications before the initialize request, it should act as follows:

• for a request, the response should be errored with: ResponseErrorCode.ServerNotInitialized. The message can be picked by the server.
• notifications should be dropped, except for the exit notification. This will allow the client to exit a server without an initialize request.

Until the server has responded to the initialize request with an InitializeResult, the client must not send any additional requests or notifications to the server.

During the initialize request, the server is allowed to send the notifications window/showMessage, window/logMessage, and telemetry/event, as well as the request window/showMessageRequest, to the client.

initialized

default void initialized(InitializedParams params)

The initialized notification is sent from the client to the server after the client received the result of the initialize request, but before the client is sending any other request or notification to the server. The server can use the initialized notification, for example, to dynamically register capabilities.

initialized

@Deprecated
default void initialized()

Deprecated. Use initialized(InitializedParams) instead.

shutdown

java.util.concurrent.CompletableFuture<java.lang.Object> shutdown()

The shutdown request is sent from the client to the server. It asks the server to shutdown, but to not exit (otherwise the response might not be delivered correctly to the client). There is a separate exit notification that asks the server to exit.

exit

void exit()

A notification to ask the server to exit its process.

getTextDocumentService

TextDocumentService getTextDocumentService()

Provides access to the textDocument services.

getWorkspaceService

WorkspaceService getWorkspaceService()

Provides access to the workspace services.

cancelProgress

default void cancelProgress(WorkDoneProgressCancelParams params)

This notification is sent from the client to the server to cancel a progress initiated on the server side.

Since 3.15.0

setTrace

default void setTrace(SetTraceParams params)

A notification that should be used by the client to modify the trace setting of the server.

Since 3.16.0