sirius.web.services

Interface StructuredService

All Known Implementing Classes:

ConsoleService, NodeInfoService

public interface StructuredService

Provides a service which can be called via the HTTP interface and generate a structured output encoded as JSON or XML

A StructuredService must be registered using the Register annotation provided with a name, which also defines the URL of the service.

The generated output can be either JSON or XML, which is completely handled by the framework.

Note: Simple AJAX calls using JSON can also be realized using the controller framework. See Routed.jsonCall() for further information.

Method Summary

Modifier and Type	Method and Description
void	call(ServiceCall call, sirius.kernel.xml.StructuredOutput out) Handles the incoming call while using out to generate the result.
default void	handleException(ServiceCall call, sirius.kernel.xml.StructuredOutput out, sirius.kernel.health.HandledException e) Handles the exception caused by handling the incoming call.

Method Detail

call

void call(ServiceCall call,
          sirius.kernel.xml.StructuredOutput out)
   throws Exception

Handles the incoming call while using out to generate the result.

Parameters:

call - the HTTP request to process

out - the encoder used to generate the desired output

Throws:

Exception - in case of an error. An appropriate result will be generated in the selected format.

handleException

default void handleException(ServiceCall call,
                             sirius.kernel.xml.StructuredOutput out,
                             sirius.kernel.health.HandledException e)

Handles the exception caused by handling the incoming call.

Parameters:

call - the HTTP request to process

out - the encoder used to generate the desired output

e - HandledException which caused an error while processing the request