Open Kilda Java Documentation
org.openkilda.northbound.service.FlowService Interface Reference
Inheritance diagram for org.openkilda.northbound.service.FlowService:
org.openkilda.northbound.service.BasicService org.openkilda.northbound.service.impl.FlowServiceImpl

Public Member Functions

FlowPayload createFlow (final FlowPayload flow)
 
FlowPayload deleteFlow (final String id)
 
FlowPayload updateFlow (final FlowPayload flow)
 
FlowPayload getFlow (final String id)
 
List< FlowPayloadgetFlows ()
 
List< FlowPayloaddeleteFlows ()
 
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< FlowValidationDtovalidateFlow (final String flowId)
 
VerificationOutput verifyFlow (String flowId, VerificationInput payload)
 
FlowCacheSyncResults syncFlowCache (SynchronizeCacheAction syncCacheAction)
 
- Public Member Functions inherited from org.openkilda.northbound.service.BasicService
default InfoData validateInfoMessage (final Message requestMessage, final Message responseMessage, final String correlationId)
 

Additional Inherited Members

- Public Attributes inherited from org.openkilda.northbound.service.BasicService
Logger logger = LoggerFactory.getLogger(BasicService.class)
 

Detailed Description

FlowService is for operations on flows, primarily against the Flow Topology.

Definition at line 35 of file FlowService.java.

Member Function Documentation

◆ createFlow()

FlowPayload org.openkilda.northbound.service.FlowService.createFlow ( final FlowPayload  flow)

Creates flow.

Parameters
flowflow
Returns
created flow

Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.

◆ deleteFlow()

FlowPayload org.openkilda.northbound.service.FlowService.deleteFlow ( final String  id)

Deletes flow.

Parameters
idflow id
Returns
deleted flow

Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.

◆ deleteFlows()

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 ..

Returns
the list of all deleted flows

Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.

◆ getFlow()

FlowPayload org.openkilda.northbound.service.FlowService.getFlow ( final String  id)

Gets flow by id.

Parameters
idflow id
Returns
flow

Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.

◆ getFlows()

List<FlowPayload> org.openkilda.northbound.service.FlowService.getFlows ( )

Gets all the flows.

Returns
the list of all flows with specified status

Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.

◆ pathFlow()

FlowPathPayload org.openkilda.northbound.service.FlowService.pathFlow ( final String  id)

Gets flow path by id.

Parameters
idflow id
Returns
Flow path

Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.

◆ pushFlows()

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.

Parameters
externalFlowsthe list of flows to push.
propagateif true, the path/rules will be propagated to the switch
verifyif true, we'll wait up to poll seconds to confirm if rules have been applied
Returns

Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.

◆ rerouteFlow()

FlowReroutePayload org.openkilda.northbound.service.FlowService.rerouteFlow ( final String  flowId)

Performs rerouting of specific flow.

Parameters
flowIdid of flow to be rerouted.
Returns
updated flow path information with the result whether or not path was changed.

Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.

◆ statusFlow()

FlowIdStatusPayload org.openkilda.northbound.service.FlowService.statusFlow ( final String  id)

Gets flow status by id.

Parameters
idflow id
Returns
flow status

Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.

◆ syncFlow()

FlowReroutePayload org.openkilda.northbound.service.FlowService.syncFlow ( final String  flowId)

Performs synchronization (reinstalling) of specific flow.

Parameters
flowIdid of flow to be synchronized.
Returns
updated flow.

Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.

◆ syncFlowCache()

FlowCacheSyncResults org.openkilda.northbound.service.FlowService.syncFlowCache ( SynchronizeCacheAction  syncCacheAction)

Sync the FlowCache in the flow topology (in case it is out of sync.

Parameters
syncCacheActiondescribes how to synchronize the cache.
Returns
details on performed updates.

Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.

◆ unpushFlows()

BatchResults org.openkilda.northbound.service.FlowService.unpushFlows ( final List< FlowInfoData externalFlows,
Boolean  propagate,
Boolean  verify 
)

Use this to unpush flows .. ie undo a push

Parameters
externalFlowsthe list of flows to unpush.
propagateif true, the path/rules will be propagated to the switch
verifyif true, we'll wait up to poll seconds to confirm if rules have been applied
Returns

Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.

◆ updateFlow()

FlowPayload org.openkilda.northbound.service.FlowService.updateFlow ( final FlowPayload  flow)

Updates flow.

Parameters
flowflow
Returns
updated flow

Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.

◆ validateFlow()

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.

Parameters
flowIdid of the flow
Returns
the results of the comparison, or null if the flow isn't found.
Exceptions
java.nio.file.InvalidPathExceptionif the flow doesn't return a path and it should.

Implemented in org.openkilda.northbound.service.impl.FlowServiceImpl.

◆ verifyFlow()

VerificationOutput org.openkilda.northbound.service.FlowService.verifyFlow ( String  flowId,
VerificationInput  payload 
)

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