ReadRequestController (KNX Core Plugin - API 0.0.3 API)

java.lang.Object
- ro.pippo.controller.Controller
- - li.pitschmann.knx.core.plugin.api.v1.controllers.ReadRequestController

public final class ReadRequestController
extends ro.pippo.controller.Controller

Controller for read requests

Field Summary

Fields
Modifier and Type Field Description

protected org.slf4j.Logger log

Constructor Summary

Constructors
Constructor Description

ReadRequestController()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`KnxClient`	`getKnxClient()`
`XmlProject`	`getXmlProject()`
`protected <T> List<T>`	`limitAndGetAsList(Collection<T> list)`	Returns a range of `T` elements from list.
`ReadResponse`	`readRequest(ReadRequest readRequest)`	Endpoint for read request to be forwarded to KNX Net/IP device

Methods inherited from class ro.pippo.controller.Controller
getApplication, getMessages, getRequest, getResponse, getRouteContext, getSettings

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - log
```
protected final org.slf4j.Logger log
```
- Constructor Detail
  - ReadRequestController
```
public ReadRequestController()
```
- Method Detail
  - readRequest
```
@POST("/read")
@Consumes("application/json")
@Produces("application/json")
public ReadResponse readRequest(@Body
                                ReadRequest readRequest)
```
    Endpoint for read request to be forwarded to KNX Net/IP device
    As soon we get an acknowledge frame from KNX Net/IP device, we will wait for a read request frame up to 3 seconds. If successful, the API will return the actual value with details like data point type. Otherwise, we simply return a JSON response with error state.
    
    Parameters:
    
    readRequest - the read request from HTTP client
    
    Returns:
    
    a new instance of ReadResponse
  - getXmlProject
```
@Nullable
public final XmlProject getXmlProject()
```
  - getKnxClient
```
public final KnxClient getKnxClient()
```
  - limitAndGetAsList
```
protected final <T> List<T> limitAndGetAsList(Collection<T> list)
```
    Returns a range of T elements from list. May be limited using start and limit request parameters.
    
    Type Parameters:
    
    T - the type of list value to be limited
    
    Parameters:
    
    list - the list that may be limited
    
    Returns:
    
    a new list of elements from Collection