feat: add InstrumentationViewInitializer

Author: javier-godoy

src/main/java/com/flowingcode/vaadin/jsonmigration/InstrumentationViewInitializer.java

@@ -0,0 +1,63 @@
+/*-
+ * #%L
+ * Json Migration Helper
+ * %%
+ * Copyright (C) 2025 Flowing Code
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.flowingcode.vaadin.jsonmigration;
+
+import com.vaadin.flow.component.Component;
+import com.vaadin.flow.router.RouteConfiguration;
+import com.vaadin.flow.server.VaadinServiceInitListener;
+import com.vaadin.flow.server.Version;
+
+/**
+ * Abstract base class for Vaadin service initializers that register instrumented views. Subclasses
+ * should implement {@link #serviceInit(com.vaadin.flow.server.ServiceInitEvent)} and call
+ * {@link #registerInstrumentedRoute(Class)} to register views with instrumented routes.
+ *
+ * @author Javier Godoy / Flowing Code
+ */
+@SuppressWarnings("serial")
+public abstract class InstrumentationViewInitializer implements VaadinServiceInitListener {
+
+  /**
+   * Registers an instrumented route for the given navigation target. The navigation target must be
+   * annotated with {@link InstrumentedRoute} to specify the route path. This method calls
+   * {@link JsonMigration#instrumentClass(Class)} to get the instrumented class and registers it as
+   * a Vaadin view with the route derived from the annotation.
+   *
+   * @param navigationTarget the component class to instrument and register, must be annotated with
+   *        {@link InstrumentedRoute}
+   * @throws IllegalArgumentException if the navigationTarget is not annotated with
+   *         {@link InstrumentedRoute}
+   */
+  protected final void registerInstrumentedRoute(Class<? extends Component> navigationTarget) {
+    InstrumentedRoute annotation = navigationTarget.getAnnotation(InstrumentedRoute.class);
+    if (annotation == null) {
+      throw new IllegalArgumentException(
+          navigationTarget.getName() + " must be annotated with @"
+              + InstrumentedRoute.class.getSimpleName());
+    }
+
+    String route = annotation.value();
+    if (Version.getMajorVersion() > 24) {
+      navigationTarget = JsonMigration.instrumentClass(navigationTarget);
+    }
+    RouteConfiguration.forApplicationScope().setRoute(route, navigationTarget);
+  }
+
+}

src/main/java/com/flowingcode/vaadin/jsonmigration/InstrumentedRoute.java

@@ -0,0 +1,44 @@
+/*-
+ * #%L
+ * Json Migration Helper
+ * %%
+ * Copyright (C) 2025 Flowing Code
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.flowingcode.vaadin.jsonmigration;
+
+import com.vaadin.flow.component.Component;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Annotation to mark a {@link Component} class for instrumented route registration.
+ *
+ * @author Javier Godoy / Flowing Code
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+public @interface InstrumentedRoute {
+
+  /**
+   * The route path for this component.
+   *
+   * @return the route path
+   */
+  String value();
+
+}