Updated javadoc for the getURl method

Signed-off-by: Jonathan Philip Knoblauch <JonathanPhilip.Knoblauch@bosch-si.com>
This commit is contained in:
Jonathan Philip Knoblauch
2016-04-04 10:48:14 +02:00
parent b03fa5eec8
commit 84f543382c

View File

@@ -17,15 +17,20 @@ package org.eclipse.hawkbit.api;
public interface ArtifactUrlHandler { public interface ArtifactUrlHandler {
/** /**
* Returns a generated URL for a given artifact for a specific protocol. * Returns a generated download URL for a given artifact parameters for a
* specific protocol.
* *
* @param controllerId * @param controllerId
* the authenticated controller id * the authenticated controller id
* @param localArtifact * @param softwareModuleId
* the artifact to retrieve a URL to * the softwareModuleId belonging to the artifact
* @param filename
* the filename of the artifact
* @param sha1Hash
* the sha1Hash of the artifact
* @param protocol * @param protocol
* the protocol the URL should be generated * the protocol the URL should be generated
* @return an URL for the given artifact in a given protocol * @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, String getUrl(String controllerId, final Long softwareModuleId, final String filename, final String sha1Hash,
final UrlProtocol protocol); final UrlProtocol protocol);