org.eclipse.xtext.web.server

Class XtextServiceDispatcher

java.lang.Object

org.eclipse.xtext.web.server.XtextServiceDispatcher

public class XtextServiceDispatcher
extends java.lang.Object

The entry class for Xtext service invocations. Use getService(IServiceContext) to obtain a XtextServiceDispatcher.ServiceDescriptor for a client request. The service descriptor has some metadata that may influence the message format expected for the request, and may lead to a rejection of the request.

A typical usage can look like this:

 val serviceDispatcher = injector.getInstance(XtextServiceDispatcher)
 val serviceDescriptor = serviceDispatcher.getService(serviceContext)
 // Check whether the service metadata fits to the request format
 ...
 val result = serviceDescriptor.service.apply()
 // Serialize and send the result back to the client
 ...
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XtextServiceDispatcher.ServiceDescriptor Service metadata, including a function for actually invoking the service.

Constructor Summary

Constructors

Constructor and Description
XtextServiceDispatcher()

Method Summary

Modifier and Type	Method and Description
protected ServiceConflictResult	_handleError(XtextServiceDispatcher.ServiceDescriptor service, InvalidRequestException.InvalidDocumentStateException exception)
protected ServiceConflictResult	_handleError(XtextServiceDispatcher.ServiceDescriptor service, java.lang.Throwable throwable)
protected XtextServiceDispatcher.ServiceDescriptor	createServiceDescriptor(java.lang.String serviceType, IServiceContext context) Do the actual dispatching by delegating to a service descriptor creation method depending on the service type.
protected boolean	getBoolean(IServiceContext context, java.lang.String key, com.google.common.base.Optional<java.lang.Boolean> defaultValue) Read a Boolean-valued parameter.
protected XtextServiceDispatcher.ServiceDescriptor	getContentAssistService(IServiceContext context)
protected XtextWebDocumentAccess	getDocumentAccess(IServiceContext context) Retrieve the document access for the given service context.
protected XtextServiceDispatcher.ServiceDescriptor	getFormattingService(IServiceContext context)
protected XtextWebDocument	getFullTextDocument(java.lang.String fullText, java.lang.String resourceId, IServiceContext context) Create a new document containing the given text.
protected XtextServiceDispatcher.ServiceDescriptor	getGeneratorService(IServiceContext context)
protected XtextServiceDispatcher.ServiceDescriptor	getHighlightingService(IServiceContext context)
protected XtextServiceDispatcher.ServiceDescriptor	getHoverService(IServiceContext context)
protected int	getInt(IServiceContext context, java.lang.String key, com.google.common.base.Optional<java.lang.Integer> defaultValue) Read an integer-valued parameter.
protected XtextServiceDispatcher.ServiceDescriptor	getLoadResourceService(boolean revert, IServiceContext context)
protected XtextServiceDispatcher.ServiceDescriptor	getOccurrencesService(IServiceContext context)
protected XtextWebDocument	getResourceDocument(java.lang.String resourceId, IServiceContext context) Obtain a document from the session store, and if it is not present there, ask the IServerResourceHandler to provide it.
protected java.lang.String	getResourceID(IServiceContext context) Returns the resource ID from the service context.
protected XtextServiceDispatcher.ServiceDescriptor	getSaveResourceService(IServiceContext context)
XtextServiceDispatcher.ServiceDescriptor	getService(IServiceContext context) Create a service descriptor according to the parameters given in the service context.
protected java.lang.String	getString(IServiceContext context, java.lang.String key, com.google.common.base.Optional<java.lang.String> defaultValue) Read an string-valued parameter.
protected XtextServiceDispatcher.ServiceDescriptor	getUpdateDocumentService(IServiceContext context)
protected XtextServiceDispatcher.ServiceDescriptor	getValidationService(IServiceContext context)
protected ServiceConflictResult	handleError(XtextServiceDispatcher.ServiceDescriptor service, java.lang.Throwable exception)
protected void	registerPreComputedServices(PrecomputedServiceRegistry registry)

Methods inherited from class java.lang.Object

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

Constructor Detail

XtextServiceDispatcher

public XtextServiceDispatcher()

Method Detail

registerPreComputedServices

@Inject
protected void registerPreComputedServices(PrecomputedServiceRegistry registry)

getService

public XtextServiceDispatcher.ServiceDescriptor getService(IServiceContext context)
                                                    throws InvalidRequestException

Create a service descriptor according to the parameters given in the service context.

Throws:

InvalidRequestException

createServiceDescriptor

protected XtextServiceDispatcher.ServiceDescriptor createServiceDescriptor(java.lang.String serviceType,
                                                                           IServiceContext context)

Do the actual dispatching by delegating to a service descriptor creation method depending on the service type. Override this method if you want to add more services to the dispatcher.

