Add Link.getTitle() method (#38)

stefanseifert · web-flow · commit ce37e5a9e34b · 2025-11-14T12:17:20.000+01:00
diff --git a/changes.xml b/changes.xml
@@ -24,7 +24,10 @@
     xsi:schemaLocation="http://maven.apache.org/changes/2.0.0 https://maven.apache.org/xsd/changes-2.0.0.xsd">
   <body>
 
-    <release version="2.2.12" date="not released">
+    <release version="2.3.0" date="not released">
+      <action type="add" dev="sseifert" issue="38">
+        Add Link.getTitle() method.
+      </action>
       <action type="update" dev="sseifert" issue="36">
         ResourceLink: Allow adapting from Resource, additional to from SlingHttpServletRequest.
       </action>
diff --git a/src/main/java/io/wcm/handler/link/Link.java b/src/main/java/io/wcm/handler/link/Link.java
@@ -175,6 +175,14 @@ public void setUrl(@Nullable String url) {
     this.url = url;
   }
 
+  /**
+   * Get link title. This is only supported, if the link was build from a resource with link properties,
+   * and in this resource a property {@link LinkNameConstants#PN_LINK_TITLE} is set.
+   */
+  public @Nullable String getTitle() {
+    return linkRequest.getResourceProperties().get(LinkNameConstants.PN_LINK_TITLE, String.class);
+  }
+
   /**
    * @return Target page referenced by the link (applies only for internal links)
    */
diff --git a/src/main/java/io/wcm/handler/link/package-info.java b/src/main/java/io/wcm/handler/link/package-info.java
@@ -20,5 +20,5 @@
 /**
  * Link Handler API.
  */
-@org.osgi.annotation.versioning.Version("2.1.0")
+@org.osgi.annotation.versioning.Version("2.2.0")
 package io.wcm.handler.link;
diff --git a/src/test/java/io/wcm/handler/link/impl/LinkHandlerImplTest.java b/src/test/java/io/wcm/handler/link/impl/LinkHandlerImplTest.java
@@ -21,10 +21,13 @@
 
 import static io.wcm.handler.link.LinkNameConstants.PN_COMPONENT_LINK_TARGET_URL_FALLBACK_PROPERTY;
 import static io.wcm.handler.link.LinkNameConstants.PN_COMPONENT_LINK_TARGET_WINDOW_TARGET_FALLBACK_PROPERTY;
+import static io.wcm.handler.link.LinkNameConstants.PN_LINK_EXTERNAL_REF;
+import static io.wcm.handler.link.LinkNameConstants.PN_LINK_TITLE;
 import static io.wcm.handler.link.LinkNameConstants.PN_LINK_TYPE;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertNull;
 
 import java.util.List;
 import java.util.Map;
@@ -48,6 +51,7 @@
 import io.wcm.handler.link.spi.LinkProcessor;
 import io.wcm.handler.link.spi.LinkType;
 import io.wcm.handler.link.testcontext.AppAemContext;
+import io.wcm.handler.link.type.ExternalLinkType;
 import io.wcm.handler.url.UrlModes;
 import io.wcm.sling.commons.adapter.AdaptTo;
 import io.wcm.sling.commons.resource.ImmutableValueMap;
@@ -189,6 +193,26 @@ void testLinkHandlerCustomProperty() {
     assertEquals("value1", link.getLinkRequest().getLinkArgs().getProperties().get("prop1"));
   }
 
+  @Test
+  void testLinkGetTitle() {
+    LinkHandler linkHandler = AdaptTo.notNull(adaptable(), LinkHandler.class);
+
+    Resource linkResource = context.create().resource("/content/dummy-path",
+        PN_LINK_TYPE, ExternalLinkType.ID,
+        PN_LINK_EXTERNAL_REF, "http://dummy",
+        PN_LINK_TITLE, "My Link Title");
+
+    Link link = linkHandler.get(linkResource).build();
+    assertEquals("My Link Title", link.getTitle());
+  }
+
+  @Test
+  void testLinkGetTitleWithoutResourceProperties() {
+    LinkHandler linkHandler = AdaptTo.notNull(adaptable(), LinkHandler.class);
+
+    Link link = linkHandler.get("http://dummy").build();
+    assertNull(link.getTitle());
+  }
 
   public static class TestLinkHandlerConfig extends LinkHandlerConfig {
 
