de.iip_ecosphere.platform.transport.status

Class StatusMessage

java.lang.Object

de.iip_ecosphere.platform.transport.status.StatusMessage

public class StatusMessage
extends Object

Represents a status message for a component. A component is denoted by the device id (of the ECS runtime) the component is running on, the component id (in the context of a device) and optional alias ids, e.g., introduced by a specific device management approach. If the component to notify about is a device, the device id and the component id shall be equal.

Author:

Holger Eichelberger, SSE

Field Summary

Fields

Modifier and Type	Field and Description
private ActionType	action
private String[]	aliasIds
private ComponentType	componentType
private String	description
private String	deviceId
private String	id
private int	progress
static String	STATUS_STREAM
private String	subDescription

Constructor Summary

Constructors

Constructor and Description
StatusMessage() Creates an empty status message.
StatusMessage(ActionType action, String id, String... aliasIds) Creates a new status message for devices, i.e., ComponentTypes.DEVICE.
StatusMessage(ComponentType componentType, ActionType action, String id, String deviceId, String... aliasIds) Creates a new status message.

Method Summary

Modifier and Type	Method and Description
ActionType	getAction() Returns the action type causing this message.
String[]	getAliasIds() Returns optional alias ids of the component.
ComponentType	getComponentType() Returns the component type.
String	getDescription() Returns the description, ActionTypes.PROCESS.
String	getDeviceId() Returns the device (context) id of the component.
String	getId() Returns the primary id of the component.
int	getProgress() Returns the progress for ActionTypes.PROCESS.
String	getSubDescription() Returns the sub(-task) description, ActionTypes.PROCESS.
void	send(TransportConnector conn) Sends this message to the given connector on #STATUS_STREAM.
(package private) void	setAction(ActionType action) Changes the action type.
(package private) void	setAliasIds(String[] aliasIds) Changes the alias ids of the component.
(package private) void	setComponentType(ComponentType componentType) Changes the component type.
(package private) void	setDeviceId(String deviceId) Changes the device (context) id of the component.
(package private) void	setId(String id) Changes the primary id of the component.
StatusMessage	withDescription(String description) Sets the description for getProgress(), ActionTypes.PROCESS.
StatusMessage	withProgress(int progress) Defines the progress for ActionTypes.PROCESS.
StatusMessage	withSubDescription(String subDescription) Sets the sub(-task) description for getProgress(), ActionTypes.PROCESS.

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_STREAM

public static final String STATUS_STREAM

See Also:

Constant Field Values

componentType

private ComponentType componentType

action

private ActionType action

id

private String id

aliasIds

private String[] aliasIds

deviceId

private String deviceId

progress

private int progress

description

private String description

subDescription

private String subDescription

Constructor Detail

StatusMessage

StatusMessage()

Creates an empty status message. [deserialization]

StatusMessage

public StatusMessage(ActionType action,
                     String id,
                     String... aliasIds)

Creates a new status message for devices, i.e., ComponentTypes.DEVICE.

Parameters:

action - the action

id - the id of the component

aliasIds - optional alias ids

StatusMessage

public StatusMessage(ComponentType componentType,
                     ActionType action,
                     String id,
                     String deviceId,
                     String... aliasIds)

Creates a new status message.

Parameters:

componentType - the component type

action - the action

id - the id of the component

deviceId - the id of device providing the context, shall be equal to id if componentType is ComponentTypes.DEVICE.

aliasIds - optional alias ids

Method Detail

getComponentType

public ComponentType getComponentType()

Returns the component type.

Returns:

the component type

setComponentType

void setComponentType(ComponentType componentType)

Changes the component type. [deserialization]

Parameters:

componentType - the new component type

getAction

public ActionType getAction()

Returns the action type causing this message.

Returns:

the action type causing this message

setAction

void setAction(ActionType action)

Changes the action type. [deserialization]

Parameters:

action - the new action type

getId

public String getId()

Returns the primary id of the component.

Returns:

the primary id, may be equal to getDeviceId() if getComponentType() is ComponentTypes.DEVICE.

setId

void setId(String id)

Changes the primary id of the component. [deserialization]

Parameters:

id - the primary id

getDeviceId

public String getDeviceId()

Returns the device (context) id of the component.

Returns:

the device id, shall be equal to getId() if getComponentType() is ComponentTypes.DEVICE.

setDeviceId

void setDeviceId(String deviceId)

Changes the device (context) id of the component. [deserialization]

Parameters:

deviceId - the device id

getAliasIds

public String[] getAliasIds()

Returns optional alias ids of the component.

Returns:

the alias ids, may be empty

setAliasIds

void setAliasIds(String[] aliasIds)

Changes the alias ids of the component. [deserialization]

Parameters:

aliasIds - the primary id

send

public void send(TransportConnector conn)
          throws IOException

Sends this message to the given connector on #STATUS_STREAM. [convenience]

Parameters:

conn - the connector

Throws:

IOException - if sending fails

withProgress

public StatusMessage withProgress(int progress)

Defines the progress for ActionTypes.PROCESS.

Parameters:

progress - the progress in [0;100]; if 100 longer running process is assumed to be completed

Returns:

this

getProgress

public int getProgress()

Returns the progress for ActionTypes.PROCESS.

Returns:

the progress in percent: if negative, no progress will be reported. If positive, further messages shall follow until 100.

withDescription

public StatusMessage withDescription(String description)

Sets the description for getProgress(), ActionTypes.PROCESS.

Parameters:

description - the description, may be null or ""

Returns:

this

getDescription

public String getDescription()

Returns the description, ActionTypes.PROCESS.

Returns:

the description, may be empty but not null

withSubDescription

public StatusMessage withSubDescription(String subDescription)

Sets the sub(-task) description for getProgress(), ActionTypes.PROCESS.

Parameters:

subDescription - the sub(-task) description, may be null or ""

Returns:

this

getSubDescription

public String getSubDescription()

Returns the sub(-task) description, ActionTypes.PROCESS.

Returns:

the sub(-task) description, may be empty but not null