Package org.eclipse.basyx.submodel.restapi.vab

Class VABSubmodelAPI

java.lang.Object

org.eclipse.basyx.submodel.restapi.vab.VABSubmodelAPI

All Implemented Interfaces:

ISubmodelAPI

public class VABSubmodelAPI
extends Object
implements ISubmodelAPI

Implements the Submodel API by mapping it to VAB paths

Author:

schnicke

Constructor Summary

Constructors

Constructor	Description
VABSubmodelAPI(IModelProvider modelProvider)	Creates a VABSubmodelAPI that wraps an IModelProvider

Method Summary

Modifier and Type	Method	Description
void	addSubmodelElement(String idShortPath, ISubmodelElement elem)	Adds a submodelElement to the submodel
void	addSubmodelElement(ISubmodelElement elem)	Adds a submodelElement to the submodel
void	deleteSubmodelElement(String idShortPath)	Removes a submodelElement from the submodel
Object	getOperationResult(String idShortPath, String requestId)	Gets the result of an asynchronously invoked operation
Collection<IOperation>	getOperations()	Helper function for quick access of operations
Submodel	getSubmodel()	Retrieves the underlying submodel
ISubmodelElement	getSubmodelElement(String idShortPath)	Retrieves a submodelElement
File	getSubmodelElementFile(String idShortPath)
Collection<ISubmodelElement>	getSubmodelElements()	Helper function for quick access of submodelElements
Object	getSubmodelElementValue(String idShortPath)	Retrieves the value of a submodelElement
Object	invokeAsync(String idShortPath, Object... params)	Invoke an operation asynchronously
Object	invokeOperation(String idShortPath, Object... params)	Invokes an operation
void	updateSubmodelElement(String idShortPath, Object newValue)	Updates the value of a submodelElement
void	uploadSubmodelElementFile(String idShortPath, InputStream fileStream)

Methods inherited from class java.lang.Object

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

Constructor Detail

VABSubmodelAPI

public VABSubmodelAPI(IModelProvider modelProvider)

Creates a VABSubmodelAPI that wraps an IModelProvider

Parameters:

modelProvider - providing the Submodel

Method Detail

getSubmodel

public Submodel getSubmodel()

Description copied from interface: ISubmodelAPI

Retrieves the underlying submodel

Specified by:

getSubmodel in interface ISubmodelAPI

Returns:

the submodel

addSubmodelElement

public void addSubmodelElement(ISubmodelElement elem)

Description copied from interface: ISubmodelAPI

Adds a submodelElement to the submodel

Specified by:

addSubmodelElement in interface ISubmodelAPI

Parameters:

elem - the submodelElement to be added

addSubmodelElement

public void addSubmodelElement(String idShortPath,
                               ISubmodelElement elem)

Description copied from interface: ISubmodelAPI

Adds a submodelElement to the submodel

Specified by:

addSubmodelElement in interface ISubmodelAPI

Parameters:

idShortPath - the idShort path to the submodelElement

elem - the submodelElement to be added

deleteSubmodelElement

public void deleteSubmodelElement(String idShortPath)

Description copied from interface: ISubmodelAPI

Removes a submodelElement from the submodel

Specified by:

deleteSubmodelElement in interface ISubmodelAPI

Parameters:

idShortPath - the idShort path to the submodelElement, which is to be removed

getOperations

public Collection<IOperation> getOperations()

Description copied from interface: ISubmodelAPI

Helper function for quick access of operations

Specified by:

getOperations in interface ISubmodelAPI

Returns:

all operations contained by the submodel

getSubmodelElements

public Collection<ISubmodelElement> getSubmodelElements()

Description copied from interface: ISubmodelAPI

Helper function for quick access of submodelElements

Specified by:

getSubmodelElements in interface ISubmodelAPI

Returns:

all submodelElements contained by the submodel

updateSubmodelElement

public void updateSubmodelElement(String idShortPath,
                                  Object newValue)

Description copied from interface: ISubmodelAPI

Updates the value of a submodelElement

Specified by:

updateSubmodelElement in interface ISubmodelAPI

Parameters:

idShortPath - the idShort path to the submodelElement

newValue - new value of the submodelElement

uploadSubmodelElementFile

public void uploadSubmodelElementFile(String idShortPath,
                                      InputStream fileStream)

Specified by:

uploadSubmodelElementFile in interface ISubmodelAPI

getSubmodelElementValue

public Object getSubmodelElementValue(String idShortPath)

Description copied from interface: ISubmodelAPI

Retrieves the value of a submodelElement

Specified by:

getSubmodelElementValue in interface ISubmodelAPI

Parameters:

idShortPath - the idShort path to the submodelElement

Returns:

submodelElement value

getSubmodelElement

public ISubmodelElement getSubmodelElement(String idShortPath)

Description copied from interface: ISubmodelAPI

Retrieves a submodelElement

Specified by:

getSubmodelElement in interface ISubmodelAPI

Parameters:

idShortPath - the idShort Path to the submodelElement

Returns:

the submodelElement

invokeOperation

public Object invokeOperation(String idShortPath,
                              Object... params)

Description copied from interface: ISubmodelAPI

Invokes an operation

Specified by:

invokeOperation in interface ISubmodelAPI

Parameters:

idShortPath - the idShort path to the operation

params - to be passed to the operation

Returns:

the result of the operation

invokeAsync

public Object invokeAsync(String idShortPath,
                          Object... params)

Description copied from interface: ISubmodelAPI

Invoke an operation asynchronously

Specified by:

invokeAsync in interface ISubmodelAPI

Parameters:

idShortPath - the idShort path to the operation

params - to be passed to the operation

Returns:

the requestId of the invocation

getOperationResult

public Object getOperationResult(String idShortPath,
                                 String requestId)

Description copied from interface: ISubmodelAPI

Gets the result of an asynchronously invoked operation

Specified by:

getOperationResult in interface ISubmodelAPI

Parameters:

idShortPath - of the operation

requestId - the requestId of the invocation

Returns:

the result of the Operation or a Message that it is not finished yet

getSubmodelElementFile

public File getSubmodelElementFile(String idShortPath)

Specified by:

getSubmodelElementFile in interface ISubmodelAPI