ApiPlugin (KNX Core Plugin - API 0.0.3 API)

java.lang.Object
- li.pitschmann.knx.core.plugin.api.ApiPlugin

All Implemented Interfaces:

ExtensionPlugin, Plugin
```
public class ApiPlugin
extends Object
implements ExtensionPlugin
```
Plugin for RESTful API (web server)

Field Summary

Fields
Modifier and Type Field Description

protected org.slf4j.Logger log

static IntegerConfigValue PORT
Default port for Pippo Micro Web Server (re-using the default port value)

Constructor Summary

Constructors
Constructor Description

ApiPlugin()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getPort()`	Returns the port for web server that serves the endpoints
`boolean`	`isReady()`	Returns if the web server is ready
`void`	`onInitialization(KnxClient client)`
`void`	`onShutdown()`
`void`	`onStart()`
`protected void`	`startPippo(ro.pippo.core.Pippo pippo)`	Starts the Pippo server.

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

- Field Detail
  - PORT
```
public static final IntegerConfigValue PORT
```
    Default port for Pippo Micro Web Server (re-using the default port value)
  - log
```
protected final org.slf4j.Logger log
```
- Constructor Detail
  - ApiPlugin
```
public ApiPlugin()
```
- Method Detail
  - onInitialization
```
public void onInitialization(KnxClient client)
```
    Specified by:
    
    onInitialization in interface Plugin
  - onStart
```
public void onStart()
```
    Specified by:
    
    onStart in interface ExtensionPlugin
  - onShutdown
```
public void onShutdown()
```
    Specified by:
    
    onShutdown in interface ExtensionPlugin
  - startPippo
```
protected void startPippo(ro.pippo.core.Pippo pippo)
```
    Starts the Pippo server. This method can be overridden.
    
    Parameters:
    
    pippo - the instance for Pippo web server
  - getPort
```
public final int getPort()
```
    Returns the port for web server that serves the endpoints
    
    Returns:
    
    actual port
  - isReady
```
public final boolean isReady()
```
    Returns if the web server is ready
    
    Returns:
    
    true if server is ready, otherwise false