eu.vicci.openhab.util

Class OpenHabRestClient

java.lang.Object

eu.vicci.openhab.util.OpenHabRestClient

All Implemented Interfaces:

IOpenHabRestClient

public class OpenHabRestClient
extends Object
implements IOpenHabRestClient

Rest Client for OpenHab. For receiving events use OpenHabEventProvider instead.

Author:

André Kühnert

Field Summary

Fields inherited from interface eu.vicci.openhab.util.IOpenHabRestClient

ASK_PATH, COMMAND_PATH, ERR_JSON_CONVERT, GOAL_EXECUTE_GOAL_PATH, GOAL_GOAL_PATH, GOAL_PATH, GOAL_QUALITY_PATH, ITEMS_PATH, REST_PATH, SELECT_PATH, SEMANTIC_LOCATION_PATH, SEMANTIC_LOCATIONS_PATH, SEMANTIC_PATH, SEMANTIC_PERSONS, SEMANTIC_SENSOR_PATH

Constructor Summary

Constructors

Constructor and Description
OpenHabRestClient(String serverBaseUri) Creates a new OpenHabRestClient to communicate with OpenHab via rest.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this client.
boolean	executeAsk(String queryStmt, boolean withLatest) Executes an AskQuery.
boolean	executeGoal(ExecuteGoalCommandBean cmd) Executes the given goal on the OH Goal Layer
String	executeSelect(String queryStmt, boolean withLatest) Executes a select and gets the result as json string
List<Goal>	getAllGoals() Gets all goals from the OH Goal Layer
List<OpenHabItem>	getAllItems() Gets a list with all openhab items.
List<SemanticLocation>	getAllLocations() Gets all locations from the OH SAL
List<Quality>	getAllQualities() Gets all qualities from the OH Goal Layer
List<eu.vicci.process.devices.core.Sensor>	getAllSensorsSemantic() Gets a list with all sensors.
String	getLocationForItem(String itemName) Gets the location of a item, which is defined in openhab
String	getOpenHabRestVersion() Gets the current OpenHab rest API version
List<eu.vicci.process.model.util.messages.core.SemanticPerson>	getSemanticPersons() Gets all available persons semantically annotated
String	getSemanticType(String itemName) Gets the type of the item, defined in the semantic model
void	postCommand(OpenHabItem item, String command) Posts a command to the specified openhab item.
String	postCommandSemantic(String queryStmt, String command, boolean withLatest) Posts a command to semantic layer in OpenHab.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenHabRestClient

public OpenHabRestClient(String serverBaseUri)

Creates a new OpenHabRestClient to communicate with OpenHab via rest. This backs a CloseableHttpClient which have to be closed after use. Call close() to close it.

Parameters:

serverBaseUri - the Uri where OpenHab is running
e.g. http://localhost:8080

Method Detail

getOpenHabRestVersion

public String getOpenHabRestVersion()

Description copied from interface: IOpenHabRestClient

Gets the current OpenHab rest API version

Specified by:

getOpenHabRestVersion in interface IOpenHabRestClient

Returns:

The OpenHab Version as String

executeSelect

public String executeSelect(String queryStmt,
                            boolean withLatest)

Description copied from interface: IOpenHabRestClient

Executes a select and gets the result as json string

Specified by:

executeSelect in interface IOpenHabRestClient

Parameters:

queryStmt - The Select Statement

withLatest - If true, all stateValues in the model will be updated before the query is executed.

Returns:

executeAsk

public boolean executeAsk(String queryStmt,
                          boolean withLatest)

Description copied from interface: IOpenHabRestClient

Executes an AskQuery.

Specified by:

executeAsk in interface IOpenHabRestClient

Parameters:

queryStmt - The Ask Statement

withLatest - If true, all stateValues in the model will be updated before the query is executed.

Returns:

The result of the AskQuery, or also false, if an error happened.

postCommandSemantic

public String postCommandSemantic(String queryStmt,
                                  String command,
                                  boolean withLatest)

Description copied from interface: IOpenHabRestClient

Posts a command to semantic layer in OpenHab.

Specified by:

postCommandSemantic in interface IOpenHabRestClient

Parameters:

queryStmt - The query should select the functionalities, which should receive the command. E.g. '?subject dogont:hasFunctionality ?func' where the var '?func' represents all the functionalities, which receives the command.

command - The command, supported by the functionalities and the specific items.

Returns:

getLocationForItem

public String getLocationForItem(String itemName)

Description copied from interface: IOpenHabRestClient

Gets the location of a item, which is defined in openhab

Specified by:

getLocationForItem in interface IOpenHabRestClient

Returns:

getSemanticType

public String getSemanticType(String itemName)

Description copied from interface: IOpenHabRestClient

Gets the type of the item, defined in the semantic model

Specified by:

getSemanticType in interface IOpenHabRestClient

Returns:

getAllItems

public List<OpenHabItem> getAllItems()

Description copied from interface: IOpenHabRestClient

Gets a list with all openhab items.

Specified by:

getAllItems in interface IOpenHabRestClient

Returns:

getSemanticPersons

public List<eu.vicci.process.model.util.messages.core.SemanticPerson> getSemanticPersons()

Description copied from interface: IOpenHabRestClient

Gets all available persons semantically annotated

Specified by:

getSemanticPersons in interface IOpenHabRestClient

Returns:

close

public void close()

Description copied from interface: IOpenHabRestClient

Closes this client. Have to be called after use

Specified by:

close in interface IOpenHabRestClient

getAllSensorsSemantic

public List<eu.vicci.process.devices.core.Sensor> getAllSensorsSemantic()

Description copied from interface: IOpenHabRestClient

Gets a list with all sensors. The informations are received from the semantic layer.

Specified by:

getAllSensorsSemantic in interface IOpenHabRestClient

postCommand

public void postCommand(OpenHabItem item,
                        String command)

Description copied from interface: IOpenHabRestClient

Posts a command to the specified openhab item. (Not implemented yet)

Specified by:

postCommand in interface IOpenHabRestClient

getAllLocations

public List<SemanticLocation> getAllLocations()

Description copied from interface: IOpenHabRestClient

Gets all locations from the OH SAL

Specified by:

getAllLocations in interface IOpenHabRestClient

Returns:

getAllQualities

public List<Quality> getAllQualities()

Description copied from interface: IOpenHabRestClient

Gets all qualities from the OH Goal Layer

Specified by:

getAllQualities in interface IOpenHabRestClient

Returns:

getAllGoals

public List<Goal> getAllGoals()

Description copied from interface: IOpenHabRestClient

Gets all goals from the OH Goal Layer

Specified by:

getAllGoals in interface IOpenHabRestClient

Returns:

executeGoal

public boolean executeGoal(ExecuteGoalCommandBean cmd)

Description copied from interface: IOpenHabRestClient

Executes the given goal on the OH Goal Layer

Specified by:

executeGoal in interface IOpenHabRestClient

Returns:

true if request was successful