Open Kilda Java Documentation
org.openkilda.messaging.Message Class Reference
Inheritance diagram for org.openkilda.messaging.Message:
org.openkilda.messaging.BaseMessage org.openkilda.messaging.command.CommandMessage org.openkilda.messaging.ctrl.CtrlRequest org.openkilda.messaging.ctrl.CtrlResponse org.openkilda.messaging.error.ErrorMessage org.openkilda.messaging.HeartBeat org.openkilda.messaging.info.InfoMessage org.openkilda.messaging.command.CommandWithReplyToMessage org.openkilda.messaging.info.ChunkedInfoMessage

Public Member Functions

 Message (@JsonProperty(TIMESTAMP) final long timestamp, @JsonProperty(CORRELATION_ID) final String correlationId, @JsonProperty(DESTINATION) final Destination destination)
 
 Message (final long timestamp, final String correlationId)
 
String getCorrelationId ()
 
Destination getDestination ()
 
void setDestination (final Destination destination)
 
String toString ()
 
- Public Member Functions inherited from org.openkilda.messaging.BaseMessage
 BaseMessage (@JsonProperty(TIMESTAMP) final long timestamp)
 
 BaseMessage ()
 
long getTimestamp ()
 
void setTimestamp (long timestamp)
 

Protected Attributes

String correlationId
 
Destination destination
 
- Protected Attributes inherited from org.openkilda.messaging.BaseMessage
long timestamp = 0L
 

Additional Inherited Members

- Static Public Member Functions inherited from org.openkilda.messaging.BaseMessage
static final< T extends BaseMessage > T getMessage (String json, Class< T > type) throws java.io.IOException
 
static final< T extends BaseMessage > T tryGetMessage (String json, Class< T > type)
 

Detailed Description

Class represents high level view of every message used by any service.

Definition at line 42 of file Message.java.

Constructor & Destructor Documentation

◆ Message() [1/2]

org.openkilda.messaging.Message.Message ( @JsonProperty(TIMESTAMP) final long  timestamp,
@JsonProperty(CORRELATION_ID) final String  correlationId,
@JsonProperty(DESTINATION) final Destination  destination 
)

Instance constructor.

Parameters
timestampmessage timestamp
correlationIdmessage correlation id
destinationmessage destination

Definition at line 69 of file Message.java.

◆ Message() [2/2]

org.openkilda.messaging.Message.Message ( final long  timestamp,
final String  correlationId 
)

Instance constructor.

Parameters
timestampmessage timestamp
correlationIdmessage correlation id

Definition at line 83 of file Message.java.

Member Function Documentation

◆ getCorrelationId()

String org.openkilda.messaging.Message.getCorrelationId ( )

Returns message correlation id.

Returns
message correlation id

Definition at line 93 of file Message.java.

◆ getDestination()

Destination org.openkilda.messaging.Message.getDestination ( )

Returns message destination.

Returns
message destination

Definition at line 102 of file Message.java.

◆ setDestination()

void org.openkilda.messaging.Message.setDestination ( final Destination  destination)

Sets message destination.

Parameters
destinationmessage destination

Definition at line 111 of file Message.java.

◆ toString()

String org.openkilda.messaging.Message.toString ( )

Definition at line 119 of file Message.java.

Member Data Documentation

◆ correlationId

String org.openkilda.messaging.Message.correlationId
protected

Message correlation id. Correlation ID request value for Northbound messages or generated value without REST API calls (re-flow, etc.).

Definition at line 53 of file Message.java.

◆ destination

Destination org.openkilda.messaging.Message.destination
protected

Message destination.

Definition at line 59 of file Message.java.


The documentation for this class was generated from the following file: