com.hp.of.ctl.prio

Interface FlowClassAdministrator

public interface FlowClassAdministrator

Abstraction of an administrative aspect of the flow class priority broker. It provides means to dynamically augment or override relative positioning hints supplied during flow class registration.

Author:

Thomas Vachuska, Simon Hunt, Uyen Chau

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FlowClassAdministrator.EnforcementLevel

Method Summary

Methods

Modifier and Type	Method and Description
FlowClassAdministrator.EnforcementLevel	enforcementLevel() Indicates the level of flow mod enforcement to indicate whether flow mod registrations are being enforced and flow mods are being inspected for compliance.
Collection<FlowClassConstraints>	getAllConstraints() Returns all flow class constraints added via via setConstraints(java.lang.String, long, com.hp.of.ctl.prio.FlowClassConstraints.Type, java.util.Set<java.lang.String>, java.util.Set<java.lang.String>).
FlowClassConstraints	getConstraints(String id) Returns set of constraints added via via setConstraints(java.lang.String, long, com.hp.of.ctl.prio.FlowClassConstraints.Type, java.util.Set<java.lang.String>, java.util.Set<java.lang.String>) for the specified flow class.
FlowClass	getPlaceholder(String id) Gets the temporary placeholder flow class, if one exists, for the specified flow class id.
FlowClass	registerPlaceholder(String id, Set<String> lowerIds, Set<String> higherIds) Registers a placeholder flow class using the supplied positional hints.
void	removeConstraints(String id) Removes the relative positioning constraints for the specified flow mod class.
void	setConstraints(String id, long baseCookie, FlowClassConstraints.Type type, Set<String> lowerIds, Set<String> higherIds) Sets the relative positioning constraints for the flow mod class identified by its globally unique id.
void	setConstraints(String id, long baseCookie, int actualPriority) Sets the absolute priority constraint for the flow mod class identified by its globally unique id.
void	setEnforcementLevel(FlowClassAdministrator.EnforcementLevel level) Sets the enforcement level.
void	setPlaceholder(String id, long baseCookie, int actualPriority) Sets the placeholder constraint for the flow mod class identified by its globally unique id.

Method Detail

enforcementLevel

FlowClassAdministrator.EnforcementLevel enforcementLevel()

Indicates the level of flow mod enforcement to indicate whether flow mod registrations are being enforced and flow mods are being inspected for compliance.

Returns:

true if controller is enforcing flow mods

setEnforcementLevel

void setEnforcementLevel(FlowClassAdministrator.EnforcementLevel level)

Sets the enforcement level.

Parameters:

level - level of registration and flow mod validation

getAllConstraints

Collection<FlowClassConstraints> getAllConstraints()

Returns all flow class constraints added via via setConstraints(java.lang.String, long, com.hp.of.ctl.prio.FlowClassConstraints.Type, java.util.Set<java.lang.String>, java.util.Set<java.lang.String>).

Returns:

collection of flow class constraints

getConstraints

FlowClassConstraints getConstraints(String id)

Returns set of constraints added via via setConstraints(java.lang.String, long, com.hp.of.ctl.prio.FlowClassConstraints.Type, java.util.Set<java.lang.String>, java.util.Set<java.lang.String>) for the specified flow class.

Parameters:

id - flow class identifier

Returns:

set of flow class identifiers; null if no constraints have been set

setConstraints

void setConstraints(String id,
                  long baseCookie,
                  FlowClassConstraints.Type type,
                  Set<String> lowerIds,
                  Set<String> higherIds)

Sets the relative positioning constraints for the flow mod class identified by its globally unique id. Callers can specify whether constraints should be merged or replaced with those supplied during registration. Subsequent invocations simply replace any prior overrides.

Parameters:

id - flow class identifier

baseCookie - assigned cookie; -1 if cookie is not to be overriden

type - indicates whether constraints should be merged or replaced

lowerIds - optional set of flow class ids whose actual priorities should be below this one

higherIds - optional set of flow class ids whose actual priorities should be above this one

setConstraints

void setConstraints(String id,
                  long baseCookie,
                  int actualPriority)

Sets the absolute priority constraint for the flow mod class identified by its globally unique id.

Parameters:

id - flow class identifier

baseCookie - assigned cookie; -1 if cookie is not to be overriden

actualPriority - actual absolute priority value to assign

removeConstraints

void removeConstraints(String id)

Removes the relative positioning constraints for the specified flow mod class.

Parameters:

id - flow class identifier

registerPlaceholder

FlowClass registerPlaceholder(String id,
                            Set<String> lowerIds,
                            Set<String> higherIds)

Registers a placeholder flow class using the supplied positional hints. This is used in context of distributed flow class registration.

Parameters:

id - flow class identifier

lowerIds - optional set of flow class ids whose actual priorities should be below this one

higherIds - optional set of flow class ids whose actual priorities should be above this one

Returns:

placeholder flow class

setPlaceholder

void setPlaceholder(String id,
                  long baseCookie,
                  int actualPriority)

Sets the placeholder constraint for the flow mod class identified by its globally unique id.

Parameters:

id - flow class identifier

baseCookie - assigned cookie; -1 if cookie is not to be overriden

actualPriority - actual absolute priority value to assign

getPlaceholder

FlowClass getPlaceholder(String id)

Gets the temporary placeholder flow class, if one exists, for the specified flow class id.

Parameters:

id - flow class identifier

Returns:

placeholder flow class