Package org.eclipse.basyx.vab.protocol.api

Interface IBaSyxConnector

All Known Implementing Classes:

BaSyxConnector, HTTPConnector, HTTPSConnector

public interface IBaSyxConnector

Connector interface for technology specific communication. Returns the response including meta information

Author:

pschorn

Method Summary

Modifier and Type	Method	Description
String	createValue(String path, String newEntity)	Create a new property, operation, event submodel or aas under the given path
String	deleteValue(String path)	Delete a property, operation, event, submodel or aas under the given path
String	deleteValue(String path, String obj)	Deletes an entry from a map or collection by the given key
String	getEndpointRepresentation(String path)	Get string representation of endpoint for given path for debugging.
String	getValue(String path)	Get a sub model property value
String	invokeOperation(String path, String jsonObject)	Invoke an operation
String	setValue(String path, String newValue)	Sets or overrides existing property, operation or event.

Method Detail

getValue

String getValue(String path)
         throws ProviderException

Get a sub model property value

Parameters:

path - Path to the requested value

Returns:

Property value. Object type is assumed to be [Integer | ... | Collection]

Throws:

ProviderException

setValue

String setValue(String path,
                String newValue)
         throws ProviderException

Sets or overrides existing property, operation or event.

Parameters:

path - Path to the requested value

newValue - Updated value

Throws:

ProviderException

createValue

String createValue(String path,
                   String newEntity)
            throws ProviderException

Create a new property, operation, event submodel or aas under the given path

Parameters:

path - Path to the entity where the element should be created

newEntity - new Element to be created on the server

Throws:

ProviderException

deleteValue

String deleteValue(String path)
            throws ProviderException

Delete a property, operation, event, submodel or aas under the given path

Parameters:

path - Path to the entity that should be deleted

Throws:

ProviderException

deleteValue

String deleteValue(String path,
                   String obj)
            throws ProviderException

Deletes an entry from a map or collection by the given key

Parameters:

path - Path to the entity that should be deleted

Throws:

ProviderException

invokeOperation

String invokeOperation(String path,
                       String jsonObject)
                throws ProviderException

Invoke an operation

Parameters:

path - Path to operation

jsonObject - Operation parameter

Returns:

Return value

Throws:

ProviderException

getEndpointRepresentation

String getEndpointRepresentation(String path)

Get string representation of endpoint for given path for debugging.

Parameters:

path - Requested path

Returns:

String representing requested endpoint