Package io.openems.edge.core.appmanager

Class ComponentUtilImpl

java.lang.Object

io.openems.edge.core.appmanager.ComponentUtilImpl

All Implemented Interfaces:

ComponentUtil

public class ComponentUtilImpl
extends Object
implements ComponentUtil

Nested Class Summary

Nested classes/interfaces inherited from interface io.openems.edge.core.appmanager.ComponentUtil

ComponentUtil.PreferredRelay, ComponentUtil.RelayContactInfo, ComponentUtil.RelayInfo

Field Summary

Fields inherited from interface io.openems.edge.core.appmanager.ComponentUtil

CORE_COMPONENT_IDS

Constructor Summary

Constructors

Constructor	Description
ComponentUtilImpl(ComponentManager componentManager)

Method Summary

Modifier and Type	Method	Description
boolean	anyComponentUses(String value, List<String> ignoreIds)	Checks if any component has the given String in its configuration.
static boolean	equals(com.google.gson.JsonElement expected, com.google.gson.JsonElement actual)	Validates if the 'actual' matches the 'expected' value.
static boolean	equals(List<NetworkInterface<?>> interfaces, List<NetworkInterface<?>> otherInterfaces)	Validates if the 'interfaces' matches the 'otherInterfaces'.
List<ComponentUtil.RelayInfo>	getAllRelayInfos(List<String> ignoreIds, Predicate<DigitalOutput> componentFilter, Function<DigitalOutput,String> componentAliasMapper, BiPredicate<DigitalOutput,BooleanWriteChannel> channelFilter, BiFunction<DigitalOutput,BooleanWriteChannel,String> channelAliasMapper, BiFunction<DigitalOutput,BooleanWriteChannel,List<String>> disabledReasons)	Gets all RelayInfos of all DigitalOutputs.
Optional<EdgeConfig.Component>	getComponent(String id, String factoryId)	Gets an Optional of an EdgeConfig.Component.
EdgeConfig.Component	getComponentByConfig(EdgeConfig.Component component)	Searches a component with the given component configuration.
<T extends OpenemsComponent> List<T>	getEnabledComponentsOfStartingId(String id)	Gets the enabled Components with the starting id.
<T extends OpenemsComponent> List<T>	getEnabledComponentsOfType(Class<T> clazz)	Gets the enabled Components of a Type.
List<NetworkInterface<?>>	getInterfaces()	Gets the interfaces of the currently active network settings.
static List<NetworkInterface<?>>	getInterfaces(com.google.gson.JsonObject json)	parses all interfaces from the given JsonObject.
String	getNextAvailableId(String baseName, int startingNumber, List<String> componentIds)	Gets the next available id with the baseName starting with the given startingNumber.
String[]	getPreferredRelays(List<ComponentUtil.RelayInfo> relayInfos, int numberOfRelays, List<ComponentUtil.PreferredRelay> preferredRelaysDefinitions)	Gets the preferred relays.
EdgeConfig.Component	getScheduler()	Gets the scheduler Component.
List<String>	getSchedulerIds()	Gets the current id's in the scheduler.
int[]	getUsedModbusUnitIds(String modbusComponent)	Gets an array of modbus unit ids which are already used by other components.
List<String>	insertSchedulerOrder(List<String> actualOrder, List<String> insertOrder)	Inserts the insertOrder into the actual Order.
static boolean	isSameConfiguration(List<String> errors, EdgeConfig.Component expectedComponent, EdgeConfig.Component actualComponent)	Checks if the expectedComonents match with the actualComponent.
static boolean	isSameConfigurationWithoutAlias(List<String> errors, EdgeConfig.Component expectedComponent, EdgeConfig.Component actualComponent)	Checks if the expectedComonents match with the actualComponent without checking the alias.
static boolean	isSameConfigurationWithoutId(List<String> errors, EdgeConfig.Component expectedComponent, EdgeConfig.Component actualComponent)	Checks if the expectedComonents match with the actualComponent without checking the Component-ID.
static boolean	isSameConfigurationWithoutIdAndAlias(List<String> errors, EdgeConfig.Component expectedComponent, EdgeConfig.Component actualComponent)	Checks if the expectedComonents match with the actualComponent without checking the Component-ID and the alias.
static List<EdgeConfig.Component>	order(List<EdgeConfig.Component> components)	orders the list so components that need another component are coming after the needed component.
void	removeIdsInSchedulerIfExisting(User user, List<String> removedIds)	removes the given id s from the scheduler if they exist in the scheduler.
List<String>	removeIdsWhichNotExist(List<String> ids, List<EdgeConfig.Component> components)	Creates a new List with only components which exist in the current configuration or in the passed components list.
void	setSchedulerComponentIds(User user, List<String> componentIds)	Directly 1-to-1 sets the given ids as the scheduler ids.
void	updateHosts(User user, List<InterfaceConfiguration> ips, List<InterfaceConfiguration> oldIps)	updates the host configuration deletes ip s that are in invalid reference oldIps but not in invalid reference ips and adds ip s that are in invalid reference ips but not in invalid reference oldIps .
void	updateInterfaces(User user, List<NetworkInterface<?>> interfaces)	updates the interfaces in the Host configuration.
void	updateScheduler(User user, List<String> schedulerExecutionOrder, List<EdgeConfig.Component> components)	updates the execution order of the scheduler only adds or changes order of the given id s.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.openems.edge.core.appmanager.ComponentUtil

