Open Kilda Java Documentation
org.openkilda.northbound.converter.FlowMapper Interface Reference

Public Member Functions

VerificationOutput toVerificationOutput (FlowVerificationResponse response)
 
FlowReroutePayload toReroutePayload (String flowId, PathInfoData path, boolean rerouted)
 
FlowIdStatusPayload toFlowIdStatusPayload (BidirectionalFlow flow)
 
FlowPathPayload toFlowPathPayload (BidirectionalFlow flow)
 
default FlowPayload toFlowPayload (Flow flow)
 
default List< PathNodePayloadtoPathNodePayloadList (Flow flow)
 
default String getVerificationError (FlowVerificationErrorCode error)
 

Detailed Description

Definition at line 40 of file FlowMapper.java.

Member Function Documentation

◆ getVerificationError()

default String org.openkilda.northbound.converter.FlowMapper.getVerificationError ( FlowVerificationErrorCode  error)

Translate Java's error code(enum) into human readable string.

Definition at line 112 of file FlowMapper.java.

◆ toFlowIdStatusPayload()

FlowIdStatusPayload org.openkilda.northbound.converter.FlowMapper.toFlowIdStatusPayload ( BidirectionalFlow  flow)

◆ toFlowPathPayload()

FlowPathPayload org.openkilda.northbound.converter.FlowMapper.toFlowPathPayload ( BidirectionalFlow  flow)

◆ toFlowPayload()

default FlowPayload org.openkilda.northbound.converter.FlowMapper.toFlowPayload ( Flow  flow)

Converts Flow to FlowPayload.

Definition at line 67 of file FlowMapper.java.

◆ toPathNodePayloadList()

default List<PathNodePayload> org.openkilda.northbound.converter.FlowMapper.toPathNodePayloadList ( Flow  flow)

Makes flow path as list of PathNodePayload representation by a Flow instance. Includes input and output nodes.

Parameters
flowthe Flow instance.
Returns
flow path as list of PathNodePayload representation.

Definition at line 92 of file FlowMapper.java.

◆ toReroutePayload()

FlowReroutePayload org.openkilda.northbound.converter.FlowMapper.toReroutePayload ( String  flowId,
PathInfoData  path,
boolean  rerouted 
)

◆ toVerificationOutput()

VerificationOutput org.openkilda.northbound.converter.FlowMapper.toVerificationOutput ( FlowVerificationResponse  response)

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