refactor: use annotations instead of XML for metatype

OpenLiberty · Oct 30, 2024 · cc5aace · cc5aace
1 parent 4b85680
commit cc5aace
Show file tree

Hide file tree

Showing 6 changed files with 45 additions and 8 deletions.
diff --git a/...m.ws.app.manager.lifecycle/src/com/ibm/wsspi/application/lifecycle/ApplicationPrereq.java b/...m.ws.app.manager.lifecycle/src/com/ibm/wsspi/application/lifecycle/ApplicationPrereq.java
@@ -126,5 +126,4 @@
  *   </li>
  * </ol>
  */
-public interface ApplicationPrereq {
-}
+public interface ApplicationPrereq {}
diff --git a/dev/com.ibm.ws.jndi.iiop/bnd.bnd b/dev/com.ibm.ws.jndi.iiop/bnd.bnd
@@ -37,6 +37,7 @@ Include-Resource: OSGI-INF=resources/OSGI-INF
 IBM-Default-Config: OSGI-INF/wlp/defaultInstances.xml
 
 -dsannotations: com.ibm.ws.jndi.iiop.*UrlContextFactory
+-metatypeannotations: com.ibm.ws.jndi.iiop.*UrlContextFactory*
 
 instrument.classesExcludes: com/ibm/ws/jndi/iiop/*.class
 
@@ -51,6 +52,8 @@ instrument.classesExcludes: com/ibm/ws/jndi/iiop/*.class
   com.ibm.ws.org.apache.yoko.rmi.spec.1.5;version=latest,\
   com.ibm.websphere.org.osgi.core;version=latest,\
   com.ibm.wsspi.org.osgi.service.component.annotations;version=latest,\
+  com.ibm.wsspi.org.osgi.service.metatype.annotations;version=latest, \
+  com.ibm.ws.bnd.annotations;version=latest, \
   com.ibm.websphere.appserver.spi.logging;version=latest,\
   com.ibm.ws.app.manager.lifecycle;version=latest,\
   com.ibm.ws.container.service;version=latest,\

diff --git a/.../resources/OSGI-INF/metatype/metatype.xml → dev/com.ibm.ws.jndi.iiop/metatype.xml b/.../resources/OSGI-INF/metatype/metatype.xml → dev/com.ibm.ws.jndi.iiop/metatype.xml
@@ -13,8 +13,7 @@
  -->
 <metatype:MetaData xmlns:metatype="http://www.osgi.org/xmlns/metatype/v1.1.0"
                    xmlns:ibm="http://www.ibm.com/xmlns/appservers/osgi/metatype/v1.0.0"
-                   xmlns:ibmui="http://www.ibm.com/xmlns/appservers/osgi/metatype/ui/v1.0.0"
-                   localization="OSGI-INF/l10n/metatype">
+                   xmlns:ibmui="http://www.ibm.com/xmlns/appservers/osgi/metatype/ui/v1.0.0">
 
   <Designate pid="com.ibm.ws.jndi.iiop.CorbanameUrlContextFactory">
     <Object ocdref="com.ibm.ws.jndi.iiop.CorbanameUrlContextFactory" />

diff --git a/dev/com.ibm.ws.jndi.iiop/src/com/ibm/ws/jndi/iiop/CorbalocUrlContextFactory.java b/dev/com.ibm.ws.jndi.iiop/src/com/ibm/ws/jndi/iiop/CorbalocUrlContextFactory.java
@@ -19,13 +19,25 @@
 import org.osgi.service.component.annotations.Activate;
 import org.osgi.service.component.annotations.Component;
 import org.osgi.service.component.annotations.Reference;
+import org.osgi.service.metatype.annotations.AttributeDefinition;
+import org.osgi.service.metatype.annotations.Designate;
+import org.osgi.service.metatype.annotations.ObjectClassDefinition;
 
+import com.ibm.ws.bnd.metatype.annotation.Ext;
 import com.ibm.ws.transport.iiop.spi.ClientORBRef;
 import com.ibm.wsspi.application.lifecycle.ApplicationPrereq;
 import com.ibm.wsspi.application.lifecycle.ApplicationRecycleComponent;
 
-@Component(configurationPolicy=REQUIRE,property={"service.vendor=ibm","osgi.jndi.url.scheme=corbaloc"})
-public class CorbalocUrlContextFactory extends UrlContextFactory  implements ObjectFactory, ApplicationRecycleComponent, ApplicationPrereq {
+@ObjectClassDefinition(name = "internal", description = "internal use only")
+@Ext.ObjectClass(ApplicationPrereq.OBJECT_CLASS)
+@interface CorbalocUrlContextFactoryConfig {
+    @AttributeDefinition(name = "internal", description = "internal use only")
+    String id();
+}
+
+@Component(configurationPolicy = REQUIRE, property = "osgi.jndi.url.scheme=corbaloc")
+@Designate(ocd = CorbalocUrlContextFactoryConfig.class)
+public class CorbalocUrlContextFactory extends UrlContextFactory implements ObjectFactory, ApplicationRecycleComponent, ApplicationPrereq {
     @Activate
     public CorbalocUrlContextFactory(@Reference ClientORBRef orbRef) {
         super(orbRef);

diff --git a/dev/com.ibm.ws.jndi.iiop/src/com/ibm/ws/jndi/iiop/CorbanameUrlContextFactory.java b/dev/com.ibm.ws.jndi.iiop/src/com/ibm/ws/jndi/iiop/CorbanameUrlContextFactory.java
@@ -19,12 +19,24 @@
 import org.osgi.service.component.annotations.Activate;
 import org.osgi.service.component.annotations.Component;
 import org.osgi.service.component.annotations.Reference;
+import org.osgi.service.metatype.annotations.AttributeDefinition;
+import org.osgi.service.metatype.annotations.Designate;
+import org.osgi.service.metatype.annotations.ObjectClassDefinition;
 
+import com.ibm.ws.bnd.metatype.annotation.Ext;
 import com.ibm.ws.transport.iiop.spi.ClientORBRef;
 import com.ibm.wsspi.application.lifecycle.ApplicationPrereq;
 import com.ibm.wsspi.application.lifecycle.ApplicationRecycleComponent;
 
-@Component(configurationPolicy=REQUIRE,property={"service.vendor=ibm","osgi.jndi.url.scheme=corbaname"})
+@ObjectClassDefinition(name = "internal", description = "internal use only")
+@Ext.ObjectClassClass(ApplicationPrereq.class)
+@interface CorbanameUrlContextFactoryConfig {
+    @AttributeDefinition(name = "internal", description = "internal use only")
+    String id();
+}
+
+@Component(configurationPolicy = REQUIRE, property = "osgi.jndi.url.scheme=corbaname")
+@Designate(ocd = CorbanameUrlContextFactoryConfig.class)
 public class CorbanameUrlContextFactory extends UrlContextFactory implements ObjectFactory, ApplicationRecycleComponent, ApplicationPrereq {
     @Activate
     public CorbanameUrlContextFactory(@Reference ClientORBRef orbRef) {

diff --git a/dev/com.ibm.ws.jndi.iiop/src/com/ibm/ws/jndi/iiop/IorUrlContextFactory.java b/dev/com.ibm.ws.jndi.iiop/src/com/ibm/ws/jndi/iiop/IorUrlContextFactory.java
@@ -19,12 +19,24 @@
 import org.osgi.service.component.annotations.Activate;
 import org.osgi.service.component.annotations.Component;
 import org.osgi.service.component.annotations.Reference;
+import org.osgi.service.metatype.annotations.AttributeDefinition;
+import org.osgi.service.metatype.annotations.Designate;
+import org.osgi.service.metatype.annotations.ObjectClassDefinition;
 
+import com.ibm.ws.bnd.metatype.annotation.Ext;
 import com.ibm.ws.transport.iiop.spi.ClientORBRef;
 import com.ibm.wsspi.application.lifecycle.ApplicationPrereq;
 import com.ibm.wsspi.application.lifecycle.ApplicationRecycleComponent;
 
-@Component(configurationPolicy=REQUIRE,property={"service.vendor=ibm","osgi.jndi.url.scheme=ior"})
+@ObjectClassDefinition(name = "internal", description = "internal use only")
+@Ext.ObjectClassClass(ApplicationPrereq.class)
+@interface IorUrlContextFactoryConfig {
+    @AttributeDefinition(name = "internal", description = "internal use only", required = true)
+    String id();
+}
+
+@Component(configurationPolicy = REQUIRE, property = "osgi.jndi.url.scheme=ior")
+@Designate(ocd = IorUrlContextFactoryConfig.class)
 public class IorUrlContextFactory extends UrlContextFactory implements ObjectFactory, ApplicationRecycleComponent, ApplicationPrereq {
     @Activate
     public IorUrlContextFactory(@Reference ClientORBRef orbRef) {