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