getAllRelayInfos, getAllRelayInfos, getAllRelayInfos, getNextAvailableId

Constructor Details

ComponentUtilImpl

public ComponentUtilImpl(ComponentManager componentManager)

Method Details

equals

public static boolean equals(com.google.gson.JsonElement expected,
 com.google.gson.JsonElement actual)

Validates if the 'actual' matches the 'expected' value.

Parameters:

expected - the expected value

actual - the actual value

Returns:

true if they match

equals

public static boolean equals(List<NetworkInterface<?>> interfaces,
 List<NetworkInterface<?>> otherInterfaces)

Validates if the 'interfaces' matches the 'otherInterfaces'.

Parameters:

interfaces - the first interfaces

otherInterfaces - the second interfaces

Returns:

true if they match

getInterfaces

public static List<NetworkInterface<?>> getInterfaces(com.google.gson.JsonObject json)
                                               throws OpenemsError.OpenemsNamedException

parses all interfaces from the given JsonObject.

Parameters:

json - the JsonObject that contains the interfaces

Returns:

the parsed interfaces

Throws:

OpenemsError.OpenemsNamedException - on error

getInterfaces

public List<NetworkInterface<?>> getInterfaces()
                                        throws OpenemsError.OpenemsNamedException

Description copied from interface: ComponentUtil

Gets the interfaces of the currently active network settings.

Specified by:

getInterfaces in interface ComponentUtil

Returns:

all interfaces in the host configuration

Throws:

OpenemsError.OpenemsNamedException - on error

isSameConfiguration

public static boolean isSameConfiguration(List<String> errors,
 EdgeConfig.Component expectedComponent,
 EdgeConfig.Component actualComponent)

Checks if the expectedComonents match with the actualComponent.

Parameters:

errors - list if something does not match

expectedComponent - the expected component

actualComponent - the actual existing component

Returns:

true if the configurations are the same

isSameConfigurationWithoutAlias

public static boolean isSameConfigurationWithoutAlias(List<String> errors,
 EdgeConfig.Component expectedComponent,
 EdgeConfig.Component actualComponent)

Checks if the expectedComonents match with the actualComponent without checking the alias.

Parameters:

errors - list if something does not match

expectedComponent - the expected component

actualComponent - the actual existing component

Returns:

true if the configurations are the same

isSameConfigurationWithoutId

public static boolean isSameConfigurationWithoutId(List<String> errors,
 EdgeConfig.Component expectedComponent,
 EdgeConfig.Component actualComponent)

Checks if the expectedComonents match with the actualComponent without checking the Component-ID.

Parameters:

errors - list if something does not match

expectedComponent - the expected component

actualComponent - the actual existing component

Returns:

true if the configurations are the same

isSameConfigurationWithoutIdAndAlias

public static boolean isSameConfigurationWithoutIdAndAlias(List<String> errors,
 EdgeConfig.Component expectedComponent,
 EdgeConfig.Component actualComponent)

Checks if the expectedComonents match with the actualComponent without checking the Component-ID and the alias.

Parameters:

errors - list if something does not match

expectedComponent - the expected component

actualComponent - the actual existing component

Returns:

true if the configurations are the same

order

public static List<EdgeConfig.Component> order(List<EdgeConfig.Component> components)

orders the list so components that need another component are coming after the needed component.

Parameters:

components - the component list

Returns:

an ordered copy of the list

anyComponentUses

