Configurable download URL generation (#296)

Configurable download URL generation.

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

hawkbit-core/src/main/java/org/eclipse/hawkbit/api/ApiType.java

@@ -9,8 +9,18 @@
 package org.eclipse.hawkbit.api;
 
 /**
- * Represented the supported protocols for artifact url's.
+ * hawkBit API type.
+ *
  */
-public enum UrlProtocol {
-    COAP, HTTP, HTTPS
+public enum ApiType {
+
+    /**
+     * Support for Device Management Federation API.
+     */
+    DMF,
+
+    /**
+     * Support for Direct Device Integration API.
+     */
+    DDI;
 }

hawkbit-core/src/main/java/org/eclipse/hawkbit/api/ArtifactUrl.java

@@ -0,0 +1,109 @@
+/**
+ * Copyright (c) 2015 Bosch Software Innovations GmbH and others.
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.eclipse.hawkbit.api;
+
+/**
+ * Container for a generated Artifact URL.
+ *
+ */
+public class ArtifactUrl {
+
+    private final String protocol;
+    private final String rel;
+    private final String ref;
+
+    /**
+     * Constructor.
+     * 
+     * @param protocol
+     *            string, e.g. ftp, http, https
+     * @param rel
+     *            hypermedia value
+     * @param ref
+     *            hypermedia value
+     */
+    public ArtifactUrl(final String protocol, final String rel, final String ref) {
+        this.protocol = protocol;
+        this.rel = rel;
+        this.ref = ref;
+    }
+
+    /**
+     * @return protocol name used in DMF API messages.
+     */
+    public String getProtocol() {
+        return protocol;
+    }
+
+    /**
+     * @return rel links value useful in hypermedia.
+     */
+    public String getRel() {
+        return rel;
+    }
+
+    /**
+     * @return generated artifact download URL
+     */
+    public String getRef() {
+        return ref;
+    }
+
+    @Override
+    public int hashCode() {
+        final int prime = 31;
+        int result = 1;
+        result = prime * result + ((protocol == null) ? 0 : protocol.hashCode());
+        result = prime * result + ((ref == null) ? 0 : ref.hashCode());
+        result = prime * result + ((rel == null) ? 0 : rel.hashCode());
+        return result;
+    }
+
+    @Override
+    public boolean equals(final Object obj) {
+        if (this == obj) {
+            return true;
+        }
+        if (obj == null) {
+            return false;
+        }
+        if (getClass() != obj.getClass()) {
+            return false;
+        }
+        final ArtifactUrl other = (ArtifactUrl) obj;
+        if (protocol == null) {
+            if (other.protocol != null) {
+                return false;
+            }
+        } else if (!protocol.equals(other.protocol)) {
+            return false;
+        }
+        if (ref == null) {
+            if (other.ref != null) {
+                return false;
+            }
+        } else if (!ref.equals(other.ref)) {
+            return false;
+        }
+        if (rel == null) {
+            if (other.rel != null) {
+                return false;
+            }
+        } else if (!rel.equals(other.rel)) {
+            return false;
+        }
+        return true;
+    }
+
+    @Override
+    public String toString() {
+        return "ArtifactUrl [protocol=" + protocol + ", rel=" + rel + ", ref=" + ref + "]";
+    }
+
+}

hawkbit-core/src/main/java/org/eclipse/hawkbit/api/ArtifactUrlHandler.java

@@ -8,36 +8,26 @@
  */
 package org.eclipse.hawkbit.api;
 
+import java.util.List;
+
 /**
  * Interface declaration of the {@link ArtifactUrlHandler} which generates the
  * URLs to specific artifacts.
  *
  */
+@FunctionalInterface
 public interface ArtifactUrlHandler {
 
     /**
      * Returns a generated download URL for a given artifact parameters for a
      * specific protocol.
      *
-     * @param controllerId
-     *            the authenticated controller id
-     * @param softwareModuleId
-     *            the softwareModuleId belonging to the artifact
-     * @param filename
-     *            the filename of the artifact
-     * @param sha1Hash
-     *            the sha1Hash of the artifact
-     * @param protocol
-     *            the protocol the URL should be generated
+     * @param placeholder
+     *            data for URL generation
+     * @param api
+     *            given protocol that URL needs to support
+     * 
      * @return an URL for the given artifact parameters in a given protocol
      */
-    String getUrl(String controllerId, final Long softwareModuleId, final String filename, final String sha1Hash,
-            final UrlProtocol protocol);
-
-    /**
-     * @param protocol
-     *            to check support for
-     * @return <code>true</code> of the handler supports given protocol.
-     */
-    boolean protocolSupported(UrlProtocol protocol);
+    List<ArtifactUrl> getUrls(URLPlaceholder placeholder, ApiType api);
 }

hawkbit-core/src/main/java/org/eclipse/hawkbit/api/ArtifactUrlHandlerProperties.java

@@ -8,90 +8,153 @@
  */
 package org.eclipse.hawkbit.api;
 
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
 import org.springframework.boot.context.properties.ConfigurationProperties;
 
+import com.google.common.collect.Lists;
+
 /**
  * Artifact handler properties class for holding all supported protocols with
  * host, ip, port and download pattern.
+ * 
+ * @see PropertyBasedArtifactUrlHandler
  */
 @ConfigurationProperties("hawkbit.artifact.url")
 public class ArtifactUrlHandlerProperties {
 
-    private final Http http = new Http();
-    private final Https https = new Https();
-    private final Coap coap = new Coap();
-
-    public Http getHttp() {
-        return http;
-    }
-
-    public Https getHttps() {
-        return https;
-    }
-
-    public Coap getCoap() {
-        return coap;
-    }
+    /**
+     * Rel as key and complete protocol as value.
+     */
+    private final Map<String, UrlProtocol> protocols = new HashMap<>();
 
     /**
-     * @param protocol
-     *            the protocol schema to retrieve the properties.
-     * @return the properties to a protocol or {@code null} if protocol does not
-     *         have properties or protocol not supported
+     * Protocol specific properties to generate URLs accordingly.
+     *
      */
-    public ProtocolProperties getProperties(final String protocol) {
-        switch (protocol) {
-        case "http":
-            return getHttp();
-        case "https":
-            return getHttps();
-        case "coap":
-            return getCoap();
-        default:
-            return null;
-        }
-    }
+    public static class UrlProtocol {
 
-    /**
-     * Object to hold the properties for the HTTP protocol.
-     */
-    public static class Http extends DefaultProtocolProperties {
+        private static final int DEFAULT_HTTP_PORT = 8080;
 
         /**
-         * Constructor.
+         * Set to true if enabled.
          */
-        public Http() {
-            setPattern(
-                    "{protocol}://{hostname}:{port}/{tenant}/controller/v1/{targetId}/softwaremodules/{softwareModuleId}/artifacts/{artifactFileName}");
-        }
-    }
-
-    /**
-     * Object to hold the properties for the HTTP protocol.
-     */
-    public static class Https extends DefaultProtocolProperties {
+        private boolean enabled = true;
 
         /**
-         * Constructor.
+         * Hypermedia rel value for this protocol.
          */
-        public Https() {
-            setPattern(
-                    "{protocol}://{hostname}:{port}/{tenant}/controller/v1/{targetId}/softwaremodules/{softwareModuleId}/artifacts/{artifactFileName}");
-        }
-    }
-
-    /**
-     * Object to hold the properties for the HTTP protocol.
-     */
-    public static class Coap extends DefaultProtocolProperties {
+        private String rel = "download-http";
 
         /**
-         * Constructor.
+         * Hypermedia ref pattern for this protocol. Supported place holders are
+         * protocol,controllerId,targetId,targetIdBase62,ip,port,hostname,
+         * artifactFileName,artifactSHA1,
+         * artifactIdBase62,artifactId,tenant,softwareModuleId,
+         * softwareModuleIdBase62.
+         * 
+         * The update server itself supports
          */
-        public Coap() {
-            setPattern("{protocol}://{ip}:{port}/fw/{tenant}/{targetId}/sha1/{artifactSHA1}");
-            setPort("5683");
+        private String ref = "{protocol}://{hostname}:{port}/{tenant}/controller/v1/{controllerId}/softwaremodules/{softwareModuleId}/artifacts/{artifactFileName}";
+
+        /**
+         * Protocol name placeholder that can be used in ref pattern.
+         */
+        private String protocol = "http";
+
+        /**
+         * Hostname placeholder that can be used in ref pattern.
+         */
+        private String hostname = "localhost";
+
+        /**
+         * IP address placeholder that can be used in ref pattern.
+         */
+        // Exception squid:S1313 - default only, can be configured
+        @SuppressWarnings("squid:S1313")
+        private String ip = "127.0.0.1";
+
+        /**
+         * Port placeholder that can be used in ref pattern.
+         */
+        private Integer port = DEFAULT_HTTP_PORT;
+
+        /**
+         * Support for the following hawkBit API.
+         */
+        private List<ApiType> supports = Lists.newArrayList(ApiType.DDI, ApiType.DMF);
+
+        public boolean isEnabled() {
+            return enabled;
         }
+
+        public void setEnabled(final boolean enabled) {
+            this.enabled = enabled;
+        }
+
+        public String getRel() {
+            return rel;
+        }
+
+        public void setRel(final String rel) {
+            this.rel = rel;
+        }
+
+        public String getRef() {
+            return ref;
+        }
+
+        public void setRef(final String ref) {
+            this.ref = ref;
+        }
+
+        public String getHostname() {
+            return hostname;
+        }
+
+        public void setHostname(final String hostname) {
+            this.hostname = hostname;
+        }
+
+        public String getIp() {
+            return ip;
+        }
+
+        public void setIp(final String ip) {
+            this.ip = ip;
+        }
+
+        public Integer getPort() {
+            return port;
+        }
+
+        public void setPort(final Integer port) {
+            this.port = port;
+        }
+
+        public List<ApiType> getSupports() {
+            return Collections.unmodifiableList(supports);
+        }
+
+        public void setSupports(final List<ApiType> supports) {
+            this.supports = Collections.unmodifiableList(supports);
+        }
+
+        public String getProtocol() {
+            return protocol;
+        }
+
+        public void setProtocol(final String protocol) {
+            this.protocol = protocol;
+        }
+
+    }
+
+    public Map<String, UrlProtocol> getProtocols() {
+        return protocols;
     }
 
 }

hawkbit-core/src/main/java/org/eclipse/hawkbit/api/Base62Util.java

@@ -0,0 +1,68 @@
+/**
+ * Copyright (c) 2015 Bosch Software Innovations GmbH and others.
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.eclipse.hawkbit.api;
+
+/**
+ * Utility class for Base10 to Base62 conversion and vice versa. Base62 has the
+ * benefit of being shorter in ASCII representation than Base10.
+ */
+public final class Base62Util {
+    private static final String BASE62_ALPHABET = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
+    private static final int BASE62_BASE = BASE62_ALPHABET.length();
+
+    private Base62Util() {
+        // Utility class
+    }
+
+    /**
+     * @param base10
+     *            number
+     * @return converted number into Base62 ASCII string
+     */
+    public static String fromBase10(final long base10) {
+        if (base10 == 0) {
+            return "0";
+        }
+
+        long temp = base10;
+        final StringBuilder sb = new StringBuilder();
+
+        while (temp > 0) {
+            temp = fromBase10(temp, sb);
+        }
+        return sb.reverse().toString();
+    }
+
+    /**
+     * @param base62
+     *            number
+     * @return converted number into Base10
+     */
+    public static Long toBase10(final String base62) {
+        return toBase10(new StringBuilder(base62).reverse().toString().toCharArray());
+    }
+
+    private static Long fromBase10(final long base10, final StringBuilder sb) {
+        final int rem = (int) (base10 % BASE62_BASE);
+        sb.append(BASE62_ALPHABET.charAt(rem));
+        return base10 / BASE62_BASE;
+    }
+
+    private static Long toBase10(final char[] chars) {
+        long base10 = 0L;
+        for (int i = chars.length - 1; i >= 0; i--) {
+            base10 += toBase10(BASE62_ALPHABET.indexOf(chars[i]), i);
+        }
+        return base10;
+    }
+
+    private static int toBase10(final int n, final int pow) {
+        return n * (int) Math.pow(BASE62_BASE, pow);
+    }
+}

hawkbit-core/src/main/java/org/eclipse/hawkbit/api/DefaultProtocolProperties.java

@@ -1,79 +0,0 @@
-/**
- * Copyright (c) 2015 Bosch Software Innovations GmbH and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * which accompanies this distribution, and is available at
- * http://www.eclipse.org/legal/epl-v10.html
- */
-package org.eclipse.hawkbit.api;
-
-/**
- * Object to hold the properties for the base protocols.
- */
-public class DefaultProtocolProperties implements ProtocolProperties {
-    // The IP address is not hardcoded. It's the default value, if the IP
-    // address is not configured.
-    @SuppressWarnings("squid:S1313")
-    private static final String DEFAULT_IP_LOCALHOST = "127.0.0.1";
-    private static final String LOCALHOST = "localhost";
-
-    private String hostname = LOCALHOST;
-    private String ip = DEFAULT_IP_LOCALHOST;
-    private String port = "";
-    /**
-     * An ant-URL pattern with placeholder to build the URL on. The URL can have
-     * specific artifact placeholder.
-     */
-    private String pattern;
-
-    /**
-     * Enables protocol.
-     */
-    private boolean enabled = true;
-
-    @Override
-    public boolean isEnabled() {
-        return enabled;
-    }
-
-    public void setEnabled(final boolean enabled) {
-        this.enabled = enabled;
-    }
-
-    @Override
-    public String getHostname() {
-        return hostname;
-    }
-
-    public void setHostname(final String hostname) {
-        this.hostname = hostname;
-    }
-
-    @Override
-    public String getIp() {
-        return ip;
-    }
-
-    public void setIp(final String ip) {
-        this.ip = ip;
-    }
-
-    @Override
-    public String getPattern() {
-        return pattern;
-    }
-
-    public void setPattern(final String urlPattern) {
-        this.pattern = urlPattern;
-    }
-
-    @Override
-    public String getPort() {
-        return port;
-    }
-
-    public void setPort(final String port) {
-        this.port = port;
-    }
-}

hawkbit-core/src/main/java/org/eclipse/hawkbit/api/PropertyBasedArtifactUrlHandler.java

@@ -9,55 +9,80 @@
 package org.eclipse.hawkbit.api;
 
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Set;
+import java.util.stream.Collectors;
 
-import org.eclipse.hawkbit.tenancy.TenantAware;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.context.properties.EnableConfigurationProperties;
-import org.springframework.stereotype.Component;
+import org.eclipse.hawkbit.api.ArtifactUrlHandlerProperties.UrlProtocol;
 
 import com.google.common.base.Strings;
 import com.google.common.net.UrlEscapers;
 
 /**
  * Implementation for ArtifactUrlHandler for creating urls to download resource
- * based on pattern.
+ * based on patterns configured by {@link ArtifactUrlHandlerProperties}.
+ * 
+ * This mechanism can be used to generate links to arbitrary file hosting
+ * infrastructure. However, the hawkBit update server supports hosting files as
+ * well in the following {@link UrlProtocol#getRef()} patterns:
+ * 
+ * Default:
+ * {protocol}://{hostname}:{port}/{tenant}/controller/v1/{controllerId}/
+ * softwaremodules/{softwareModuleId}/artifacts/{artifactFileName}
+ * 
+ * Default (MD5SUM files):
+ * {protocol}://{hostname}:{port}/{tenant}/controller/v1/{controllerId}/
+ * softwaremodules/{softwareModuleId}/artifacts/{artifactFileName}.MD5SUM
+ * 
  */
-@Component
-@EnableConfigurationProperties(ArtifactUrlHandlerProperties.class)
 public class PropertyBasedArtifactUrlHandler implements ArtifactUrlHandler {
 
     private static final String PROTOCOL_PLACEHOLDER = "protocol";
-    private static final String TARGET_ID_PLACEHOLDER = "targetId";
+    private static final String CONTROLLER_ID_PLACEHOLDER = "controllerId";
+    private static final String TARGET_ID_BASE10_PLACEHOLDER = "targetId";
+    private static final String TARGET_ID_BASE62_PLACEHOLDER = "targetIdBase62";
     private static final String IP_PLACEHOLDER = "ip";
     private static final String PORT_PLACEHOLDER = "port";
     private static final String HOSTNAME_PLACEHOLDER = "hostname";
     private static final String ARTIFACT_FILENAME_PLACEHOLDER = "artifactFileName";
     private static final String ARTIFACT_SHA1_PLACEHOLDER = "artifactSHA1";
+    private static final String ARTIFACT_ID_BASE10_PLACEHOLDER = "artifactId";
+    private static final String ARTIFACT_ID_BASE62_PLACEHOLDER = "artifactIdBase62";
     private static final String TENANT_PLACEHOLDER = "tenant";
-    private static final String SOFTWARE_MODULE_ID_PLACDEHOLDER = "softwareModuleId";
+    private static final String TENANT_ID_BASE10_PLACEHOLDER = "tenantId";
+    private static final String TENANT_ID_BASE62_PLACEHOLDER = "tenantIdBase62";
+    private static final String SOFTWARE_MODULE_ID_BASE10_PLACDEHOLDER = "softwareModuleId";
+    private static final String SOFTWARE_MODULE_ID_BASE62_PLACDEHOLDER = "softwareModuleIdBase62";
 
-    @Autowired
-    private ArtifactUrlHandlerProperties urlHandlerProperties;
+    private final ArtifactUrlHandlerProperties urlHandlerProperties;
 
-    @Autowired
-    private TenantAware tenantAware;
+    /**
+     * @param urlHandlerProperties
+     *            for URL generation configuration
+     */
+    public PropertyBasedArtifactUrlHandler(final ArtifactUrlHandlerProperties urlHandlerProperties) {
+        this.urlHandlerProperties = urlHandlerProperties;
+    }
 
     @Override
-    public String getUrl(final String targetId, final Long softwareModuleId, final String filename,
-            final String sha1Hash, final UrlProtocol protocol) {
+    public List<ArtifactUrl> getUrls(final URLPlaceholder placeholder, final ApiType api) {
 
-        final String protocolString = protocol.name().toLowerCase();
-        final ProtocolProperties properties = urlHandlerProperties.getProperties(protocolString);
-        if (properties == null || properties.getPattern() == null) {
-            return null;
-        }
+        return urlHandlerProperties.getProtocols().entrySet().stream()
+                .filter(entry -> entry.getValue().getSupports().contains(api))
+                .filter(entry -> entry.getValue().isEnabled())
+                .map(entry -> new ArtifactUrl(entry.getValue().getProtocol(), entry.getValue().getRel(),
+                        generateUrl(entry.getValue(), placeholder)))
+                .collect(Collectors.toList());
+
+    }
+
+    private static String generateUrl(final UrlProtocol protocol, final URLPlaceholder placeholder) {
+        final Set<Entry<String, String>> entrySet = getReplaceMap(protocol, placeholder).entrySet();
+
+        String urlPattern = protocol.getRef();
 
-        String urlPattern = properties.getPattern();
-        final Set<Entry<String, String>> entrySet = getReplaceMap(targetId, softwareModuleId,
-                UrlEscapers.urlFragmentEscaper().escape(filename), sha1Hash, protocolString, properties).entrySet();
         for (final Entry<String, String> entry : entrySet) {
             if (entry.getKey().equals(PORT_PLACEHOLDER)) {
                 urlPattern = urlPattern.replace(":{" + entry.getKey() + "}",
@@ -69,30 +94,29 @@ public class PropertyBasedArtifactUrlHandler implements ArtifactUrlHandler {
         return urlPattern;
     }
 
-    private Map<String, String> getReplaceMap(final String targetId, final Long softwareModuleId, final String filename,
-            final String sha1Hash, final String protocol, final ProtocolProperties properties) {
+    private static Map<String, String> getReplaceMap(final UrlProtocol protocol, final URLPlaceholder placeholder) {
         final Map<String, String> replaceMap = new HashMap<>();
-        replaceMap.put(IP_PLACEHOLDER, properties.getIp());
-        replaceMap.put(HOSTNAME_PLACEHOLDER, properties.getHostname());
-        replaceMap.put(ARTIFACT_FILENAME_PLACEHOLDER, filename);
-        replaceMap.put(ARTIFACT_SHA1_PLACEHOLDER, sha1Hash);
-        replaceMap.put(PROTOCOL_PLACEHOLDER, protocol);
-        replaceMap.put(PORT_PLACEHOLDER, properties.getPort());
-        replaceMap.put(TENANT_PLACEHOLDER, tenantAware.getCurrentTenant());
-        replaceMap.put(TARGET_ID_PLACEHOLDER, targetId);
-        replaceMap.put(SOFTWARE_MODULE_ID_PLACDEHOLDER, String.valueOf(softwareModuleId));
+        replaceMap.put(IP_PLACEHOLDER, protocol.getIp());
+        replaceMap.put(HOSTNAME_PLACEHOLDER, protocol.getHostname());
+        replaceMap.put(ARTIFACT_FILENAME_PLACEHOLDER,
+                UrlEscapers.urlFragmentEscaper().escape(placeholder.getSoftwareData().getFilename()));
+        replaceMap.put(ARTIFACT_SHA1_PLACEHOLDER, placeholder.getSoftwareData().getSha1Hash());
+        replaceMap.put(PROTOCOL_PLACEHOLDER, protocol.getProtocol());
+        replaceMap.put(PORT_PLACEHOLDER, protocol.getPort() == null ? null : String.valueOf(protocol.getPort()));
+        replaceMap.put(TENANT_PLACEHOLDER, placeholder.getTenant());
+        replaceMap.put(TENANT_ID_BASE10_PLACEHOLDER, String.valueOf(placeholder.getTenantId()));
+        replaceMap.put(TENANT_ID_BASE62_PLACEHOLDER, Base62Util.fromBase10(placeholder.getTenantId()));
+        replaceMap.put(CONTROLLER_ID_PLACEHOLDER, placeholder.getControllerId());
+        replaceMap.put(TARGET_ID_BASE10_PLACEHOLDER, String.valueOf(placeholder.getTargetId()));
+        replaceMap.put(TARGET_ID_BASE62_PLACEHOLDER, Base62Util.fromBase10(placeholder.getTargetId()));
+        replaceMap.put(ARTIFACT_ID_BASE62_PLACEHOLDER,
+                Base62Util.fromBase10(placeholder.getSoftwareData().getArtifactId()));
+        replaceMap.put(ARTIFACT_ID_BASE10_PLACEHOLDER, String.valueOf(placeholder.getSoftwareData().getArtifactId()));
+        replaceMap.put(SOFTWARE_MODULE_ID_BASE10_PLACDEHOLDER,
+                String.valueOf(placeholder.getSoftwareData().getSoftwareModuleId()));
+        replaceMap.put(SOFTWARE_MODULE_ID_BASE62_PLACDEHOLDER,
+                Base62Util.fromBase10(placeholder.getSoftwareData().getSoftwareModuleId()));
         return replaceMap;
     }
 
-    @Override
-    public boolean protocolSupported(final UrlProtocol protocol) {
-        final String protocolString = protocol.name().toLowerCase();
-        final ProtocolProperties properties = urlHandlerProperties.getProperties(protocolString);
-        if (properties == null || properties.getPattern() == null) {
-            return false;
-        }
-
-        return properties.isEnabled();
-    }
-
 }

hawkbit-core/src/main/java/org/eclipse/hawkbit/api/URLPlaceholder.java

@@ -0,0 +1,247 @@
+/**
+ * Copyright (c) 2015 Bosch Software Innovations GmbH and others.
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.eclipse.hawkbit.api;
+
+/**
+ * Container for variables available to the {@link ArtifactUrlHandler}.
+ *
+ */
+public class URLPlaceholder {
+    private final String tenant;
+    private final Long tenantId;
+    private final String controllerId;
+    private final Long targetId;
+    private final SoftwareData softwareData;
+
+    /**
+     * Constructor.
+     * 
+     * @param tenant
+     *            of the client
+     * @param tenantId
+     *            of teh tenant
+     * @param controllerId
+     *            of the target
+     * @param targetId
+     *            of the target
+     * @param softwareData
+     *            information about the artifact and software module that can be
+     *            accessed by the URL.
+     */
+    public URLPlaceholder(final String tenant, final Long tenantId, final String controllerId, final Long targetId,
+            final SoftwareData softwareData) {
+        this.tenant = tenant;
+        this.tenantId = tenantId;
+        this.controllerId = controllerId;
+        this.targetId = targetId;
+        this.softwareData = softwareData;
+    }
+
+    /**
+     * Information about the artifact and software module that can be accessed
+     * by the URL.
+     *
+     */
+    public static class SoftwareData {
+        private Long softwareModuleId;
+        private String filename;
+        private Long artifactId;
+        private String sha1Hash;
+
+        /**
+         * Constructor.
+         * 
+         * @param softwareModuleId
+         *            of the module the artifact belongs to
+         * @param filename
+         *            of the artifact
+         * @param artifactId
+         *            of the artifact
+         * @param sha1Hash
+         *            of the artifact
+         */
+        public SoftwareData(final Long softwareModuleId, final String filename, final Long artifactId,
+                final String sha1Hash) {
+            this.softwareModuleId = softwareModuleId;
+            this.filename = filename;
+            this.artifactId = artifactId;
+            this.sha1Hash = sha1Hash;
+        }
+
+        public Long getSoftwareModuleId() {
+            return softwareModuleId;
+        }
+
+        public void setSoftwareModuleId(final Long softwareModuleId) {
+            this.softwareModuleId = softwareModuleId;
+        }
+
+        public String getFilename() {
+            return filename;
+        }
+
+        public void setFilename(final String filename) {
+            this.filename = filename;
+        }
+
+        public Long getArtifactId() {
+            return artifactId;
+        }
+
+        public void setArtifactId(final Long artifactId) {
+            this.artifactId = artifactId;
+        }
+
+        public String getSha1Hash() {
+            return sha1Hash;
+        }
+
+        public void setSha1Hash(final String sha1Hash) {
+            this.sha1Hash = sha1Hash;
+        }
+
+        @Override
+        public int hashCode() {
+            final int prime = 31;
+            int result = 1;
+            result = prime * result + ((artifactId == null) ? 0 : artifactId.hashCode());
+            result = prime * result + ((filename == null) ? 0 : filename.hashCode());
+            result = prime * result + ((sha1Hash == null) ? 0 : sha1Hash.hashCode());
+            result = prime * result + ((softwareModuleId == null) ? 0 : softwareModuleId.hashCode());
+            return result;
+        }
+
+        @Override
+        public boolean equals(final Object obj) {
+            if (this == obj) {
+                return true;
+            }
+            if (obj == null) {
+                return false;
+            }
+            if (getClass() != obj.getClass()) {
+                return false;
+            }
+            final SoftwareData other = (SoftwareData) obj;
+            if (artifactId == null) {
+                if (other.artifactId != null) {
+                    return false;
+                }
+            } else if (!artifactId.equals(other.artifactId)) {
+                return false;
+            }
+            if (filename == null) {
+                if (other.filename != null) {
+                    return false;
+                }
+            } else if (!filename.equals(other.filename)) {
+                return false;
+            }
+            if (sha1Hash == null) {
+                if (other.sha1Hash != null) {
+                    return false;
+                }
+            } else if (!sha1Hash.equals(other.sha1Hash)) {
+                return false;
+            }
+            if (softwareModuleId == null) {
+                if (other.softwareModuleId != null) {
+                    return false;
+                }
+            } else if (!softwareModuleId.equals(other.softwareModuleId)) {
+                return false;
+            }
+            return true;
+        }
+
+    }
+
+    public String getTenant() {
+        return tenant;
+    }
+
+    public Long getTenantId() {
+        return tenantId;
+    }
+
+    public String getControllerId() {
+        return controllerId;
+    }
+
+    public Long getTargetId() {
+        return targetId;
+    }
+
+    public SoftwareData getSoftwareData() {
+        return softwareData;
+    }
+
+    @Override
+    public int hashCode() {
+        final int prime = 31;
+        int result = 1;
+        result = prime * result + ((controllerId == null) ? 0 : controllerId.hashCode());
+        result = prime * result + ((softwareData == null) ? 0 : softwareData.hashCode());
+        result = prime * result + ((targetId == null) ? 0 : targetId.hashCode());
+        result = prime * result + ((tenant == null) ? 0 : tenant.hashCode());
+        result = prime * result + ((tenantId == null) ? 0 : tenantId.hashCode());
+        return result;
+    }
+
+    @Override
+    public boolean equals(final Object obj) {
+        if (this == obj) {
+            return true;
+        }
+        if (obj == null) {
+            return false;
+        }
+        if (getClass() != obj.getClass()) {
+            return false;
+        }
+        final URLPlaceholder other = (URLPlaceholder) obj;
+        if (controllerId == null) {
+            if (other.controllerId != null) {
+                return false;
+            }
+        } else if (!controllerId.equals(other.controllerId)) {
+            return false;
+        }
+        if (softwareData == null) {
+            if (other.softwareData != null) {
+                return false;
+            }
+        } else if (!softwareData.equals(other.softwareData)) {
+            return false;
+        }
+        if (targetId == null) {
+            if (other.targetId != null) {
+                return false;
+            }
+        } else if (!targetId.equals(other.targetId)) {
+            return false;
+        }
+        if (tenant == null) {
+            if (other.tenant != null) {
+                return false;
+            }
+        } else if (!tenant.equals(other.tenant)) {
+            return false;
+        }
+        if (tenantId == null) {
+            if (other.tenantId != null) {
+                return false;
+            }
+        } else if (!tenantId.equals(other.tenantId)) {
+            return false;
+        }
+        return true;
+    }
+
+}

hawkbit-core/src/main/java/org/eclipse/hawkbit/tenancy/configuration/TenantConfigurationKey.java

@@ -90,7 +90,7 @@ public enum TenantConfigurationKey {
      * @param validator
      *            Validator which validates, that property is of correct format
      */
-    private TenantConfigurationKey(final String key, final String defaultKeyName, final Class<?> dataType,
+    TenantConfigurationKey(final String key, final String defaultKeyName, final Class<?> dataType,
             final String defaultValue, final Class<? extends TenantConfigurationValidator> validator) {
         this.keyName = key;
         this.dataType = dataType;

hawkbit-core/src/test/java/org/eclipse/hawkbit/api/Base62UtilTest.java

@@ -0,0 +1,40 @@
+/**
+ * Copyright (c) 2015 Bosch Software Innovations GmbH and others.
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.eclipse.hawkbit.api;
+
+import static org.fest.assertions.api.Assertions.assertThat;
+
+import org.junit.Test;
+
+import ru.yandex.qatools.allure.annotations.Description;
+import ru.yandex.qatools.allure.annotations.Features;
+import ru.yandex.qatools.allure.annotations.Stories;
+
+@Features("Unit Tests - Artifact URL Handler")
+@Stories("Base62 Utility tests")
+public class Base62UtilTest {
+
+    @Test
+    @Description("Convert Base10 numbres to Base62 ASCII strings.")
+    public void fromBase10() {
+        assertThat(Base62Util.fromBase10(0L)).isEqualTo("0");
+        assertThat(Base62Util.fromBase10(11L)).isEqualTo("B");
+        assertThat(Base62Util.fromBase10(36L)).isEqualTo("a");
+        assertThat(Base62Util.fromBase10(999L)).isEqualTo("G7");
+    }
+
+    @Test
+    @Description("Convert Base62 ASCII strings to Base10 numbers.")
+    public void toBase10() {
+        assertThat(Base62Util.toBase10("0")).isEqualTo(0L);
+        assertThat(Base62Util.toBase10("B")).isEqualTo(11);
+        assertThat(Base62Util.toBase10("a")).isEqualTo(36L);
+        assertThat(Base62Util.toBase10("G7")).isEqualTo(999L);
+    }
+}

hawkbit-core/src/test/java/org/eclipse/hawkbit/api/PropertyBasedArtifactUrlHandlerTest.java

@@ -0,0 +1,124 @@
+/**
+ * Copyright (c) 2015 Bosch Software Innovations GmbH and others.
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.eclipse.hawkbit.api;
+
+import static org.fest.assertions.api.Assertions.assertThat;
+import static org.junit.Assert.assertEquals;
+
+import java.util.List;
+
+import org.eclipse.hawkbit.api.ArtifactUrlHandlerProperties.UrlProtocol;
+import org.eclipse.hawkbit.api.URLPlaceholder.SoftwareData;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.runners.MockitoJUnitRunner;
+
+import com.google.common.collect.Lists;
+
+import ru.yandex.qatools.allure.annotations.Description;
+import ru.yandex.qatools.allure.annotations.Features;
+import ru.yandex.qatools.allure.annotations.Stories;
+
+/**
+ * Tests for creating urls to download artifacts.
+ */
+@Features("Unit Tests - Artifact URL Handler")
+@Stories("Test to generate the artifact download URL")
+@RunWith(MockitoJUnitRunner.class)
+public class PropertyBasedArtifactUrlHandlerTest {
+
+    private static final String TEST_PROTO = "coap";
+    private static final String TEST_REL = "download-udp";
+
+    private static final long TENANT_ID = 456789L;
+    private static final String CONTROLLER_ID = "Test";
+    private static final String FILENAME = "Afile1234";
+    private static final long SOFTWAREMODULEID = 87654L;
+    private static final long TARGETID = 3474366L;
+    private static final String TARGETID_BASE62 = "EZqA";
+    private static final String SHA1HASH = "test12345";
+    private static final long ARTIFACTID = 1345678L;
+    private static final String ARTIFACTID_BASE62 = "5e4U";
+    private static final String TENANT = "TEST_TENANT";
+
+    private static final String HTTP_LOCALHOST = "http://localhost:8080/";
+
+    private ArtifactUrlHandler urlHandlerUnderTest;
+
+    private ArtifactUrlHandlerProperties properties;
+
+    private static URLPlaceholder placeholder = new URLPlaceholder(TENANT, TENANT_ID, CONTROLLER_ID, TARGETID,
+            new SoftwareData(SOFTWAREMODULEID, FILENAME, ARTIFACTID, SHA1HASH));
+
+    @Before
+    public void setup() {
+        properties = new ArtifactUrlHandlerProperties();
+        urlHandlerUnderTest = new PropertyBasedArtifactUrlHandler(properties);
+
+    }
+
+    @Test
+    @Description("Tests the generation of http download url.")
+    public void urlGenerationWithDefaultConfiguration() {
+        properties.getProtocols().put("download-http", new UrlProtocol());
+
+        final List<ArtifactUrl> ddiUrls = urlHandlerUnderTest.getUrls(placeholder, ApiType.DDI);
+        assertEquals(
+                Lists.newArrayList(new ArtifactUrl("http", "download-http", HTTP_LOCALHOST + TENANT + "/controller/v1/"
+                        + CONTROLLER_ID + "/softwaremodules/" + SOFTWAREMODULEID + "/artifacts/" + FILENAME)),
+                ddiUrls);
+
+        final List<ArtifactUrl> dmfUrls = urlHandlerUnderTest.getUrls(placeholder, ApiType.DMF);
+        assertEquals(ddiUrls, dmfUrls);
+    }
+
+    @Test
+    @Description("Tests the generation of custom download url with a CoAP example that supports DMF only.")
+    public void urlGenerationWithCustomConfiguration() {
+        final UrlProtocol proto = new UrlProtocol();
+        proto.setIp("127.0.0.1");
+        proto.setPort(5683);
+        proto.setProtocol(TEST_PROTO);
+        proto.setRel(TEST_REL);
+        proto.setSupports(Lists.newArrayList(ApiType.DMF));
+        proto.setRef("{protocol}://{ip}:{port}/fw/{tenant}/{controllerId}/sha1/{artifactSHA1}");
+        properties.getProtocols().put(TEST_PROTO, proto);
+
+        List<ArtifactUrl> urls = urlHandlerUnderTest.getUrls(placeholder, ApiType.DDI);
+
+        assertThat(urls).isEmpty();
+        urls = urlHandlerUnderTest.getUrls(placeholder, ApiType.DMF);
+
+        assertEquals(Lists.newArrayList(new ArtifactUrl(TEST_PROTO, TEST_REL,
+                "coap://127.0.0.1:5683/fw/" + TENANT + "/" + CONTROLLER_ID + "/sha1/" + SHA1HASH)), urls);
+    }
+
+    @Test
+    @Description("Tests the generation of custom download url using Base62 references with a CoAP example that supports DMF only.")
+    public void urlGenerationWithCustomShortConfiguration() {
+        final UrlProtocol proto = new UrlProtocol();
+        proto.setIp("127.0.0.1");
+        proto.setPort(5683);
+        proto.setProtocol(TEST_PROTO);
+        proto.setRel(TEST_REL);
+        proto.setSupports(Lists.newArrayList(ApiType.DMF));
+        proto.setRef("{protocol}://{ip}:{port}/fws/{tenant}/{targetIdBase62}/{artifactIdBase62}");
+        properties.getProtocols().put("ftp", proto);
+
+        List<ArtifactUrl> urls = urlHandlerUnderTest.getUrls(placeholder, ApiType.DDI);
+
+        assertThat(urls).isEmpty();
+        urls = urlHandlerUnderTest.getUrls(placeholder, ApiType.DMF);
+
+        assertEquals(Lists.newArrayList(new ArtifactUrl(TEST_PROTO, TEST_REL,
+                TEST_PROTO + "://127.0.0.1:5683/fws/" + TENANT + "/" + TARGETID_BASE62 + "/" + ARTIFACTID_BASE62)),
+                urls);
+    }
+}