io.openems.backend.metadata.api

Interface Metadata

All Known Implementing Classes:

Dummy, File, MetadataOdoo

@ProviderType
public interface Metadata

Method Summary

Modifier and Type	Method and Description
static java.lang.String	activeStateChannelsToString(java.util.Map<ChannelAddress,EdgeConfig.Component.Channel> activeStateChannels) Helper method for creating a String of all active State-Channels by Level.
default BackendUser	authenticate() Authenticates a User without any information.
BackendUser	authenticate(java.lang.String sessionId) Authenticates the User by a Session-ID.
BackendUser	authenticate(java.lang.String username, java.lang.String password) Authenticates the User by username and password.
java.util.Collection<Edge>	getAllEdges() Gets all Edges.
java.util.Optional<Edge>	getEdge(java.lang.String edgeId) Get an Edge by its unique Edge-ID.
java.util.Optional<java.lang.String>	getEdgeIdForApikey(java.lang.String apikey) Gets the Edge-ID for an API-Key, i.e.
default Edge	getEdgeOrError(java.lang.String edgeId) Get an Edge by its unique Edge-ID.
java.util.Optional<BackendUser>	getUser(java.lang.String userId) Gets the User for the given User-ID.
boolean	isInitialized() Was the Metadata service fully initialized?.

Method Detail

isInitialized

boolean isInitialized()

Was the Metadata service fully initialized?. The service might take some time in the beginning to establish a connection or to cache data from an external database.

Returns:

true if it is initialized

authenticate

default BackendUser authenticate()
                          throws OpenemsError.OpenemsNamedException

Authenticates a User without any information.

This is only useful for Dummy-Implementations. By default authentication is denied in this case.

Returns:

the User

Throws:

OpenemsError.OpenemsNamedException - on error

authenticate

BackendUser authenticate(java.lang.String username,
                         java.lang.String password)
                  throws OpenemsError.OpenemsNamedException

Authenticates the User by username and password.

Parameters:

username - the Username

password - the Password

Returns:

the User

Throws:

OpenemsError.OpenemsNamedException - on error

authenticate

BackendUser authenticate(java.lang.String sessionId)
                  throws OpenemsError.OpenemsNamedException

Authenticates the User by a Session-ID.

Parameters:

sessionId - the Session-ID

Returns:

the User

Throws:

OpenemsError.OpenemsNamedException - on error

getEdgeIdForApikey

java.util.Optional<java.lang.String> getEdgeIdForApikey(java.lang.String apikey)

Gets the Edge-ID for an API-Key, i.e. authenticates the API-Key.

Parameters:

apikey - the API-Key

Returns:

the Edge-ID or Empty

getEdge

java.util.Optional<Edge> getEdge(java.lang.String edgeId)

Get an Edge by its unique Edge-ID.

Parameters:

edgeId - the Edge-ID

Returns:

the Edge as Optional

getEdgeOrError

default Edge getEdgeOrError(java.lang.String edgeId)
                     throws OpenemsException

Get an Edge by its unique Edge-ID. Throws an Exception if there is no Edge with this ID.

Parameters:

edgeId - the Edge-ID

Returns:

the Edge

Throws:

OpenemsException - on error

getUser

java.util.Optional<BackendUser> getUser(java.lang.String userId)

Gets the User for the given User-ID.

Parameters:

userId - the User-ID

Returns:

the User, or Empty

getAllEdges

java.util.Collection<Edge> getAllEdges()

Gets all Edges.

Returns:

collection of Edges.

activeStateChannelsToString

static java.lang.String activeStateChannelsToString(java.util.Map<ChannelAddress,EdgeConfig.Component.Channel> activeStateChannels)

Helper method for creating a String of all active State-Channels by Level.

Parameters:

activeStateChannels - Map of ChannelAddress and EdgeConfig.Component.Channel; as returned by Edge.onSetSumState()

Returns:

a string