org.onosproject.net.flowobjective

Interface FilteringObjective

All Superinterfaces:

Objective

All Known Implementing Classes:

DefaultFilteringObjective

@Beta
public interface FilteringObjective
extends Objective

Represents a filtering flow objective. Each filter is mapping from a criterion to a collection of criteria. The mapping will be used by a device driver to construct the actual flow rules to be installed on the device.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FilteringObjective.Builder Builder of Filtering objective entities.
static class	FilteringObjective.Type

Nested classes/interfaces inherited from interface org.onosproject.net.flowobjective.Objective

Objective.Operation

Field Summary

Fields inherited from interface org.onosproject.net.flowobjective.Objective

DEFAULT_PERMANENT, DEFAULT_PRIORITY, DEFAULT_TIMEOUT

Method Summary

Modifier and Type	Method and Description
Collection<Criterion>	conditions() The set of conditions the filter must provision at the device.
Criterion	key() Obtain the key for this filter.
FilteringObjective.Type	type() Obtain this filtering type.

Methods inherited from interface org.onosproject.net.flowobjective.Objective

appId, context, id, op, permanent, priority, timeout

Method Detail

key

Criterion key()

Obtain the key for this filter.

Returns:

a criterion

type

FilteringObjective.Type type()

Obtain this filtering type.

Returns:

the type

conditions

Collection<Criterion> conditions()

The set of conditions the filter must provision at the device.

Returns:

a collection of criteria