io.katharsis.dispatcher.controller

Interface BaseController

All Known Implementing Classes:

CollectionGet, FieldResourceGet, FieldResourcePost, RelationshipsResourceDelete, RelationshipsResourceGet, RelationshipsResourcePatch, RelationshipsResourcePost, RelationshipsResourceUpsert, ResourceDelete, ResourceGet, ResourcePatch, ResourcePost, ResourceUpsert

public interface BaseController

Represents a controller contract which all of the implementations must implements.

Method Summary

Modifier and Type	Method and Description
BaseResponse<?>	handle(JsonPath jsonPath, RequestParams requestParams, RequestBody requestBody) Passes the request to controller method.
boolean	isAcceptable(JsonPath jsonPath, String requestType) Checks if requested resource method is acceptable.

Method Detail

isAcceptable

boolean isAcceptable(JsonPath jsonPath,
                     String requestType)

Checks if requested resource method is acceptable.

Parameters:

jsonPath - Requested resource path

requestType - HTTP request type

Returns:

Acceptance result in boolean

handle

BaseResponse<?> handle(JsonPath jsonPath,
                       RequestParams requestParams,
                       RequestBody requestBody)
                throws Exception

Passes the request to controller method.

Parameters:

jsonPath - Requested resource path

requestParams - Params specifying request

requestBody - Top-level JSON object from method's body of the request passed as RequestBody

Returns:

CollectionResponse object

Throws:

Exception - internal Katharsis exception