eu.vicci.openhab.util

Interface IOpenHabRestClient

All Known Implementing Classes:

OpenHabRestClient

public interface IOpenHabRestClient

Interface for a OpenHabRestClient.

Author:

André Kühnert

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASK_PATH
static String	COMMAND_PATH
static String	ERR_JSON_CONVERT
static String	GOAL_EXECUTE_GOAL_PATH
static String	GOAL_GOAL_PATH
static String	GOAL_PATH
static String	GOAL_QUALITY_PATH
static String	ITEMS_PATH
static String	REST_PATH
static String	SELECT_PATH
static String	SEMANTIC_LOCATION_PATH
static String	SEMANTIC_LOCATIONS_PATH
static String	SEMANTIC_PATH
static String	SEMANTIC_PERSONS
static String	SEMANTIC_SENSOR_PATH

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.

Field Detail

ITEMS_PATH

static final String ITEMS_PATH

See Also:

Constant Field Values

REST_PATH

static final String REST_PATH

See Also:

Constant Field Values

SEMANTIC_PATH

static final String SEMANTIC_PATH

See Also:

Constant Field Values

SELECT_PATH

static final String SELECT_PATH

See Also:

Constant Field Values

ASK_PATH

static final String ASK_PATH

See Also:

Constant Field Values

COMMAND_PATH

static final String COMMAND_PATH

See Also:

Constant Field Values

SEMANTIC_LOCATION_PATH

static final String SEMANTIC_LOCATION_PATH

See Also:

Constant Field Values

SEMANTIC_SENSOR_PATH

static final String SEMANTIC_SENSOR_PATH

See Also:

Constant Field Values

SEMANTIC_PERSONS

static final String SEMANTIC_PERSONS

See Also:

Constant Field Values

SEMANTIC_LOCATIONS_PATH

static final String SEMANTIC_LOCATIONS_PATH

See Also:

Constant Field Values

GOAL_PATH

static final String GOAL_PATH

See Also:

Constant Field Values

GOAL_GOAL_PATH

static final String GOAL_GOAL_PATH

See Also:

Constant Field Values

GOAL_QUALITY_PATH

static final String GOAL_QUALITY_PATH

See Also:

Constant Field Values

GOAL_EXECUTE_GOAL_PATH

static final String GOAL_EXECUTE_GOAL_PATH

See Also:

Constant Field Values

ERR_JSON_CONVERT

static final String ERR_JSON_CONVERT

See Also:

Constant Field Values

Method Detail

getOpenHabRestVersion

String getOpenHabRestVersion()

Gets the current OpenHab rest API version

Returns:

The OpenHab Version as String

executeSelect

String executeSelect(String queryStmt,
                     boolean withLatest)

Executes a select and gets the result as json string

Parameters:

queryStmt - The Select Statement

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

Returns:

executeAsk

boolean executeAsk(String queryStmt,
                   boolean withLatest)

Executes an AskQuery.

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

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

Posts a command to semantic layer in OpenHab.

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.

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

Returns:

getLocationForItem

String getLocationForItem(String itemName)

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

Parameters:

itemName -

Returns:

getSemanticType

String getSemanticType(String itemName)

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

Parameters:

itemName -

Returns:

getAllItems

List<OpenHabItem> getAllItems()

Gets a list with all openhab items.

Returns:

getSemanticPersons

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

Gets all available persons semantically annotated

Returns:

close

void close()

Closes this client. Have to be called after use

postCommand

void postCommand(OpenHabItem item,
                 String command)

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

getAllSensorsSemantic

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

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

getAllLocations

List<SemanticLocation> getAllLocations()

Gets all locations from the OH SAL

Returns:

getAllQualities

List<Quality> getAllQualities()

Gets all qualities from the OH Goal Layer

Returns:

getAllGoals

List<Goal> getAllGoals()

Gets all goals from the OH Goal Layer

Returns:

executeGoal

boolean executeGoal(ExecuteGoalCommandBean cmd)

Executes the given goal on the OH Goal Layer

Parameters:

cmd -

Returns:

true if request was successful