de.iip_ecosphere.platform.transport

Class Transport.TransportInstance

java.lang.Object

de.iip_ecosphere.platform.transport.Transport.TransportInstance

Enclosing class:

Transport

public static class Transport.TransportInstance
extends Object

An instance of the transport.

Author:

Holger Eichelberger, SSE

Field Summary

Fields

Modifier and Type	Field and Description
private TransportConnector	connector
private Queue<de.iip_ecosphere.platform.support.function.IOConsumer<TransportConnector>>	queue
private boolean	stayOffline
private Supplier<TransportSetup>	transportSupplier

Constructor Summary

Constructors

Constructor and Description
TransportInstance() Creates a transport instance without transport setup information (for deferred setup).
TransportInstance(Supplier<TransportSetup> supplier) Creates a transport information instance and sets the transport information.

Method Summary

Modifier and Type	Method and Description
TransportConnector	createConnector() Tries creating a connector.
TransportConnector	getConnector() Returns the transport connector.
void	releaseConnector() Releases an existing connector and stays offline.
void	releaseConnector(boolean stayOff) Releases an existing connector.
void	send(de.iip_ecosphere.platform.support.function.IOConsumer<TransportConnector> sender, String kind) Sends a message of a certain kind and cares for queuing.
void	sendAlert(Alert alert) Sends an alert message.
void	sendContainerStatus(ActionType action, String containerId, String... aliasIds) Sends a container status message.
void	sendProcessStatus(String componentId, int step, int max, String description) Sends information about a processing status.
void	sendProcessStatus(String componentId, int step, int max, String description, String subDescription) Sends information about a processing status.
void	sendResourceStatus(ActionType action, String... aliasIds) Sends a resource status message for this resource.
void	sendResourceStatus(ActionType action, String deviceId, String... aliasIds) Sends a resource status message.
void	sendServiceArtifactStatus(ActionType action, String artifactId, String... aliasIds) Sends a service artifact status message.
void	sendServiceStatus(ActionType action, String serviceId, String... aliasIds) Sends a service status message.
void	sendStatus(StatusMessage msg) Sends a status message.
void	sendTraceRecord(TraceRecord record) Sends a trace record.
void	setTraceFilter(Predicate<TraceRecord> filter) Defines a trace filter.
void	setTransportSetup(Supplier<TransportSetup> supplier) Sets up the transport information.

Methods inherited from class java.lang.Object

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

Field Detail

connector

private TransportConnector connector

stayOffline

private boolean stayOffline

queue

private Queue<de.iip_ecosphere.platform.support.function.IOConsumer<TransportConnector>> queue

transportSupplier

private Supplier<TransportSetup> transportSupplier

Constructor Detail

TransportInstance

public TransportInstance()

Creates a transport instance without transport setup information (for deferred setup). Call setTransportSetup(Supplier) afterwards.

TransportInstance

public TransportInstance(Supplier<TransportSetup> supplier)

Creates a transport information instance and sets the transport information.

Parameters:

supplier - the transport supplier

See Also:

setTransportSetup(Supplier)

Method Detail

setTransportSetup

public void setTransportSetup(Supplier<TransportSetup> supplier)

Sets up the transport information.

Parameters:

supplier - the transport supplier

sendServiceStatus

public void sendServiceStatus(ActionType action,
                              String serviceId,
                              String... aliasIds)

Sends a service status message. Uses Id.getDeviceId(). Calls createConnector() to obtain a connector instance on demand.

Parameters:

action - the action on the service

serviceId - the service Id

aliasIds - optional alias ids for the service

sendServiceArtifactStatus

public void sendServiceArtifactStatus(ActionType action,
                                      String artifactId,
                                      String... aliasIds)

Sends a service artifact status message. Uses Id.getDeviceId(). Calls createConnector() to obtain a connector instance on demand.

Parameters:

action - the action on the artifact

artifactId - the artifact Id

aliasIds - optional alias ids for the artifact

sendContainerStatus

public void sendContainerStatus(ActionType action,
                                String containerId,
                                String... aliasIds)

Sends a container status message. Uses Id.getDeviceId(). Calls createConnector() to obtain a connector instance on demand.

Parameters:

action - the action on the container

containerId - the container Id

aliasIds - optional alias ids for the container

sendResourceStatus

public void sendResourceStatus(ActionType action,
                               String... aliasIds)

Sends a resource status message for this resource. Calls createConnector() to obtain a connector instance on demand.

Parameters:

action - the action on the container

aliasIds - optional alias ids for the resource

sendResourceStatus

public void sendResourceStatus(ActionType action,
                               String deviceId,
                               String... aliasIds)

Sends a resource status message. Calls createConnector() to obtain a connector instance on demand.

Parameters:

action - the action on the container

deviceId - the device id, may be null then Id.getDeviceId() is used

aliasIds - optional alias ids for the resource

send

public void send(de.iip_ecosphere.platform.support.function.IOConsumer<TransportConnector> sender,
                 String kind)

Sends a message of a certain kind and cares for queuing.

Parameters:

sender - the sender including the message

kind - the kind of the message for logging

setTraceFilter

public void setTraceFilter(Predicate<TraceRecord> filter)

Defines a trace filter.

Parameters:

filter - the filter, null for no filter

sendTraceRecord

public void sendTraceRecord(TraceRecord record)

Sends a trace record. Calls createConnector() to obtain a connector instance on demand. Caches messages if no connector is available.

Parameters:

record - the record to be sent

sendProcessStatus

public void sendProcessStatus(String componentId,
                              int step,
                              int max,
                              String description)

Sends information about a processing status.

Parameters:

componentId - the component id

step - the step [0; max]

max - the maximum step

description - the description of the task

sendProcessStatus

public void sendProcessStatus(String componentId,
                              int step,
                              int max,
                              String description,
                              String subDescription)

Sends information about a processing status.

Parameters:

componentId - the component id

step - the step [0; max]

max - the maximum step

description - the description of the task

subDescription - the description of an optional sub-task within the actual task, may be null or empty

sendStatus

public void sendStatus(StatusMessage msg)

Sends a status message. Calls createConnector() to obtain a connector instance on demand. Caches messages if no connector is available.

Parameters:

msg - the message to be sent

sendAlert

public void sendAlert(Alert alert)

Sends an alert message. Calls createConnector() to obtain a connector instance on demand. Caches messages if no connector is available.

Parameters:

alert - the alert to be sent

createConnector

public TransportConnector createConnector()

Tries creating a connector. If successful, connector will be initialized for caching. The instance is cached. The transport information must be set up before setTransportSetup(Supplier). After successfully creating a connector, queued messages are sent and removed from the queue. However, there is no guarantee that a connector can be created.

Returns:

the (cached) connector, may be null

See Also:

setTransportSetup(Supplier), releaseConnector(), releaseConnector(boolean)

releaseConnector

public void releaseConnector()

Releases an existing connector and stays offline.

releaseConnector

public void releaseConnector(boolean stayOff)

Releases an existing connector.

Parameters:

stayOff - whether a call to createConnector() shall create a new connector or prevent sending further messages.

getConnector

public TransportConnector getConnector()

Returns the transport connector.

Returns:

the transport connector, may be null

See Also:

createConnector()