public boolean anyComponentUses(String value,
 List<String> ignoreIds)

Description copied from interface: ComponentUtil

Checks if any component has the given String in its configuration.

Specified by:

anyComponentUses in interface ComponentUtil

Parameters:

value - that no component should have

ignoreIds - the id s of components which configuration should be ignored

Returns:

true if a component has the given String in its configuration

getAllRelayInfos

public List<ComponentUtil.RelayInfo> getAllRelayInfos(List<String> ignoreIds,
 Predicate<DigitalOutput> componentFilter,
 Function<DigitalOutput,String> componentAliasMapper,
 BiPredicate<DigitalOutput,BooleanWriteChannel> channelFilter,
 BiFunction<DigitalOutput,BooleanWriteChannel,String> channelAliasMapper,
 BiFunction<DigitalOutput,BooleanWriteChannel,List<String>> disabledReasons)

Description copied from interface: ComponentUtil

Gets all RelayInfos of all DigitalOutputs.

Specified by:

getAllRelayInfos in interface ComponentUtil

Parameters:

ignoreIds - the Component-IDs that should be ignored to check if they use any relay

componentFilter - a DigitalOutput component filter

componentAliasMapper - a DigitalOutput component alias mapper

channelFilter - a DigitalOutput channel filter

channelAliasMapper - a DigitalOutput channel alias mapper

disabledReasons - a DigitalOutput channel disabled function

Returns:

a list of RelayInfos

getComponentByConfig

public EdgeConfig.Component getComponentByConfig(EdgeConfig.Component component)

Description copied from interface: ComponentUtil

Searches a component with the given component configuration.

Specified by:

getComponentByConfig in interface ComponentUtil

Parameters:

component - with the configuration to be searched for

Returns:

the found component or null if not found

getEnabledComponentsOfStartingId

public <T extends OpenemsComponent> List<T> getEnabledComponentsOfStartingId(String id)

Description copied from interface: ComponentUtil

Gets the enabled Components with the starting id.

Specified by:

getEnabledComponentsOfStartingId in interface ComponentUtil

Type Parameters:

T - the type to which the components should be assignable to

Parameters:

id - the starting id of the components

Returns:

a list of found components

getEnabledComponentsOfType

public <T extends OpenemsComponent> List<T> getEnabledComponentsOfType(Class<T> clazz)

Description copied from interface: ComponentUtil

Gets the enabled Components of a Type.

the method 'this.componentManager.getEnabledComponentsOfType(clazz)' does not return the component if the given class is an interface and the component has the interface implemented

Specified by:

getEnabledComponentsOfType in interface ComponentUtil

Type Parameters:

T - the type to which the components should be assignable to

Parameters:

clazz - to which the component should be assignable to

Returns:

a list of found components

getNextAvailableId

public String getNextAvailableId(String baseName,
 int startingNumber,
 List<String> componentIds)

Description copied from interface: ComponentUtil

Gets the next available id with the baseName starting with the given startingNumber.

Specified by:

getNextAvailableId in interface ComponentUtil

Parameters:

baseName - like ess, meter without a number

startingNumber - the number at the end of the id to start from

componentIds - the used componentIds from the other apps, because if the user updates multiple instances very quickly and components of the same type are created they are not instantly added to the componentManager

Returns:

the id

getPreferredRelays

public String[] getPreferredRelays(List<ComponentUtil.RelayInfo> relayInfos,
 int numberOfRelays,
 List<ComponentUtil.PreferredRelay> preferredRelaysDefinitions)

Description copied from interface: ComponentUtil

Gets the preferred relays. If the default ports are already taken the next available in a row are taken. If not enough in a row are available the first available relays of any relay are returned.

Specified by:

getPreferredRelays in interface ComponentUtil

Parameters:

relayInfos - the RelayInfos to search in for the preferred relays

numberOfRelays - the number of the result number of relays

preferredRelaysDefinitions - the ComponentUtil.PreferredRelay options

Returns:

the first found preferred relays

updateInterfaces

public void updateInterfaces(User user,
 List<NetworkInterface<?>> interfaces)
                      throws OpenemsError.OpenemsNamedException

Description copied from interface: ComponentUtil

updates the interfaces in the Host configuration.

Specified by:

updateInterfaces in interface ComponentUtil

Parameters:

user - the executing user

interfaces - the new interfaces

Throws:

OpenemsError.OpenemsNamedException - on error

updateScheduler

