renderers/ofoverlay/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ofoverlay/sf/Action.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.groupbasedpolicy.renderer.ofoverlay.sf;
  10
  11 import java.util.List;
  12 import java.util.Map;
  13
  14 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.OfContext;
  15 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.OfWriter;
  16 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.flow.PolicyEnforcer.NetworkElements;
  17 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.flow.PolicyEnforcer.PolicyPair;
  18 import org.opendaylight.groupbasedpolicy.resolver.ActionInstanceValidator;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ActionDefinitionId;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.HasDirection.Direction;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.definitions.ActionDefinition;
  23
  24 /**
  25  * Represent an action definition, and provide tools for generating
  26  * flow instructions based on the action
  27  * @author tbachman
  28  */
  29 public abstract class Action implements ActionInstanceValidator{
  30     /**
  31      * Get the action definition for this action
  32      * @return the {@link ActionDefinition} for this action
  33      */
  34     public abstract ActionDefinitionId getId();
  35
  36     /**
  37      * Get the action definition for this action
  38      * @return the {@link ActionDefinition} for this action
  39      */
  40     public abstract ActionDefinition getActionDef();
  41
  42     /**
  43      * Construct a set of actions that will apply to the traffic.  Augment
  44      * the existing list of actions or add new actions.  It's important
  45      * that the order of the returned list be consistent however
  46      *
  47      * @param actions The existing actions
  48      * @param params the parameters for the action instance
  49      * @param order the order of the list of actions
  50      * @param netElements the network elements
  51      * @param policyPair the {@link PolicyPair}
  52      * @param ofWriter the {@link OfWriter}
  53      * @param ctx the OfContext
  54      * @param direction the direction of traffic
  55      * @return the updated list of actions (may be a different length)
  56      */
  57     public abstract List<ActionBuilder> updateAction(List<ActionBuilder> actions,
  58                                                      Map<String, Object> params,
  59                                                      Integer order,
  60                                                      NetworkElements netElements,
  61                                                      PolicyPair policyPair,
  62                                                      OfWriter ofWriter,
  63                                                      OfContext ctx,
  64                                                      Direction direction);
  65 }