Package org.gcube.application.shlink

Class ShlinkShortener

java.lang.Object

org.gcube.application.shlink.ShlinkShortener

public class ShlinkShortener
extends Object

A URL shortener implementation that uses the Shlink REST API service.

This class provides functionality to create shortened URLs by communicating with a Shlink server instance through its REST API. Shlink is an open-source URL shortener that can be self-hosted.

Usage Example:

 ShlinkShortener shortener = new ShlinkShortener();
 String shortUrl = shortener.createShortUrl("https://your-shlink-instance.com/rest/v3/short-urls", "your-api-key",
                "https://example.com/very-long-url");
 

Requirements:

• A running Shlink server instance with REST API enabled
• Valid API key with permissions to create short URLs
• Network connectivity to the Shlink server

...

Author:

Francesco Mangiacrapa

See Also:

• Shlink Official Website
• Shlink API Documentation

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DOMAIN
static final String	KEY	Property name for API key in the resource
protected static org.slf4j.Logger	LOGGER
static final String	SHORTENER	The Resurce Name registered in the Information System

Constructor Summary

Constructors

Constructor	Description
ShlinkShortener(String scope)

Method Summary

Modifier and Type	Method	Description
String	createShortUrl(String shlinkBaseUrl, String shlinkAPIKey, String longUrl)	Creates a short URL using the Shlink API service.
String	shorten(String longUrl, String[] additionalTags, boolean findIfExists)	Shorten URL with domain and additional tags.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SHORTENER

public static final String SHORTENER

The Resurce Name registered in the Information System

See Also:

• Constant Field Values

KEY

public static final String KEY

Property name for API key in the resource

See Also:

• Constant Field Values

DOMAIN

public static final String DOMAIN

See Also:

• Constant Field Values

LOGGER

protected static org.slf4j.Logger LOGGER

Constructor Details

ShlinkShortener

public ShlinkShortener(String scope)
                throws Exception

Throws:

Exception

Method Details

shorten

public String shorten(String longUrl,
 String[] additionalTags,
 boolean findIfExists)
               throws Exception

Shorten URL with domain and additional tags.

Parameters:

longUrl - the long url

additionalTags - optional additional tags to associate with the short URL (combined with auto-extracted tags)

findIfExists - if true, checks if the short URL already exists before creating a new one

Returns:

a shorten url

Throws:

Exception - the exception

createShortUrl

public String createShortUrl(String shlinkBaseUrl,
 String shlinkAPIKey,
 String longUrl)

Creates a short URL using the Shlink API service. Automatically extracts tags from the URL based on predefined keywords.

Parameters:

shlinkBaseUrl - the base URL of the Shlink service

shlinkAPIKey - the API key for authentication

longUrl - the original long URL to be shortened

Returns:

the shortened URL as a String if successful, null if the operation fails