com.xatkit.core.server

Class EmptyContentRestHandler

java.lang.Object

com.xatkit.core.server.RestHandler<Object>

com.xatkit.core.server.EmptyContentRestHandler

public abstract class EmptyContentRestHandler
extends RestHandler<Object>

A handler that receives HTTP requests with empty content and process them.

This class can be used to define REST endpoints from RuntimePlatforms. The endpoint can be registered using the following code:

 
 XatkitServer xatkitServer = [...]
 String restEndpointURI = "/myEndpoint";
 xatkitServer.registerRestEndpoint(HttpMethod.GET, restEndpointURI, RestHandlerFactory.createEmptyContentRestHandler(
  (headers, params, content) -> {
      // Handle the request
      // return an Object that will be embedded in the HTTP response
  }
 
 

Constructor Summary

Constructors

Constructor and Description
EmptyContentRestHandler()

Method Summary

Modifier and Type	Method and Description
boolean	acceptContentType(String contentType) Returns true.
protected abstract Object	handleParsedContent(List<org.apache.http.Header> headers, List<org.apache.http.NameValuePair> params, Object content) Handles the request.
protected Object	parseContent(Object content) Checks that the provided content object is null and returns it.

Methods inherited from class com.xatkit.core.server.RestHandler

getAccessControlAllowHeaders, getHeaderValue, handleContent

Methods inherited from class java.lang.Object

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

Constructor Detail

EmptyContentRestHandler

public EmptyContentRestHandler()

Method Detail

acceptContentType

public boolean acceptContentType(String contentType)

Returns true.

This handler accepts any content type, but will throw an exception if the request's content is not empty.

Specified by:

acceptContentType in class RestHandler<Object>

Parameters:

contentType - the content type to check

Returns:

true

parseContent

@Nullable
protected Object parseContent(@Nullable
                                        Object content)

Checks that the provided content object is null and returns it.

This method throws an exception if the provided content object is not null. The handler does not support request's content, see other handlers to deal with specific content type (e.g. JsonRestHandler).

Specified by:

parseContent in class RestHandler<Object>

Parameters:

content - the raw HTTP request content to parse

Returns:

null

Throws:

IllegalArgumentException - if the provided content is not null

See Also:

RestHandler.handleParsedContent(List, List, Object)

handleParsedContent

@Nullable
protected abstract Object handleParsedContent(@Nonnull
                                                        List<org.apache.http.Header> headers,
                                                        @Nonnull
                                                        List<org.apache.http.NameValuePair> params,
                                                        @Nullable
                                                        Object content)
                                                 throws RestHandlerException

Handles the request.

Note: the content object is always null (this handler does not support request's content).

Specified by:

handleParsedContent in class RestHandler<Object>

Parameters:

headers - the HTTP headers of the received request

params - the request parameters

content - the parsed request payload to handle

Returns:

the handler's result

Throws:

RestHandlerException - if an error occurred when handling the request

See Also:

RestHandler.parseContent(Object), HttpEntityHelper.createHttpEntity(Object)