org.openkilda.messaging.command.flow.BaseFlow Class Reference

Inheritance diagram for org.openkilda.messaging.command.flow.BaseFlow:

Public Member Functions
	BaseFlow (@JsonProperty(TRANSACTION_ID) final Long transactionId, @JsonProperty(FLOW_ID) final String id, @JsonProperty("cookie") final Long cookie, @JsonProperty("switch_id") final SwitchId switchId)
Long	getTransactionId ()
void	setTransactionId (final Long transactionId)
String	getId ()
void	setId (final String id)
Long	getCookie ()
void	setCookie (final Long cookie)
SwitchId	getSwitchId ()
void	setSwitchId (SwitchId switchId)
Public Member Functions inherited from org.openkilda.messaging.command.CommandData
String	toString ()
Public Member Functions inherited from org.openkilda.messaging.MessageData
	MessageData (@JsonProperty(TIMESTAMP) final long timestamp)
	MessageData ()
Public Member Functions inherited from org.openkilda.messaging.BaseMessage
	BaseMessage (@JsonProperty(TIMESTAMP) final long timestamp)
	BaseMessage ()
long	getTimestamp ()
void	setTimestamp (long timestamp)

Protected Attributes
Long	transactionId
String	id
Long	cookie
SwitchId	switchId
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

Represents general flow info.

Definition at line 39 of file BaseFlow.java.

Constructor & Destructor Documentation

BaseFlow()

org.openkilda.messaging.command.flow.BaseFlow.BaseFlow	(	@JsonProperty(TRANSACTION_ID) final Long	transactionId,
		@JsonProperty(FLOW_ID) final String	id,
		@JsonProperty("cookie") final Long	cookie,
		@JsonProperty("switch_id") final SwitchId	switchId
	)

Instance constructor.

Parameters

transactionId	transaction id
id	flow id
cookie	cookie of the flow
switchId	switch id for flow management

Exceptions

IllegalArgumentException

if any of mandatory parameters is null

Definition at line 74 of file BaseFlow.java.

Member Function Documentation

getCookie()

Long org.openkilda.messaging.command.flow.BaseFlow.getCookie

(

)

Returns cookie of the flow.

Returns

cookie of the flow

Definition at line 128 of file BaseFlow.java.

getId()

String org.openkilda.messaging.command.flow.BaseFlow.getId

(

)

Returns the flow id.

Returns

the flow id

Definition at line 107 of file BaseFlow.java.

getSwitchId()

SwitchId org.openkilda.messaging.command.flow.BaseFlow.getSwitchId

(

)

Returns id of the switch.

Returns

ID of the switch

Definition at line 146 of file BaseFlow.java.

getTransactionId()

Long org.openkilda.messaging.command.flow.BaseFlow.getTransactionId

(

)

Returns transaction id of the request.

Returns

transaction id of the request

Definition at line 89 of file BaseFlow.java.

setCookie()

void org.openkilda.messaging.command.flow.BaseFlow.setCookie

(

final Long

cookie

)

Sets cookie for the flow.

Parameters

cookie

for the flow

Definition at line 137 of file BaseFlow.java.

setId()

void org.openkilda.messaging.command.flow.BaseFlow.setId

(

final String

id

)

Sets the flow id.

Parameters

id

flow id

Definition at line 116 of file BaseFlow.java.

setSwitchId()

void org.openkilda.messaging.command.flow.BaseFlow.setSwitchId

(

SwitchId

switchId

)

Sets id of the switch.

Parameters

switchId

of the switch

Definition at line 155 of file BaseFlow.java.

setTransactionId()

void org.openkilda.messaging.command.flow.BaseFlow.setTransactionId

(

final Long

transactionId

)

Sets transaction id of the request.

Parameters

transactionId

transaction id of the request

Definition at line 98 of file BaseFlow.java.

Member Data Documentation

cookie

Long org.openkilda.messaging.command.flow.BaseFlow.cookie

protected

Cookie allocated for flow.

Definition at line 56 of file BaseFlow.java.

id

String org.openkilda.messaging.command.flow.BaseFlow.id

protected

The flow id.

Definition at line 50 of file BaseFlow.java.

switchId

SwitchId org.openkilda.messaging.command.flow.BaseFlow.switchId

protected

The switch id to manage flow on. It is a mandatory parameter.

Definition at line 62 of file BaseFlow.java.

transactionId

Long org.openkilda.messaging.command.flow.BaseFlow.transactionId

protected

Transaction id.

Definition at line 44 of file BaseFlow.java.

---

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

• /Users/kevin/Desktop/Kilda/open-kilda-develop/services/src/messaging/src/main/java/org/openkilda/messaging/command/flow/BaseFlow.java