4d3196f4b5b4684f6a405d335c3e9cd82f25e9df
[groupbasedpolicy.git] / renderers / ofoverlay / src / main / java / org / opendaylight / groupbasedpolicy / renderer / ofoverlay / sf / AllowAction.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 static org.opendaylight.groupbasedpolicy.renderer.ofoverlay.flow.FlowUtils.nxOutputRegAction;
12
13 import java.util.Collections;
14 import java.util.List;
15 import java.util.Map;
16
17 import org.opendaylight.groupbasedpolicy.sf.actions.AllowActionDefinition;
18 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.OfContext;
19 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.OfWriter;
20 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.flow.PolicyEnforcer.NetworkElements;
21 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.flow.PolicyEnforcer.PolicyPair;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ActionDefinitionId;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.HasDirection.Direction;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.definitions.ActionDefinition;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.subject.feature.instances.ActionInstance;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.capabilities.supported.action.definition.SupportedParameterValues;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.NxmNxReg7;
29
30 /**
31  * Allow action
32  */
33 public class AllowAction extends Action {
34
35     // How allow is implemented in the PolicyEnforcer table
36     private final org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action allow = nxOutputRegAction(NxmNxReg7.class);
37
38     @Override
39     public ActionDefinitionId getId() {
40         return AllowActionDefinition.ID;
41     }
42
43     @Override
44     public ActionDefinition getActionDef() {
45         return AllowActionDefinition.DEFINITION;
46     }
47
48     @Override
49     public List<ActionBuilder> updateAction(List<ActionBuilder> actions,
50                                             Map<String, Object> params,
51                                             Integer order,
52                                             NetworkElements netElements,
53                                             PolicyPair policyPair,
54                                             OfWriter ofWriter,
55                                             OfContext ctx,
56                                             Direction direction) {
57         /*
58          * Allow action doesn't use parameters
59          * TODO: check to make sure ActionBuilder w/allow isn't already present
60          */
61         ActionBuilder ab = new ActionBuilder();
62         ab.setAction(allow)
63           .setOrder(order);
64         actions.add(ab);
65         return actions;
66     }
67
68     @Override
69     public boolean isValid(ActionInstance actionInstance) {
70         return true;
71     }
72
73     @Override
74     public List<SupportedParameterValues> getSupportedParameterValues() {
75         // allow action definition has no parameter
76         return Collections.emptyList();
77     }
78 }