JabRef 6.0-beta.1 · org.jabref.languageserver.LspClientHandler

Modifier and Type	Field and Description
private LanguageClient	client
private final LspDiagnosticHandler	diagnosticHandler
private final LspLinkHandler	linkHandler
private static final Logger	LOGGER
private final RemoteMessageHandler	messageHandler
private final LspParserHandler	parserHandler
private final ExtensionSettings	settings
private boolean	standalone
private final BibtexTextDocumentService	textDocumentService
private final BibtexWorkspaceService	workspaceService

Modifier and Type

Field and Description

private LanguageClient

client

private final LspDiagnosticHandler

diagnosticHandler

private final LspLinkHandler

linkHandler

private static final Logger

LOGGER

private final RemoteMessageHandler

messageHandler

private final LspParserHandler

parserHandler

private final ExtensionSettings

settings

private boolean

standalone

private final BibtexTextDocumentService

textDocumentService

private final BibtexWorkspaceService

workspaceService

Access	Constructor and Description
public	LspClientHandler(RemoteMessageHandler messageHandler, CliPreferences cliPreferences, JournalAbbreviationRepository abbreviationRepository, BibEntryTypesManager bibEntryTypesManager)
public	LspClientHandler(RemoteMessageHandler messageHandler, CliPreferences cliPreferences, JournalAbbreviationRepository abbreviationRepository, BibEntryTypesManager bibEntryTypesManager, boolean standalone)

Access

Constructor and Description

public

LspClientHandler(RemoteMessageHandler messageHandler, CliPreferences cliPreferences, JournalAbbreviationRepository abbreviationRepository, BibEntryTypesManager bibEntryTypesManager)

public

LspClientHandler(RemoteMessageHandler messageHandler, CliPreferences cliPreferences, JournalAbbreviationRepository abbreviationRepository, BibEntryTypesManager bibEntryTypesManager, boolean standalone)

Modifier and Type	Method and Description
public void	connect(LanguageClient client) Implements org.eclipse.lsp4j.services.LanguageClientAware.connect.
public void	exit() Implements org.eclipse.lsp4j.services.LanguageServer.exit. When running in JabGui: NOOP, because the JabGui has the lifecycle control.
public ExtensionSettings	getSettings()
public TextDocumentService	getTextDocumentService() Implements org.eclipse.lsp4j.services.LanguageServer.getTextDocumentService. Provides access to the textDocument services.
public WorkspaceService	getWorkspaceService() Implements org.eclipse.lsp4j.services.LanguageServer.getWorkspaceService. Provides access to the workspace services.
public CompletableFuture<InitializeResult>	initialize(InitializeParams params) Implements org.eclipse.lsp4j.services.LanguageServer.initialize. The initialize request is sent as the first request from the client to the server.
public boolean	isStandalone()
public CompletableFuture<Object>	shutdown() Implements org.eclipse.lsp4j.services.LanguageServer.shutdown. The shutdown request is sent from the client to the server.

Modifier and Type

Method and Description

public void

connect(LanguageClient client)

Implements org.eclipse.lsp4j.services.LanguageClientAware.connect.

public void

exit()

Implements org.eclipse.lsp4j.services.LanguageServer.exit.

When running in JabGui: NOOP, because the JabGui has the lifecycle control.

public ExtensionSettings

getSettings()

public TextDocumentService

getTextDocumentService()

Implements org.eclipse.lsp4j.services.LanguageServer.getTextDocumentService.

Provides access to the textDocument services.

public WorkspaceService

getWorkspaceService()

Implements org.eclipse.lsp4j.services.LanguageServer.getWorkspaceService.

Provides access to the workspace services.

public CompletableFuture<InitializeResult>

initialize(InitializeParams params)

Implements org.eclipse.lsp4j.services.LanguageServer.initialize.

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

public boolean

isStandalone()

public CompletableFuture<Object>

shutdown()

Implements org.eclipse.lsp4j.services.LanguageServer.shutdown.

The shutdown request is sent from the client to the server.

Field Detail

client	back to summary
private LanguageClient client

diagnosticHandler	back to summary
private final LspDiagnosticHandler diagnosticHandler

linkHandler	back to summary
private final LspLinkHandler linkHandler

LOGGER	back to summary
private static final Logger LOGGER

messageHandler	back to summary
private final RemoteMessageHandler messageHandler

parserHandler	back to summary
private final LspParserHandler parserHandler

settings	back to summary
private final ExtensionSettings settings

standalone	back to summary
private boolean standalone

