Package io.openems.backend.common.component

Class AbstractOpenemsBackendComponent

java.lang.Object

io.openems.backend.common.component.AbstractOpenemsBackendComponent

Direct Known Subclasses:

AbstractMetadata, Alerting, B2bRest, B2bWebsocket, EdgeWebsocketImpl, InfluxImpl, JsonRpcRequestHandlerImpl, TimedataDummy, TimedataManagerImpl, TimescaledbImpl, UiWebsocketImpl

public class AbstractOpenemsBackendComponent
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
AbstractOpenemsBackendComponent(java.lang.String name)	Initializes the AbstractOpenemsBackendComponent.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getName()	A descriptive name for this component.
static void	logDebug(AbstractOpenemsBackendComponent component, org.slf4j.Logger log, java.lang.String message)	Log a debug message including the Component ID.
protected void	logDebug(org.slf4j.Logger log, java.lang.String message)	Log a debug message including the Component ID.
static void	logError(AbstractOpenemsBackendComponent component, org.slf4j.Logger log, java.lang.String message)	Log a error message including the Component ID.
protected void	logError(org.slf4j.Logger log, java.lang.String message)	Log an error message including the Component ID.
static void	logInfo(AbstractOpenemsBackendComponent component, org.slf4j.Logger log, java.lang.String message)	Log a info message including the Component ID.
protected void	logInfo(org.slf4j.Logger log, java.lang.String message)	Log an info message including the Component ID.
static void	logWarn(AbstractOpenemsBackendComponent component, org.slf4j.Logger log, java.lang.String message)	Log a warn message including the Component ID.
protected void	logWarn(org.slf4j.Logger log, java.lang.String message)	Log a warn message including the Component ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractOpenemsBackendComponent

public AbstractOpenemsBackendComponent(java.lang.String name)

Initializes the AbstractOpenemsBackendComponent.

Parameters:

name - a descriptive name for this component. Available via getName()

Method Detail

getName

public java.lang.String getName()

A descriptive name for this component.

Returns:

the name

logInfo

public static void logInfo(AbstractOpenemsBackendComponent component,
                           org.slf4j.Logger log,
                           java.lang.String message)

Log a info message including the Component ID.

Parameters:

component - the AbstractOpenemsBackendComponent

log - the Logger instance

message - the message

logInfo

protected void logInfo(org.slf4j.Logger log,
                       java.lang.String message)

Log an info message including the Component ID.

Parameters:

log - the Logger that is used for writing the log

message - the Info-message

logWarn

public static void logWarn(AbstractOpenemsBackendComponent component,
                           org.slf4j.Logger log,
                           java.lang.String message)

Log a warn message including the Component ID.

Parameters:

component - the AbstractOpenemsBackendComponent

log - the Logger instance

message - the message

logWarn

protected void logWarn(org.slf4j.Logger log,
                       java.lang.String message)

Log a warn message including the Component ID.

Parameters:

log - the Logger that is used for writing the log

message - the Warn-message

logError

public static void logError(AbstractOpenemsBackendComponent component,
                            org.slf4j.Logger log,
                            java.lang.String message)

Log a error message including the Component ID.

Parameters:

component - the AbstractOpenemsBackendComponent

log - the Logger instance

message - the message

logError

protected void logError(org.slf4j.Logger log,
                        java.lang.String message)

Log an error message including the Component ID.

Parameters:

log - the Logger that is used for writing the log

message - the Error-message

logDebug

public static void logDebug(AbstractOpenemsBackendComponent component,
                            org.slf4j.Logger log,
                            java.lang.String message)

Log a debug message including the Component ID.

Parameters:

component - the AbstractOpenemsBackendComponent

log - the Logger instance

message - the message

logDebug

protected void logDebug(org.slf4j.Logger log,
                        java.lang.String message)

Log a debug message including the Component ID.

Parameters:

log - the Logger that is used for writing the log

message - the Debug-message