public void updateScheduler(User user,
 List<String> schedulerExecutionOrder,
 List<EdgeConfig.Component> components)
                     throws OpenemsError.OpenemsNamedException

Description copied from interface: ComponentUtil

updates the execution order of the scheduler only adds or changes order of the given id s.

Specified by:

updateScheduler in interface ComponentUtil

Parameters:

user - the executing user

schedulerExecutionOrder - the execution order

components - the components which are currently created

Throws:

OpenemsError.OpenemsNamedException - when the scheduler can not be updated

removeIdsInSchedulerIfExisting

public void removeIdsInSchedulerIfExisting(User user,
 List<String> removedIds)
                                    throws OpenemsError.OpenemsNamedException

Description copied from interface: ComponentUtil

removes the given id s from the scheduler if they exist in the scheduler.

Specified by:

removeIdsInSchedulerIfExisting in interface ComponentUtil

Parameters:

user - the executing user

removedIds - the ip s that should be removed

Throws:

OpenemsError.OpenemsNamedException - on error

setSchedulerComponentIds

public void setSchedulerComponentIds(User user,
 List<String> componentIds)
                              throws OpenemsError.OpenemsNamedException

Description copied from interface: ComponentUtil

Directly 1-to-1 sets the given ids as the scheduler ids.

Specified by:

setSchedulerComponentIds in interface ComponentUtil

Parameters:

user - the executing user

componentIds - the scheduler ids

Throws:

OpenemsError.OpenemsNamedException - when the scheduler can not be updated

getSchedulerIds

public List<String> getSchedulerIds()
                             throws OpenemsError.OpenemsNamedException

Description copied from interface: ComponentUtil

Gets the current id's in the scheduler.

Specified by:

getSchedulerIds in interface ComponentUtil

Returns:

the id's

Throws:

OpenemsError.OpenemsNamedException - on error

getScheduler

public EdgeConfig.Component getScheduler()
                                  throws OpenemsError.OpenemsNamedException

Description copied from interface: ComponentUtil

Gets the scheduler Component.

Specified by:

getScheduler in interface ComponentUtil

Returns:

the scheduler component

Throws:

OpenemsError.OpenemsNamedException - if more or no scheduler is available

removeIdsWhichNotExist

public List<String> removeIdsWhichNotExist(List<String> ids,
 List<EdgeConfig.Component> components)

Description copied from interface: ComponentUtil

Creates a new List with only components which exist in the current configuration or in the passed components list.

Specified by:

removeIdsWhichNotExist in interface ComponentUtil

Parameters:

ids - the initial list

components - the current creating components

Returns:

a new list only with id's of components that exist

insertSchedulerOrder

public List<String> insertSchedulerOrder(List<String> actualOrder,
 List<String> insertOrder)

Description copied from interface: ComponentUtil

Inserts the insertOrder into the actual Order.

Specified by:

insertSchedulerOrder in interface ComponentUtil

Parameters:

actualOrder - the current scheduler order

insertOrder - the order which should be inserted

Returns:

the complete order

updateHosts

public void updateHosts(User user,
 List<InterfaceConfiguration> ips,
 List<InterfaceConfiguration> oldIps)
                 throws OpenemsError.OpenemsNamedException

Description copied from interface: ComponentUtil

updates the host configuration deletes ip s that are in

invalid reference

oldIps

but not in

invalid reference

ips

and adds ip s that are in

invalid reference

ips

but not in

invalid reference

oldIps

.

Specified by:

updateHosts in interface ComponentUtil

Parameters:

user - the executing user

ips - the ip s that should be in the configuration

oldIps - the old ip s that were in the old configuration

Throws:

OpenemsError.OpenemsNamedException - on error

getComponent

public Optional<EdgeConfig.Component> getComponent(String id,
 String factoryId)

Description copied from interface: ComponentUtil

Gets an Optional of an EdgeConfig.Component.

Specified by:

getComponent in interface ComponentUtil

Parameters:

id - the id of the component

factoryId - the factoryId of the component

Returns:

the optional component

getUsedModbusUnitIds

public int[] getUsedModbusUnitIds(String modbusComponent)

Description copied from interface: ComponentUtil

Gets an array of modbus unit ids which are already used by other components. The result of this method may not contain all modbus unit ids.

Specified by:

getUsedModbusUnitIds in interface ComponentUtil

Parameters:

modbusComponent - the id of the modbus component

Returns:

an array of used modbus unit ids