org.openkilda.controller.FlowController Class Reference

Inheritance diagram for org.openkilda.controller.FlowController:

Public Member Functions
ModelAndView	flowList (final HttpServletRequest request)
ModelAndView	flowDetails (final HttpServletRequest request)
Collection< FlowCount >	getFlowCount ()
List< FlowInfo >	getFlows ()
FlowPayload	getFlowPath (@PathVariable final String flowId)
FlowPath	rerouteFlow (@PathVariable final String flowId)
String	validateFlow (@PathVariable final String flowId)
Flow	getFlowById (@PathVariable final String flowId)
FlowStatus	getFlowStatusById (@PathVariable final String flowId)
Flow	createFlow (@RequestBody final Flow flow)
Flow	updateFlow (@PathVariable("flowId") final String flowId, @RequestBody final Flow flow)
Flow	deleteFlow (@RequestBody final UserInfo userInfo, @PathVariable("flowId") final String flowId)
Public Member Functions inherited from org.openkilda.controller.BaseController
ModelAndView	validateAndRedirect (final HttpServletRequest request, final String viewName)
ModelAndView	error (final Model model)
String	getErrorPath ()

Additional Inherited Members
Protected Member Functions inherited from org.openkilda.controller.BaseController
UserInfo	getLoggedInUser (final HttpServletRequest request)
boolean	isUserLoggedIn ()

Detailed Description

The Class FlowController.

Author

Gaurav Chugh

Definition at line 44 of file FlowController.java.

Member Function Documentation

createFlow()

Flow org.openkilda.controller.FlowController.createFlow

(

@RequestBody final Flow

flow

)

Creates the flow.

Parameters

flow

the flow

Returns

the flow

Definition at line 184 of file FlowController.java.

deleteFlow()

Flow org.openkilda.controller.FlowController.deleteFlow	(	@RequestBody final UserInfo	userInfo,
		@PathVariable("flowId") final String	flowId
	)

Delete flow.

Parameters

userInfo	the user info
flowId	the flow id

Returns

the flow

Definition at line 214 of file FlowController.java.

flowDetails()

ModelAndView org.openkilda.controller.FlowController.flowDetails

(

final HttpServletRequest

request

)

Return to flow details view.

Parameters

request

is HttpServletRequest with request information

Returns

flow details view if called with valid user session.

Definition at line 76 of file FlowController.java.

flowList()

ModelAndView org.openkilda.controller.FlowController.flowList

(

final HttpServletRequest

request

)

Return to flows view.

Parameters

request

is HttpServletRequest with request information

Returns

flows view if called with valid user session.

Definition at line 65 of file FlowController.java.

getFlowById()

Flow org.openkilda.controller.FlowController.getFlowById

(

@PathVariable final String

flowId

)

Get flow by Id

Parameters

flowId

id of flow requested.

Returns

flow

Definition at line 157 of file FlowController.java.

getFlowCount()

Collection<FlowCount> org.openkilda.controller.FlowController.getFlowCount

(

)

Returns information of no of flow between any two switches.

Returns

no of flow between any two switches.

Definition at line 88 of file FlowController.java.

getFlowPath()

FlowPayload org.openkilda.controller.FlowController.getFlowPath

(

@PathVariable final String

flowId

)

Returns flow path with all nodes/switches exists in provided flow.

Parameters

flowId

id of flow path requested.

Returns

flow path with all nodes/switches exists in provided flow

Definition at line 116 of file FlowController.java.

getFlows()

List<FlowInfo> org.openkilda.controller.FlowController.getFlows

(

)

Returns all flows exists in the system.

Returns

all flows exists in the system.

Definition at line 104 of file FlowController.java.

getFlowStatusById()

FlowStatus org.openkilda.controller.FlowController.getFlowStatusById

(

@PathVariable final String

flowId

)

Get flow Status by Id

Parameters

flowId

id of flow requested.

Returns

flow

Definition at line 170 of file FlowController.java.

rerouteFlow()

FlowPath org.openkilda.controller.FlowController.rerouteFlow

(

@PathVariable final String

flowId

)

Re route the flow and returns flow path with all nodes/switches exists in provided flow.

Parameters

flowId

id of reroute requested.

Returns

reroute flow of new flow path with all nodes/switches exist

Definition at line 129 of file FlowController.java.

updateFlow()

Flow org.openkilda.controller.FlowController.updateFlow	(	@PathVariable("flowId") final String	flowId,
		@RequestBody final Flow	flow
	)

Update flow.

Parameters

flowId	the flow id
flow	the flow

Returns

the flow

Definition at line 199 of file FlowController.java.

validateFlow()

String org.openkilda.controller.FlowController.validateFlow

(

@PathVariable final String

flowId

)

Validate the flow

Parameters

flowId

id of validate flow requested.

Returns

validate flow

Definition at line 143 of file FlowController.java.

---

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

• /Users/kevin/Desktop/Kilda/open-kilda-develop/services/src/openkilda-gui/src/main/java/org/openkilda/controller/FlowController.java