getLoadResourceService

protected XtextServiceDispatcher.ServiceDescriptor getLoadResourceService(boolean revert,
                                                                          IServiceContext context)
                                                                   throws InvalidRequestException

Throws:

InvalidRequestException

getSaveResourceService

protected XtextServiceDispatcher.ServiceDescriptor getSaveResourceService(IServiceContext context)
                                                                   throws InvalidRequestException

Throws:

InvalidRequestException

getUpdateDocumentService

protected XtextServiceDispatcher.ServiceDescriptor getUpdateDocumentService(IServiceContext context)
                                                                     throws InvalidRequestException

Throws:

InvalidRequestException

getContentAssistService

protected XtextServiceDispatcher.ServiceDescriptor getContentAssistService(IServiceContext context)
                                                                    throws InvalidRequestException

Throws:

InvalidRequestException

getValidationService

protected XtextServiceDispatcher.ServiceDescriptor getValidationService(IServiceContext context)
                                                                 throws InvalidRequestException

Throws:

InvalidRequestException

getHoverService

protected XtextServiceDispatcher.ServiceDescriptor getHoverService(IServiceContext context)
                                                            throws InvalidRequestException

Throws:

InvalidRequestException

getHighlightingService

protected XtextServiceDispatcher.ServiceDescriptor getHighlightingService(IServiceContext context)
                                                                   throws InvalidRequestException

Throws:

InvalidRequestException

getOccurrencesService

protected XtextServiceDispatcher.ServiceDescriptor getOccurrencesService(IServiceContext context)
                                                                  throws InvalidRequestException

Throws:

InvalidRequestException

getFormattingService

protected XtextServiceDispatcher.ServiceDescriptor getFormattingService(IServiceContext context)
                                                                 throws InvalidRequestException

Throws:

InvalidRequestException

See Also:

FormatterPreferenceKeys

getGeneratorService

protected XtextServiceDispatcher.ServiceDescriptor getGeneratorService(IServiceContext context)
                                                                throws InvalidRequestException

Throws:

InvalidRequestException

getDocumentAccess

protected XtextWebDocumentAccess getDocumentAccess(IServiceContext context)
                                            throws InvalidRequestException

Retrieve the document access for the given service context. If the 'fullText' parameter is given, a new document containing that text is created. Otherwise the 'resource' parameter is used to load a resource and put it into the session store.

Throws:

InvalidRequestException

getResourceID

protected java.lang.String getResourceID(IServiceContext context)

Returns the resource ID from the service context. Potentially null.

getFullTextDocument

protected XtextWebDocument getFullTextDocument(java.lang.String fullText,
                                               java.lang.String resourceId,
                                               IServiceContext context)

Create a new document containing the given text.

getResourceDocument

protected XtextWebDocument getResourceDocument(java.lang.String resourceId,
                                               IServiceContext context)

Obtain a document from the session store, and if it is not present there, ask the IServerResourceHandler to provide it. In case that resource handler fails to provide the document, null is returned instead.

getString

protected java.lang.String getString(IServiceContext context,
                                     java.lang.String key,
                                     com.google.common.base.Optional<java.lang.String> defaultValue)
                              throws InvalidRequestException.InvalidParametersException

Read an string-valued parameter. If the parameter is not available, the defaultValue is returned.

Throws:

InvalidRequestException.InvalidParametersException - if the parameter is not available and defaultValue is absent

getInt

protected int getInt(IServiceContext context,
                     java.lang.String key,
                     com.google.common.base.Optional<java.lang.Integer> defaultValue)
              throws InvalidRequestException.InvalidParametersException

Read an integer-valued parameter. If the parameter is not available, the defaultValue is returned.

Throws:

InvalidRequestException.InvalidParametersException - if the parameter is not available and defaultValue is absent

getBoolean

protected boolean getBoolean(IServiceContext context,
                             java.lang.String key,
                             com.google.common.base.Optional<java.lang.Boolean> defaultValue)
                      throws InvalidRequestException.InvalidParametersException

Read a Boolean-valued parameter. If the parameter is not available, the defaultValue is returned.

Throws:

InvalidRequestException.InvalidParametersException - if the parameter is not available and defaultValue is absent

_handleError

protected ServiceConflictResult _handleError(XtextServiceDispatcher.ServiceDescriptor service,
                                             java.lang.Throwable throwable)

_handleError

protected ServiceConflictResult _handleError(XtextServiceDispatcher.ServiceDescriptor service,
                                             InvalidRequestException.InvalidDocumentStateException exception)

handleError

protected ServiceConflictResult handleError(XtextServiceDispatcher.ServiceDescriptor service,
                                            java.lang.Throwable exception)