2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.groupbasedpolicy.util;
11 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
12 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpPrefix;
13 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.MacAddress;
14 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ActionDefinitionId;
15 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ActionName;
16 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ClassifierDefinitionId;
17 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ClassifierName;
18 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ClauseName;
19 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ContractId;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.EndpointGroupId;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.L2BridgeDomainId;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.L2FloodDomainId;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.L3ContextId;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.RuleName;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.SelectorName;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.SubjectName;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.SubnetId;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.TenantId;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.Endpoints;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoints.Endpoint;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoints.EndpointKey;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoints.EndpointL3;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoints.EndpointL3Key;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoints.EndpointL3Prefix;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoints.EndpointL3PrefixKey;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.SubjectFeatureDefinitions;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.Tenants;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.has.classifier.refs.ClassifierRef;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.has.classifier.refs.ClassifierRefKey;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.definitions.ActionDefinition;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.definitions.ActionDefinitionKey;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.definitions.ClassifierDefinition;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.definitions.ClassifierDefinitionKey;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.Tenant;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.TenantKey;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.Contract;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.ContractKey;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.EndpointGroup;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.EndpointGroupKey;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.L2BridgeDomain;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.L2BridgeDomainKey;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.L2FloodDomain;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.L2FloodDomainKey;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.L3Context;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.L3ContextKey;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.SubjectFeatureInstances;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.Subnet;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.SubnetKey;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.contract.Clause;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.contract.ClauseKey;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.contract.Subject;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.contract.SubjectKey;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.contract.subject.Rule;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.contract.subject.RuleKey;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.endpoint.group.ConsumerNamedSelector;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.endpoint.group.ConsumerNamedSelectorKey;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.endpoint.group.ProviderNamedSelector;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.endpoint.group.ProviderNamedSelectorKey;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.subject.feature.instances.ActionInstance;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.subject.feature.instances.ActionInstanceKey;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.subject.feature.instances.ClassifierInstance;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.subject.feature.instances.ClassifierInstanceKey;
73 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
75 public class IidFactory {
77 private IidFactory() {
78 throw new UnsupportedOperationException();
81 private static final InstanceIdentifier<Endpoints> ENDPOINTS_IID = InstanceIdentifier.builder(Endpoints.class).build();
83 public static InstanceIdentifier<Tenant> tenantIid(TenantId id) {
84 return InstanceIdentifier.builder(Tenants.class).child(Tenant.class, new TenantKey(id)).build();
87 public static InstanceIdentifier<EndpointGroup> endpointGroupIid(TenantId tenantId, EndpointGroupId epgId) {
88 return InstanceIdentifier.builder(Tenants.class)
89 .child(Tenant.class, new TenantKey(tenantId))
90 .child(EndpointGroup.class, new EndpointGroupKey(epgId))
94 public static InstanceIdentifier<Contract> contractIid(TenantId tenantId, ContractId contractId) {
95 return InstanceIdentifier.builder(Tenants.class)
96 .child(Tenant.class, new TenantKey(tenantId))
97 .child(Contract.class, new ContractKey(contractId))
101 public static InstanceIdentifier<Subject> subjectIid(TenantId tenantId, ContractId contractId,
102 SubjectName subjectName) {
103 return InstanceIdentifier.builder(Tenants.class)
104 .child(Tenant.class, new TenantKey(tenantId))
105 .child(Contract.class, new ContractKey(contractId))
106 .child(Subject.class, new SubjectKey(subjectName))
110 public static InstanceIdentifier<ProviderNamedSelector> providerNamedSelectorIid(TenantId tenantId,
111 EndpointGroupId epgId, SelectorName providerSelectorName) {
112 return InstanceIdentifier.builder(Tenants.class)
113 .child(Tenant.class, new TenantKey(tenantId))
114 .child(EndpointGroup.class, new EndpointGroupKey(epgId))
115 .child(ProviderNamedSelector.class, new ProviderNamedSelectorKey(providerSelectorName))
119 public static InstanceIdentifier<ConsumerNamedSelector> consumerNamedSelectorIid(TenantId tenantId,
120 EndpointGroupId epgId, SelectorName consumerSelectorName) {
121 return InstanceIdentifier.builder(Tenants.class)
122 .child(Tenant.class, new TenantKey(tenantId))
123 .child(EndpointGroup.class, new EndpointGroupKey(epgId))
124 .child(ConsumerNamedSelector.class, new ConsumerNamedSelectorKey(consumerSelectorName))
128 public static InstanceIdentifier<Clause> clauseIid(TenantId tenantId, ContractId contractId, ClauseName clauseName) {
129 return InstanceIdentifier.builder(Tenants.class)
130 .child(Tenant.class, new TenantKey(tenantId))
131 .child(Contract.class, new ContractKey(contractId))
132 .child(Clause.class, new ClauseKey(clauseName))
136 public static InstanceIdentifier<Rule> ruleIid(TenantId tenantId, ContractId contractId, SubjectName subjectName,
138 return InstanceIdentifier.builder(Tenants.class)
139 .child(Tenant.class, new TenantKey(tenantId))
140 .child(Contract.class, new ContractKey(contractId))
141 .child(Subject.class, new SubjectKey(subjectName))
142 .child(Rule.class, new RuleKey(ruleName))
146 public static InstanceIdentifier<ActionInstance> actionInstanceIid(TenantId tenantId, ActionName actionName) {
147 return InstanceIdentifier.builder(Tenants.class)
148 .child(Tenant.class, new TenantKey(tenantId))
149 .child(SubjectFeatureInstances.class)
150 .child(ActionInstance.class, new ActionInstanceKey(actionName))
154 public static InstanceIdentifier<ClassifierInstance> classifierInstanceIid(TenantId tenantId,
155 ClassifierName classifierName) {
156 return InstanceIdentifier.builder(Tenants.class)
157 .child(Tenant.class, new TenantKey(tenantId))
158 .child(SubjectFeatureInstances.class)
159 .child(ClassifierInstance.class, new ClassifierInstanceKey(classifierName))
163 public static InstanceIdentifier<ClassifierDefinition> classifierDefinitionIid(
164 ClassifierDefinitionId classifierDefinitionId) {
165 return InstanceIdentifier.builder(SubjectFeatureDefinitions.class)
166 .child(ClassifierDefinition.class, new ClassifierDefinitionKey(classifierDefinitionId))
170 public static InstanceIdentifier<ActionDefinition> actionDefinitionIid(ActionDefinitionId actionDefinitionId) {
171 return InstanceIdentifier.builder(SubjectFeatureDefinitions.class)
172 .child(ActionDefinition.class, new ActionDefinitionKey(actionDefinitionId))
176 public static InstanceIdentifier<ClassifierRef> classifierRefIid(TenantId tenantId, ContractId contractId,
177 SubjectName subjectName, RuleName ruleName, ClassifierName classifierRefName) {
178 return InstanceIdentifier.builder(Tenants.class)
179 .child(Tenant.class, new TenantKey(tenantId))
180 .child(Contract.class, new ContractKey(contractId))
181 .child(Subject.class, new SubjectKey(subjectName))
182 .child(Rule.class, new RuleKey(ruleName))
183 .child(ClassifierRef.class, new ClassifierRefKey(classifierRefName))
187 public static InstanceIdentifier<L2FloodDomain> l2FloodDomainIid(TenantId tenantId, L2FloodDomainId l2FloodDomainId) {
188 return InstanceIdentifier.builder(Tenants.class)
189 .child(Tenant.class, new TenantKey(tenantId))
190 .child(L2FloodDomain.class, new L2FloodDomainKey(l2FloodDomainId))
194 public static InstanceIdentifier<L2BridgeDomain> l2BridgeDomainIid(TenantId tenantId,
195 L2BridgeDomainId l2BridgeDomainId) {
196 return InstanceIdentifier.builder(Tenants.class)
197 .child(Tenant.class, new TenantKey(tenantId))
198 .child(L2BridgeDomain.class, new L2BridgeDomainKey(l2BridgeDomainId))
202 public static InstanceIdentifier<L3Context> l3ContextIid(TenantId tenantId, L3ContextId l3ContextId) {
203 return InstanceIdentifier.builder(Tenants.class)
204 .child(Tenant.class, new TenantKey(tenantId))
205 .child(L3Context.class, new L3ContextKey(l3ContextId))
210 * Get the {@link Endpoint} {@link InstanceIdentifier} based on the {@link EndpointKey}
211 * @param endpointKey The {@link EndpointKey} of a particular {@link Endpoint}
212 * @return The {@link InstanceIdentifier} of the {@link Endpoint}
214 public static InstanceIdentifier<Endpoint> endpointIid(EndpointKey endpointKey) {
215 return InstanceIdentifier.builder(Endpoints.class).child(Endpoint.class, endpointKey).build();
218 public static InstanceIdentifier<Endpoint> endpointIid(L2BridgeDomainId l2Context, MacAddress macAddress) {
219 return IidFactory.endpointIid(new EndpointKey(l2Context, macAddress));
222 public static InstanceIdentifier<EndpointL3> l3EndpointIid(L3ContextId l3Context, IpAddress ipAddress) {
223 return InstanceIdentifier.builder(Endpoints.class)
224 .child(EndpointL3.class, new EndpointL3Key(ipAddress, l3Context))
228 public static InstanceIdentifier<EndpointL3> l3EndpointsIidWildcard() {
229 return InstanceIdentifier.builder(Endpoints.class)
230 .child(EndpointL3.class)
234 public static InstanceIdentifier<EndpointL3Prefix> endpointL3PrefixIid(L3ContextId l3Context, IpPrefix ipPrefix) {
235 return InstanceIdentifier.builder(Endpoints.class)
236 .child(EndpointL3Prefix.class, new EndpointL3PrefixKey(ipPrefix, l3Context))
240 public static InstanceIdentifier<Endpoints> endpointsIidWildcard() {
241 return ENDPOINTS_IID;
244 public static InstanceIdentifier<Subnet> subnetIid(TenantId tenantId, SubnetId subnetId) {
245 return InstanceIdentifier.builder(Tenants.class)
246 .child(Tenant.class, new TenantKey(tenantId))
247 .child(Subnet.class, new SubnetKey(subnetId))