Package org.opendaylight.protocol.bgp.openconfig.routing.policy.spi.policy.action

Interface ActionsPolicy<T>

Type Parameters:

T - action class

All Known Subinterfaces:

ActionsAugPolicy, BgpActionAugPolicy<T>, BgpActionPolicy<T>

All Known Implementing Classes:

AsPathPrepend, ClientAttributePrependHandler, LocalAsPathPrependHandler, NonTransitiveAttributesFilterHandler, SetClusterIdPrependHandler, SetCommunityHandler, SetExtCommunityHandler, SetOriginatorIdPrependHandler

public interface ActionsPolicy<T>

Common interface for Apply action policy.

Method Summary

Modifier and Type	Method	Description
@Nullable Attributes	applyExportAction(@NonNull RouteEntryBaseAttributes routeEntryInfo, @NonNull BGPRouteEntryExportParameters exportParameters, @NonNull Attributes attributes, @NonNull T actions)	Applies action to Route Attributes container (Export Policy).
@Nullable Attributes	applyImportAction(@NonNull RouteEntryBaseAttributes routeEntryInfo, @NonNull BGPRouteEntryImportParameters routeBaseParameters, @NonNull Attributes attributes, @NonNull T actions)	Applies action to Route Attributes container (Import Policy).

Method Detail

applyImportAction

@Nullable Attributes applyImportAction(@NonNull RouteEntryBaseAttributes routeEntryInfo,
                                       @NonNull BGPRouteEntryImportParameters routeBaseParameters,
                                       @NonNull Attributes attributes,
                                       @NonNull T actions)

Applies action to Route Attributes container (Import Policy).

Parameters:

routeEntryInfo - contains route Entry Info(AS, ClusterId, OriginatorId)

routeBaseParameters - contains route basic information

attributes - attributes

actions - configured Actions

Returns:

Filtered attributes, or null if the advertisement should be ignored.

applyExportAction

@Nullable Attributes applyExportAction(@NonNull RouteEntryBaseAttributes routeEntryInfo,
                                       @NonNull BGPRouteEntryExportParameters exportParameters,
                                       @NonNull Attributes attributes,
                                       @NonNull T actions)

Applies action to Route Attributes container (Export Policy).

Parameters:

routeEntryInfo - contains route Entry Info(AS, ClusterId, OriginatorId)

exportParameters - contains route basic export information

attributes - attributes

actions - configured Actions

Returns:

Filtered attributes, or null if the advertisement should be ignored.