2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END=========================================================
21 package org.onap.so.client.aai;
23 import java.io.Serializable;
24 import java.lang.reflect.Field;
26 import java.util.HashMap;
29 import java.util.regex.Pattern;
31 import org.onap.aai.annotations.Metadata;
32 import org.onap.aai.domain.yang.AggregateRoute;
33 import org.onap.aai.domain.yang.AllottedResource;
34 import org.onap.aai.domain.yang.CloudRegion;
35 import org.onap.aai.domain.yang.Collection;
36 import org.onap.aai.domain.yang.Complex;
37 import org.onap.aai.domain.yang.Configuration;
38 import org.onap.aai.domain.yang.Connector;
39 import org.onap.aai.domain.yang.Customer;
40 import org.onap.aai.domain.yang.Device;
41 import org.onap.aai.domain.yang.ExtAaiNetwork;
42 import org.onap.aai.domain.yang.GenericVnf;
43 import org.onap.aai.domain.yang.InstanceGroup;
44 import org.onap.aai.domain.yang.L3Network;
45 import org.onap.aai.domain.yang.LInterface;
46 import org.onap.aai.domain.yang.LineOfBusiness;
47 import org.onap.aai.domain.yang.ModelVer;
48 import org.onap.aai.domain.yang.NetworkPolicy;
49 import org.onap.aai.domain.yang.NetworkTechnology;
50 import org.onap.aai.domain.yang.OperationalEnvironment;
51 import org.onap.aai.domain.yang.OwningEntity;
52 import org.onap.aai.domain.yang.PInterface;
53 import org.onap.aai.domain.yang.PhysicalLink;
54 import org.onap.aai.domain.yang.Platform;
55 import org.onap.aai.domain.yang.Pnf;
56 import org.onap.aai.domain.yang.PortGroup;
57 import org.onap.aai.domain.yang.Project;
58 import org.onap.aai.domain.yang.Pserver;
59 import org.onap.aai.domain.yang.RouteTableReference;
60 import org.onap.aai.domain.yang.ServiceInstance;
61 import org.onap.aai.domain.yang.ServiceSubscription;
62 import org.onap.aai.domain.yang.SpPartner;
63 import org.onap.aai.domain.yang.SriovPf;
64 import org.onap.aai.domain.yang.Subnet;
65 import org.onap.aai.domain.yang.Tenant;
66 import org.onap.aai.domain.yang.TunnelXconnect;
67 import org.onap.aai.domain.yang.Vce;
68 import org.onap.aai.domain.yang.VfModule;
69 import org.onap.aai.domain.yang.VlanTag;
70 import org.onap.aai.domain.yang.Vnfc;
71 import org.onap.aai.domain.yang.VolumeGroup;
72 import org.onap.aai.domain.yang.VpnBinding;
73 import org.onap.aai.domain.yang.Vserver;
74 import org.onap.so.client.graphinventory.GraphInventoryObjectType;
75 import org.onap.so.constants.Defaults;
76 import org.reflections.Reflections;
77 import org.reflections.scanners.SubTypesScanner;
78 import org.reflections.util.ClasspathHelper;
79 import org.reflections.util.ConfigurationBuilder;
81 import com.google.common.base.CaseFormat;
83 public class AAIObjectType implements GraphInventoryObjectType, Serializable {
85 private static final long serialVersionUID = -2877184776691514600L;
86 private static Map<String, AAIObjectType> map = new HashMap<>();
88 public static final AAIObjectType DEFAULT_CLOUD_REGION = new AAIObjectType(AAINamespaceConstants.CLOUD_INFRASTRUCTURE, "/cloud-regions/cloud-region/" + Defaults.CLOUD_OWNER + "/{cloud-region-id}", "default-cloud-region");
89 public static final AAIObjectType CUSTOMER = new AAIObjectType(AAINamespaceConstants.BUSINESS, Customer.class);
90 public static final AAIObjectType GENERIC_QUERY = new AAIObjectType("/search", "/generic-query", "generic-query");
91 public static final AAIObjectType BULK_PROCESS = new AAIObjectType("/bulkprocess", "", "bulkprocess");
92 public static final AAIObjectType SINGLE_TRANSACTION = new AAIObjectType("/bulk/single-transaction", "", "single-transaction");
93 public static final AAIObjectType GENERIC_VNF = new AAIObjectType(AAINamespaceConstants.NETWORK, GenericVnf.class);
94 public static final AAIObjectType VF_MODULE = new AAIObjectType(AAIObjectType.GENERIC_VNF.uriTemplate(), VfModule.class);
95 public static final AAIObjectType L3_NETWORK = new AAIObjectType(AAINamespaceConstants.NETWORK, L3Network.class);
96 public static final AAIObjectType NETWORK_POLICY = new AAIObjectType(AAINamespaceConstants.NETWORK, NetworkPolicy.class);
97 public static final AAIObjectType NODES_QUERY = new AAIObjectType("/search", "/nodes-query", "nodes-query");
98 public static final AAIObjectType CUSTOM_QUERY = new AAIObjectType("/query", "", "query");
99 public static final AAIObjectType ROUTE_TABLE_REFERENCE = new AAIObjectType(AAINamespaceConstants.NETWORK, RouteTableReference.class);
100 public static final AAIObjectType DEFAULT_TENANT = new AAIObjectType(AAINamespaceConstants.CLOUD_INFRASTRUCTURE + "/cloud-regions/cloud-region/" + Defaults.CLOUD_OWNER + "/AAIAIC25", "/tenants/tenant/{tenant-id}", "default-tenant");
101 public static final AAIObjectType VCE = new AAIObjectType(AAINamespaceConstants.NETWORK, Vce.class);
102 public static final AAIObjectType PORT_GROUP = new AAIObjectType(AAIObjectType.VCE.uriTemplate(), PortGroup.class);
103 public static final AAIObjectType VPN_BINDING = new AAIObjectType(AAINamespaceConstants.NETWORK, VpnBinding.class);
104 public static final AAIObjectType CONFIGURATION = new AAIObjectType(AAINamespaceConstants.NETWORK, Configuration.class);
105 public static final AAIObjectType PSERVER = new AAIObjectType(AAINamespaceConstants.CLOUD_INFRASTRUCTURE, Pserver.class);
106 public static final AAIObjectType SERVICE_SUBSCRIPTION = new AAIObjectType(AAIObjectType.CUSTOMER.uriTemplate(), ServiceSubscription.class);
107 public static final AAIObjectType SERVICE_INSTANCE = new AAIObjectType(AAIObjectType.SERVICE_SUBSCRIPTION.uriTemplate(), ServiceInstance.class);
108 public static final AAIObjectType PROJECT = new AAIObjectType(AAINamespaceConstants.BUSINESS, Project.class);
109 public static final AAIObjectType LINE_OF_BUSINESS = new AAIObjectType(AAINamespaceConstants.BUSINESS, LineOfBusiness.class);
110 public static final AAIObjectType PLATFORM = new AAIObjectType(AAINamespaceConstants.BUSINESS, Platform.class);
111 public static final AAIObjectType OWNING_ENTITY = new AAIObjectType(AAINamespaceConstants.BUSINESS, OwningEntity.class);
112 public static final AAIObjectType ALLOTTED_RESOURCE = new AAIObjectType(AAIObjectType.SERVICE_INSTANCE.uriTemplate(), AllottedResource.class);
113 public static final AAIObjectType PNF = new AAIObjectType(AAINamespaceConstants.NETWORK, Pnf.class);
114 public static final AAIObjectType OPERATIONAL_ENVIRONMENT = new AAIObjectType(AAINamespaceConstants.CLOUD_INFRASTRUCTURE, OperationalEnvironment.class);
115 public static final AAIObjectType CLOUD_REGION = new AAIObjectType(AAINamespaceConstants.CLOUD_INFRASTRUCTURE, CloudRegion.class);
116 public static final AAIObjectType TENANT = new AAIObjectType(AAIObjectType.CLOUD_REGION.uriTemplate(), Tenant.class);
117 public static final AAIObjectType VOLUME_GROUP = new AAIObjectType(AAIObjectType.CLOUD_REGION.uriTemplate(), VolumeGroup.class);
118 public static final AAIObjectType VSERVER = new AAIObjectType(AAIObjectType.TENANT.uriTemplate(), Vserver.class);
119 public static final AAIObjectType MODEL_VER = new AAIObjectType(AAINamespaceConstants.SERVICE_DESIGN_AND_CREATION + "/models/model/{model-invariant-id}", ModelVer.class);
120 public static final AAIObjectType TUNNEL_XCONNECT = new AAIObjectType(AAIObjectType.ALLOTTED_RESOURCE.uriTemplate(), TunnelXconnect.class);
121 public static final AAIObjectType P_INTERFACE = new AAIObjectType(AAIObjectType.PSERVER.uriTemplate(), PInterface.class);
122 public static final AAIObjectType SRIOV_PF = new AAIObjectType(AAIObjectType.P_INTERFACE.uriTemplate(), SriovPf.class);
123 public static final AAIObjectType PHYSICAL_LINK = new AAIObjectType(AAINamespaceConstants.NETWORK, PhysicalLink.class);
124 public static final AAIObjectType INSTANCE_GROUP = new AAIObjectType(AAINamespaceConstants.NETWORK, InstanceGroup.class);
125 public static final AAIObjectType COLLECTION = new AAIObjectType(AAINamespaceConstants.NETWORK, Collection.class);
126 public static final AAIObjectType VNFC = new AAIObjectType(AAINamespaceConstants.NETWORK, Vnfc.class);
127 public static final AAIObjectType VLAN_TAG = new AAIObjectType(AAINamespaceConstants.NETWORK, VlanTag.class);
128 public static final AAIObjectType COMPLEX = new AAIObjectType(AAINamespaceConstants.CLOUD_INFRASTRUCTURE, Complex.class);
129 public static final AAIObjectType CONNECTOR = new AAIObjectType(AAINamespaceConstants.BUSINESS, Connector.class);
130 public static final AAIObjectType NETWORK_TECHNOLOGY = new AAIObjectType(AAINamespaceConstants.CLOUD_INFRASTRUCTURE, NetworkTechnology.class);
131 public static final AAIObjectType SUBNET = new AAIObjectType(AAIObjectType.L3_NETWORK.uriTemplate(), Subnet.class);
132 public static final AAIObjectType SP_PARTNER = new AAIObjectType(AAINamespaceConstants.BUSINESS, SpPartner.class);
133 public static final AAIObjectType DEVICE = new AAIObjectType(AAINamespaceConstants.NETWORK, Device.class);
134 public static final AAIObjectType EXT_AAI_NETWORK = new AAIObjectType(AAINamespaceConstants.NETWORK, ExtAaiNetwork.class);
135 public static final AAIObjectType AGGREGATE_ROUTE = new AAIObjectType(AAINamespaceConstants.NETWORK, AggregateRoute.class);
136 public static final AAIObjectType L_INTERFACE = new AAIObjectType(AAIObjectType.VSERVER.uriTemplate(), LInterface.class);
137 public static final AAIObjectType UNKNOWN = new AAIObjectType("", "", "unknown");
138 public static final AAIObjectType DSL = new AAIObjectType("/dsl", "", "dsl");
140 private final String uriTemplate;
141 private final String parentUri;
142 private final String partialUri;
143 private final Class<?> aaiObjectClass;
144 private final String name;
147 /* Locate any AAIObjectTypes on the classpath and add them to our map */
148 java.util.Collection<URL> packages = ClasspathHelper.forPackage("");
149 Reflections r = new Reflections(new ConfigurationBuilder().setUrls(packages).setScanners(new SubTypesScanner()));
151 Set<Class<? extends AAIObjectType>> resources =
152 r.getSubTypesOf(AAIObjectType.class);
154 for (Class<? extends AAIObjectType> customTypeClass : resources) {
155 AAIObjectType customType;
156 customType = customTypeClass.newInstance();
158 } catch (InstantiationException | IllegalAccessException e) {
161 protected AAIObjectType() {
162 this.parentUri = null;
163 this.partialUri = null;
164 this.uriTemplate = null;
165 this.aaiObjectClass = null;
168 protected AAIObjectType(String parentUri, String partialUri, String name) {
169 this.parentUri = parentUri;
170 this.partialUri = partialUri;
171 this.uriTemplate = parentUri + partialUri;
172 this.aaiObjectClass = null;
174 if (!AAIObjectType.map.containsKey(name)) {
175 AAIObjectType.map.put(name, this);
179 protected AAIObjectType(String parentUri, Class<?> aaiObjectClass) {
180 this.parentUri = parentUri;
181 this.partialUri = removeParentUri(aaiObjectClass, parentUri);
182 this.uriTemplate = parentUri + partialUri;
183 this.aaiObjectClass = aaiObjectClass;
184 this.name = CaseFormat.UPPER_CAMEL.to(CaseFormat.LOWER_HYPHEN, aaiObjectClass.getSimpleName());
185 if (!AAIObjectType.map.containsKey(name)) {
186 AAIObjectType.map.put(name, this);
191 public String toString() {
192 return this.uriTemplate();
195 public static AAIObjectType fromTypeName(String name) {
196 if (map.containsKey(name)) {
197 return map.get(name);
199 return AAIObjectType.UNKNOWN;
203 public String typeName() {
204 return this.typeName(CaseFormat.LOWER_HYPHEN);
207 public String typeName(CaseFormat format) {
208 return CaseFormat.LOWER_HYPHEN.to(format, this.name.replace("default-", ""));
212 public String uriTemplate() {
213 return this.uriTemplate;
217 public String partialUri() {
218 return this.partialUri;
221 protected String removeParentUri(Class<?> aaiObjectClass, String parentUri) {
222 return aaiObjectClass.getAnnotation(Metadata.class).uriTemplate().replaceFirst(Pattern.quote(parentUri), "");