2 * Copyright (c) 2013 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.controller.config.yangjmxgenerator.plugin.gofactory;
11 import static java.lang.String.format;
13 import com.google.common.base.Optional;
14 import java.util.ArrayList;
15 import java.util.List;
16 import org.opendaylight.controller.config.api.DependencyResolver;
17 import org.opendaylight.controller.config.api.DynamicMBeanWithInstance;
18 import org.opendaylight.controller.config.api.ModuleIdentifier;
19 import org.opendaylight.controller.config.api.annotations.AbstractServiceInterface;
20 import org.opendaylight.controller.config.api.annotations.Description;
21 import org.opendaylight.controller.config.spi.Module;
22 import org.opendaylight.controller.config.spi.ModuleFactory;
23 import org.opendaylight.controller.config.yangjmxgenerator.ModuleMXBeanEntry;
24 import org.opendaylight.controller.config.yangjmxgenerator.plugin.ftl.AbstractFactoryTemplate;
25 import org.opendaylight.controller.config.yangjmxgenerator.plugin.ftl.TemplateFactory;
26 import org.opendaylight.controller.config.yangjmxgenerator.plugin.ftl.model.Annotation;
27 import org.opendaylight.controller.config.yangjmxgenerator.plugin.ftl.model.Field;
28 import org.opendaylight.controller.config.yangjmxgenerator.plugin.java.FullyQualifiedName;
29 import org.opendaylight.controller.config.yangjmxgenerator.plugin.java.GeneratedObject;
30 import org.opendaylight.controller.config.yangjmxgenerator.plugin.java.GeneratedObjectBuilder;
31 import org.opendaylight.controller.config.yangjmxgenerator.plugin.java.JavaFileInputBuilder;
32 import org.opendaylight.controller.config.yangjmxgenerator.plugin.java.TypeName;
33 import org.opendaylight.yangtools.yang.common.QName;
35 public class AbsFactoryGeneratedObjectFactory {
36 private static final String BUNDLE_CONTEXT = "org.osgi.framework.BundleContext";
38 public GeneratedObject toGeneratedObject(ModuleMXBeanEntry mbe, Optional<String> copyright) {
39 FullyQualifiedName absFactoryFQN = new FullyQualifiedName(mbe.getPackageName(), mbe.getAbstractFactoryName());
40 FullyQualifiedName moduleFQN = new FullyQualifiedName(mbe.getPackageName(), mbe.getStubModuleName());
41 Optional<String> classJavaDoc = Optional.fromNullable(mbe.getNullableDescription());
43 AbstractFactoryTemplate abstractFactoryTemplate = TemplateFactory.abstractFactoryTemplateFromMbe(mbe);
44 Optional<String> header = abstractFactoryTemplate.getHeaderString();
46 List<FullyQualifiedName> providedServices = new ArrayList<>();
47 for(String providedService: mbe.getProvidedServices().keySet()) {
48 providedServices.add(FullyQualifiedName.fromString(providedService));
51 return toGeneratedObject(absFactoryFQN, copyright,
52 header, classJavaDoc, mbe.getYangModuleQName(),
53 mbe.getGloballyUniqueName(),
56 abstractFactoryTemplate.getFields());
59 public GeneratedObject toGeneratedObject(FullyQualifiedName absFactoryFQN, Optional<String> copyright,
60 Optional<String> header, Optional<String> classJavaDoc, QName yangModuleQName,
61 String globallyUniqueName,
62 List<FullyQualifiedName> providedServices,
63 FullyQualifiedName moduleFQN,
64 List<Field> moduleFields) {
65 JavaFileInputBuilder b = new JavaFileInputBuilder();
66 Annotation moduleQNameAnnotation = Annotation.createModuleQNameANnotation(yangModuleQName);
67 b.addClassAnnotation(moduleQNameAnnotation);
69 b.setFqn(absFactoryFQN);
70 b.setTypeName(TypeName.absClassType);
72 b.setCopyright(copyright);
74 b.setClassJavaDoc(classJavaDoc);
75 b.addImplementsFQN(new FullyQualifiedName(ModuleFactory.class));
76 if (classJavaDoc.isPresent()) {
77 b.addClassAnnotation(format("@%s(value=\"%s\")", Description.class.getCanonicalName(), classJavaDoc.get()));
80 b.addToBody(format("public static final java.lang.String NAME = \"%s\";", globallyUniqueName));
81 b.addToBody(format("private static final java.util.Set<Class<? extends %s>> serviceIfcs;",
82 AbstractServiceInterface.class.getCanonicalName()));
84 b.addToBody("@Override\n public final String getImplementationName() { \n return NAME; \n}");
86 b.addToBody(getServiceIfcsInitialization(providedServices));
89 b.addToBody(format("\n"+
91 "public %s createModule(String instanceName, %s dependencyResolver, %s bundleContext) {\n"+
92 "return instantiateModule(instanceName, dependencyResolver, bundleContext);\n"+
94 Module.class.getCanonicalName(), DependencyResolver.class.getCanonicalName(), BUNDLE_CONTEXT));
96 b.addToBody(getCreateModule(moduleFQN, moduleFields));
98 b.addToBody(format("\n"+
99 "public %s instantiateModule(String instanceName, %s dependencyResolver, %s oldModule, %s oldInstance, %s bundleContext) {\n"+
100 "return new %s(new %s(NAME, instanceName), dependencyResolver, oldModule, oldInstance);\n"+
102 moduleFQN, DependencyResolver.class.getCanonicalName(), moduleFQN, AutoCloseable.class.getCanonicalName(),
103 BUNDLE_CONTEXT, moduleFQN, ModuleIdentifier.class.getCanonicalName()));
105 b.addToBody(format("\n"+
106 "public %s instantiateModule(String instanceName, %s dependencyResolver, %s bundleContext) {\n"+
107 "return new %s(new %s(NAME, instanceName), dependencyResolver);\n"+
108 "}\n", moduleFQN, DependencyResolver.class.getCanonicalName(), BUNDLE_CONTEXT,
109 moduleFQN, ModuleIdentifier.class.getCanonicalName()
112 b.addToBody(format("\n"+
113 "public %s handleChangedClass(%s old) throws Exception {\n"+
114 "throw new UnsupportedOperationException(\"Class reloading is not supported\");\n"+
115 "}\n", moduleFQN, DynamicMBeanWithInstance.class.getCanonicalName()));
117 // TODO The generic specifier in HashSet<> isn't necessary, but the Eclipse AST parser used in the unit tests doesn't support this
118 b.addToBody(format("\n"+
120 "public java.util.Set<%s> getDefaultModules(org.opendaylight.controller.config.api.DependencyResolverFactory dependencyResolverFactory, %s bundleContext) {\n"+
121 "return new java.util.HashSet<%1$s>();\n"+
122 "}\n", moduleFQN, BUNDLE_CONTEXT));
124 return new GeneratedObjectBuilder(b.build()).toGeneratedObject();
127 private static String getCreateModule(FullyQualifiedName moduleFQN, List<Field> moduleFields) {
128 String result = "\n"+
130 format("public %s createModule(String instanceName, %s dependencyResolver, %s old, %s bundleContext) throws Exception {\n",
131 Module.class.getCanonicalName(), DependencyResolver.class.getCanonicalName(),
132 DynamicMBeanWithInstance.class.getCanonicalName(), BUNDLE_CONTEXT)+
133 format("%s oldModule;\n",moduleFQN)+
135 format("oldModule = (%s) old.getModule();\n",moduleFQN)+
136 "} catch(Exception e) {\n"+
137 "return handleChangedClass(old);\n"+
139 format("%s module = instantiateModule(instanceName, dependencyResolver, oldModule, old.getInstance(), bundleContext);\n", moduleFQN);
141 for(Field field: moduleFields) {
142 result += format("module.set%s(oldModule.get%1$s());\n", field.getName());
151 private static String getServiceIfcsInitialization(List<FullyQualifiedName> providedServices) {
152 String generic = format("Class<? extends %s>", AbstractServiceInterface.class.getCanonicalName());
154 String result = "static {\n";
155 if (!providedServices.isEmpty()) {
156 // TODO The generic specifier in HashSet<> isn't necessary, but the Eclipse AST parser used in the unit tests doesn't support this
157 result += format("java.util.Set<%1$s> serviceIfcs2 = new java.util.HashSet<%1$s>();\n", generic);
159 for(FullyQualifiedName fqn: providedServices) {
160 result += format("serviceIfcs2.add(%s.class);\n", fqn);
163 result += "serviceIfcs = java.util.Collections.unmodifiableSet(serviceIfcs2);\n";
165 result += "serviceIfcs = java.util.Collections.emptySet();\n";
169 // add isModuleImplementingServiceInterface and getImplementedServiceIntefaces methods
171 result += format("\n"+
173 "public final boolean isModuleImplementingServiceInterface(Class<? extends %1$s> serviceInterface) {\n"+
174 "for (Class<?> ifc: serviceIfcs) {\n"+
175 "if (serviceInterface.isAssignableFrom(ifc)){\n"+
183 "public java.util.Set<Class<? extends %1$s>> getImplementedServiceIntefaces() {\n"+
184 "return serviceIfcs;\n"+
185 "}\n", AbstractServiceInterface.class.getCanonicalName());