WriteRequestController (KNX Core Plugin - API 0.0.3 API)

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

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

Controller for write requests

Field Summary

Fields
Modifier and Type Field Description

protected org.slf4j.Logger log

Constructor Summary

Constructors
Constructor Description

WriteRequestController()

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.
`WriteResponse`	`writeRequest(WriteRequest writeRequest)`	Endpoint for write 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
  - WriteRequestController
```
public WriteRequestController()
```
- Method Detail
  - writeRequest
```
@POST("/write")
@Consumes("application/json")
@Produces("application/json")
public WriteResponse writeRequest(@Body
                                  WriteRequest writeRequest)
```
    Endpoint for write request to be forwarded to KNX Net/IP device
    As soon we get an acknowledge frame from KNX, our write request action is done!
    
    Parameters:
    
    writeRequest - write request from HTTP client
    
    Returns:
    
    a new instance of WriteResponse
  - 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