Skip to content

add user-agent header to template downloader request #12791

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sudo87 wants to merge 2 commits into
base: 4.22
Choose a base branch
from
+13 −0
Open

add user-agent header to template downloader request #12791

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1fe48e1
add user-agent header to template downloader request
sudo87 Mar 11, 2026
c1eb8a5
handle review comment
sudo87 Mar 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions api/src/main/java/org/apache/cloudstack/api/ApiConstants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1364,6 +1364,8 @@ public class ApiConstants {

public static final String RECURSIVE_DOMAINS = "recursivedomains";

public static final String CLOUDSTACK_USER_AGENT = "CloudStack-Agent";

/**
* This enum specifies IO Drivers, each option controls specific policies on I/O.
* Qemu guests support "threads" and "native" options Since 0.8.8 ; "io_uring" is supported Since 6.3.0 (QEMU 5.0).
Expand Down
2 changes: 2 additions & 0 deletions core/src/main/java/com/cloud/storage/template/HttpTemplateDownloader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
package com.cloud.storage.template;

import static com.cloud.utils.NumbersUtil.toHumanReadableSize;
import static org.apache.cloudstack.api.ApiConstants.CLOUDSTACK_USER_AGENT;

import java.io.File;
import java.io.IOException;
Expand Down Expand Up @@ -125,6 +126,7 @@ private GetMethod createRequest(String downloadUrl) {
GetMethod request = new GetMethod(downloadUrl);
request.getParams().setParameter(HttpMethodParams.RETRY_HANDLER, myretryhandler);
request.setFollowRedirects(followRedirects);
request.getParams().setParameter(HttpMethodParams.USER_AGENT, CLOUDSTACK_USER_AGENT);
return request;
}

Expand Down
3 changes: 3 additions & 0 deletions core/src/main/java/com/cloud/storage/template/MetalinkTemplateDownloader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
//
package com.cloud.storage.template;

import static org.apache.cloudstack.api.ApiConstants.CLOUDSTACK_USER_AGENT;

import com.cloud.storage.StorageLayer;
import com.cloud.utils.UriUtils;
import org.apache.commons.httpclient.HttpClient;
Expand Down Expand Up @@ -59,6 +61,7 @@ protected GetMethod createRequest(String downloadUrl) {
GetMethod request = new GetMethod(downloadUrl);
request.getParams().setParameter(HttpMethodParams.RETRY_HANDLER, myretryhandler);
request.setFollowRedirects(followRedirects);
request.getParams().setParameter(HttpMethodParams.USER_AGENT, CLOUDSTACK_USER_AGENT);
if (!toFileSet) {
String[] parts = downloadUrl.split("/");
String filename = parts[parts.length - 1];
Expand Down
2 changes: 2 additions & 0 deletions core/src/main/java/com/cloud/storage/template/SimpleHttpMultiFileDownloader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
package com.cloud.storage.template;

import static com.cloud.utils.NumbersUtil.toHumanReadableSize;
import static org.apache.cloudstack.api.ApiConstants.CLOUDSTACK_USER_AGENT;

import java.io.File;
import java.io.IOException;
Expand Down Expand Up @@ -95,6 +96,7 @@ private GetMethod createRequest(String downloadUrl) {
GetMethod request = new GetMethod(downloadUrl);
request.getParams().setParameter(HttpMethodParams.RETRY_HANDLER, retryHandler);
request.setFollowRedirects(followRedirects);
request.getParams().setParameter(HttpMethodParams.USER_AGENT, CLOUDSTACK_USER_AGENT);
return request;
}

Expand Down
4 changes: 4 additions & 0 deletions core/src/main/java/org/apache/cloudstack/direct/download/HttpDirectTemplateDownloader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@

package org.apache.cloudstack.direct.download;

import static org.apache.cloudstack.api.ApiConstants.CLOUDSTACK_USER_AGENT;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
Expand All @@ -39,6 +41,7 @@
import org.apache.commons.httpclient.MultiThreadedHttpConnectionManager;
import org.apache.commons.httpclient.methods.GetMethod;
import org.apache.commons.httpclient.methods.HeadMethod;
import org.apache.commons.httpclient.params.HttpMethodParams;
import org.apache.commons.io.IOUtils;

public class HttpDirectTemplateDownloader extends DirectTemplateDownloaderImpl {
Expand Down Expand Up @@ -68,6 +71,7 @@ public HttpDirectTemplateDownloader(String url, Long templateId, String destPool
protected GetMethod createRequest(String downloadUrl, Map<String, String> headers) {
GetMethod request = new GetMethod(downloadUrl);
request.setFollowRedirects(this.isFollowRedirects());
request.getParams().setParameter(HttpMethodParams.USER_AGENT, CLOUDSTACK_USER_AGENT);
if (MapUtils.isNotEmpty(headers)) {
for (String key : headers.keySet()) {
request.setRequestHeader(key, headers.get(key));
Expand Down
Loading