![]() |
Open Kilda Java Documentation
|
Public Member Functions | |
FlowPayload | createFlow (final FlowPayload flow) |
FlowPayload | deleteFlow (final String id) |
FlowPayload | updateFlow (final FlowPayload flow) |
FlowPayload | getFlow (final String id) |
List< FlowPayload > | getFlows () |
List< FlowPayload > | deleteFlows () |
FlowIdStatusPayload | statusFlow (final String id) |
FlowPathPayload | pathFlow (final String id) |
BatchResults | pushFlows (final List< FlowInfoData > externalFlows, Boolean propagate, Boolean verify) |
BatchResults | unpushFlows (final List< FlowInfoData > externalFlows, Boolean propagate, Boolean verify) |
FlowReroutePayload | rerouteFlow (final String flowId) |
FlowReroutePayload | syncFlow (final String flowId) |
List< FlowValidationDto > | validateFlow (final String flowId) |
VerificationOutput | verifyFlow (String flowId, VerificationInput payload) |
FlowCacheSyncResults | syncFlowCache (SynchronizeCacheAction syncCacheAction) |
![]() | |
default InfoData | validateInfoMessage (final Message requestMessage, final Message responseMessage, final String correlationId) |
Additional Inherited Members | |
![]() | |
Logger | logger = LoggerFactory.getLogger(BasicService.class) |
FlowService is for operations on flows, primarily against the Flow Topology.
Definition at line 35 of file FlowService.java.
FlowPayload org.openkilda.northbound.service.FlowService.createFlow | ( | final FlowPayload | flow | ) |
Creates flow.
flow | flow |
Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.
FlowPayload org.openkilda.northbound.service.FlowService.deleteFlow | ( | final String | id | ) |
Deletes flow.
id | flow id |
Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.
List<FlowPayload> org.openkilda.northbound.service.FlowService.deleteFlows | ( | ) |
Deletes all flows. Primarily this is a combination of getFlows and deleteFlow. This should be called with care ..
Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.
FlowPayload org.openkilda.northbound.service.FlowService.getFlow | ( | final String | id | ) |
Gets flow by id.
id | flow id |
Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.
List<FlowPayload> org.openkilda.northbound.service.FlowService.getFlows | ( | ) |
Gets all the flows.
Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.
FlowPathPayload org.openkilda.northbound.service.FlowService.pathFlow | ( | final String | id | ) |
Gets flow path by id.
id | flow id |
Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.
BatchResults org.openkilda.northbound.service.FlowService.pushFlows | ( | final List< FlowInfoData > | externalFlows, |
Boolean | propagate, | ||
Boolean | verify | ||
) |
Use this to push flows that may not be in the database / caches but they should be.
externalFlows | the list of flows to push. |
propagate | if true, the path/rules will be propagated to the switch |
verify | if true, we'll wait up to poll seconds to confirm if rules have been applied |
Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.
FlowReroutePayload org.openkilda.northbound.service.FlowService.rerouteFlow | ( | final String | flowId | ) |
Performs rerouting of specific flow.
flowId | id of flow to be rerouted. |
Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.
FlowIdStatusPayload org.openkilda.northbound.service.FlowService.statusFlow | ( | final String | id | ) |
Gets flow status by id.
id | flow id |
Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.
FlowReroutePayload org.openkilda.northbound.service.FlowService.syncFlow | ( | final String | flowId | ) |
Performs synchronization (reinstalling) of specific flow.
flowId | id of flow to be synchronized. |
Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.
FlowCacheSyncResults org.openkilda.northbound.service.FlowService.syncFlowCache | ( | SynchronizeCacheAction | syncCacheAction | ) |
Sync the FlowCache in the flow topology (in case it is out of sync.
syncCacheAction | describes how to synchronize the cache. |
Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.
BatchResults org.openkilda.northbound.service.FlowService.unpushFlows | ( | final List< FlowInfoData > | externalFlows, |
Boolean | propagate, | ||
Boolean | verify | ||
) |
Use this to unpush flows .. ie undo a push
externalFlows | the list of flows to unpush. |
propagate | if true, the path/rules will be propagated to the switch |
verify | if true, we'll wait up to poll seconds to confirm if rules have been applied |
Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.
FlowPayload org.openkilda.northbound.service.FlowService.updateFlow | ( | final FlowPayload | flow | ) |
Updates flow.
flow | flow |
Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.
List<FlowValidationDto> org.openkilda.northbound.service.FlowService.validateFlow | ( | final String | flowId | ) |
Performs validation of specific flow - ie comparing what is in the database with what is on the network.
flowId | id of the flow |
java.nio.file.InvalidPathException | if the flow doesn't return a path and it should. |
Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.
VerificationOutput org.openkilda.northbound.service.FlowService.verifyFlow | ( | String | flowId, |
VerificationInput | payload | ||
) |
Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.