textDocumentService	back to summary
private final BibtexTextDocumentService textDocumentService

workspaceService	back to summary
private final BibtexWorkspaceService workspaceService

LspClientHandler	back to summary
public LspClientHandler(RemoteMessageHandler messageHandler, CliPreferences cliPreferences, JournalAbbreviationRepository abbreviationRepository, BibEntryTypesManager bibEntryTypesManager)

LspClientHandler

back to summary

public LspClientHandler(RemoteMessageHandler messageHandler, CliPreferences cliPreferences, JournalAbbreviationRepository abbreviationRepository, BibEntryTypesManager bibEntryTypesManager)

LspClientHandler	back to summary
public LspClientHandler(RemoteMessageHandler messageHandler, CliPreferences cliPreferences, JournalAbbreviationRepository abbreviationRepository, BibEntryTypesManager bibEntryTypesManager, boolean standalone)

LspClientHandler

back to summary

public LspClientHandler(RemoteMessageHandler messageHandler, CliPreferences cliPreferences, JournalAbbreviationRepository abbreviationRepository, BibEntryTypesManager bibEntryTypesManager, boolean standalone)

Method Detail

connect	back to summary
public void connect(LanguageClient client) Implements org.eclipse.lsp4j.services.LanguageClientAware.connect. Annotations @Override

connect

back to summary

public void connect(LanguageClient client)

Implements org.eclipse.lsp4j.services.LanguageClientAware.connect.

Annotations

@Override

exit	back to summary
public void exit() Implements org.eclipse.lsp4j.services.LanguageServer.exit. When running in JabGui: NOOP, because the JabGui has the lifecycle control. When running standalone: immediately exits. We accept issues if mutlitple clients are connected. Annotations @Override

exit

back to summary

public void exit()

Implements org.eclipse.lsp4j.services.LanguageServer.exit.

When running in JabGui: NOOP, because the JabGui has the lifecycle control. When running standalone: immediately exits. We accept issues if mutlitple clients are connected.

Annotations

@Override

getSettings	back to summary
public ExtensionSettings getSettings()

getTextDocumentService	back to summary
public TextDocumentService getTextDocumentService() Implements org.eclipse.lsp4j.services.LanguageServer.getTextDocumentService. Doc from org.eclipse.lsp4j.services.LanguageServer.getTextDocumentService. Provides access to the textDocument services. Annotations @Override

getTextDocumentService

back to summary

public TextDocumentService getTextDocumentService()

Implements org.eclipse.lsp4j.services.LanguageServer.getTextDocumentService.

Doc from org.eclipse.lsp4j.services.LanguageServer.getTextDocumentService.

Provides access to the textDocument services.

Annotations

@Override

getWorkspaceService	back to summary
public WorkspaceService getWorkspaceService() Implements org.eclipse.lsp4j.services.LanguageServer.getWorkspaceService. Doc from org.eclipse.lsp4j.services.LanguageServer.getWorkspaceService. Provides access to the workspace services. Annotations @Override

getWorkspaceService

back to summary

public WorkspaceService getWorkspaceService()

Implements org.eclipse.lsp4j.services.LanguageServer.getWorkspaceService.

Doc from org.eclipse.lsp4j.services.LanguageServer.getWorkspaceService.

Provides access to the workspace services.

Annotations

@Override

initialize back to summary

initialize	back to summary
public CompletableFuture<InitializeResult> initialize(InitializeParams params) Implements org.eclipse.lsp4j.services.LanguageServer.initialize. Doc from org.eclipse.lsp4j.services.LanguageServer.initialize. 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: `org.eclipse.lsp4j.jsonrpc.messages.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. Annotations @Override

public CompletableFuture<InitializeResult> initialize(InitializeParams params)

Implements org.eclipse.lsp4j.services.LanguageServer.initialize.

Doc from org.eclipse.lsp4j.services.LanguageServer.initialize.

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: org.eclipse.lsp4j.jsonrpc.messages.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.

Annotations

@Override

isStandalone	back to summary
public boolean isStandalone()

shutdown	back to summary
public CompletableFuture<Object> shutdown() Implements org.eclipse.lsp4j.services.LanguageServer.shutdown. Doc from org.eclipse.lsp4j.services.LanguageServer.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. Annotations @Override

shutdown

back to summary

public CompletableFuture<Object> shutdown()

Implements org.eclipse.lsp4j.services.LanguageServer.shutdown.

Doc from org.eclipse.lsp4j.services.LanguageServer.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.

Annotations

@Override

public Class LspClientHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail