org.mycontroller.standalone.api

Class GatewayApi

java.lang.Object

org.mycontroller.standalone.api.GatewayApi

public class GatewayApi
extends Object

Using this API's can do activities on gateway

Since:

0.0.3

Author:

Jeeva Kandasamy (jkandasa)

Constructor Summary

Constructors

Constructor and Description
GatewayApi()

Method Summary

Modifier and Type	Method and Description
void	add(GatewayConfig gatewayConfig)
void	delete(List<Integer> ids)
void	disable(List<Integer> ids)
void	enable(List<Integer> ids)
void	executeNodeDiscover(List<Integer> ids)
void	executeNodeInfoUpdate(List<Integer> ids)
GatewayConfig	get(HashMap<String,Object> filters)
GatewayConfig	get(Integer gatewayId)
QueryResponse	getAll(HashMap<String,Object> filters) Gives list of gateways with filter
QueryResponse	getAllRaw(HashMap<String,Object> filters)
GatewayConfig	getGateway(GatewayTable gatewayTable)
GatewayTable	getRaw(Integer gatewayId)
EngineStatistics	getStatistics(Integer gatewayId)
void	reload(List<Integer> ids)
void	update(GatewayConfig gatewayConfig)

Methods inherited from class java.lang.Object

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

Constructor Detail

GatewayApi

public GatewayApi()

Method Detail

getAll

public QueryResponse getAll(HashMap<String,Object> filters)

Gives list of gateways with filter

Filter(s):

name - List of gateway names

networkType - MySensors

type - Serial, Ethernet, MQTT

state - Up, Down, Unavailable

Page filter(s):

pageLimit - Set number of items per page

page - Request page number

order - Set order. Option: asc, desc

orderBy - column name for order. Options: name, networkType, type, state, enabled, statusMessage

Parameters:

filters - refer Filter(s)

Returns:

QueryResponse Contains input filter and response

getGateway

public GatewayConfig getGateway(GatewayTable gatewayTable)

getStatistics

public EngineStatistics getStatistics(Integer gatewayId)

get

public GatewayConfig get(HashMap<String,Object> filters)

getRaw

public GatewayTable getRaw(Integer gatewayId)

getAllRaw

public QueryResponse getAllRaw(HashMap<String,Object> filters)

get

public GatewayConfig get(Integer gatewayId)

add

public void add(GatewayConfig gatewayConfig)

update

public void update(GatewayConfig gatewayConfig)

delete

public void delete(List<Integer> ids)

enable

public void enable(List<Integer> ids)

disable

public void disable(List<Integer> ids)

reload

public void reload(List<Integer> ids)

executeNodeDiscover

public void executeNodeDiscover(List<Integer> ids)
                         throws McBadRequestException

Throws:

McBadRequestException

executeNodeInfoUpdate

public void executeNodeInfoUpdate(List<Integer> ids)
                           throws McBadRequestException

Throws:

McBadRequestException