org.openhubframework.openhub.api.entity

Interface Node

All Superinterfaces:

HumanReadable, Identifiable<Long>

All Known Implementing Classes:

AbstractNode, MutableNode

public interface Node
extends HumanReadable, Identifiable<Long>

Contains information about one node in cluster.

Value of attributes in this entity can not be changed. If you want to change value of attributes (like code, name...), use MutableNode.

Since:

2.0

Author:

Roman Havlicek

See Also:

MutableNode

Method Summary

Modifier and Type	Method and Description
String	getCode() Gets code of this node.
String	getDescription() Gets description.
String	getName() Gets name of this node.
Long	getNodeId() Gets node identifier.
NodeState	getState() Gets state of this node.
boolean	isAbleToHandleExistingMessages() Is node handles existing message (from SEDA or MsgStateEnum.PARTLY_FAILED, MsgStateEnum.POSTPONED, etc.).
boolean	isAbleToHandleNewMessages() Is node handles new messages.
boolean	isStopped() Is node for this instance stopping?

Methods inherited from interface org.openhubframework.openhub.api.common.HumanReadable

toHumanString

Methods inherited from interface org.openhubframework.openhub.api.entity.Identifiable

getId, setId

Method Detail

isStopped

boolean isStopped()

Is node for this instance stopping?

Returns:

true if node is in "stopping mode" otherwise false

See Also:

NodeState.STOPPED

isAbleToHandleNewMessages

boolean isAbleToHandleNewMessages()

Is node handles new messages.

Returns:

true node handles new messages, false - otherwise

See Also:

NodeState.RUN

isAbleToHandleExistingMessages

boolean isAbleToHandleExistingMessages()

Is node handles existing message (from SEDA or MsgStateEnum.PARTLY_FAILED, MsgStateEnum.POSTPONED, etc.).

Returns:

true handles existing message, false - otherwise

See Also:

NodeState.HANDLES_EXISTING_MESSAGES

getNodeId

@Nullable
Long getNodeId()

Gets node identifier.

Returns:

node identifier, NULL - node is not persisted

getCode

String getCode()

Gets code of this node.

Returns:

code

getName

String getName()

Gets name of this node.

Returns:

name

getDescription

@Nullable
String getDescription()

Gets description.

Returns:

description, NULL - node has no description

getState

NodeState getState()

Gets state of this node.

Returns:

state