Package jetbrains.buildServer.controllers

Class HttpDownloadProcessor

java.lang.Object

jetbrains.buildServer.controllers.HttpDownloadProcessor

public class HttpDownloadProcessor
extends Object

Processes file download request

Since:

5.1

Author:

Eugene Petrenko, Maxim Manuylov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HttpDownloadProcessor.FileInfo

Constructor Summary

Constructors

Constructor	Description
HttpDownloadProcessor(DigestCalculator digestCalculator, ExtensionsProvider extensionsProvider, DomainIsolationProtection domainIsolationProtection)

Method Summary

Modifier and Type	Method	Description
org.springframework.web.servlet.ModelAndView	processArtifactDownload(SBuild build, BuildArtifact artifact, boolean setContentDisposition, String forcedETagContent, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Processes request to download content of the specified build's artifact and writes the response.
org.springframework.web.servlet.ModelAndView	processArtifactDownload(SBuild build, BuildArtifact artifact, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	performs all necessary operations to send build artifact contents into response.
org.springframework.web.servlet.ModelAndView	processDownload(HttpDownloadProcessor.FileInfo info, boolean contentDisposition, boolean restrictMimeTypes, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.springframework.web.servlet.ModelAndView	processDownload(HttpDownloadProcessor.FileInfo info, boolean contentDisposition, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Deprecated. Use processDownload(FileInfo, boolean, boolean, HttpServletRequest, HttpServletResponse) instead
org.springframework.web.servlet.ModelAndView	processFileDownload(File file, boolean contentDisposition, boolean restrictMimeTypes, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Counter loadMetric)	performs all necessary operations to send file contents into response.
org.springframework.web.servlet.ModelAndView	processFileDownload(File file, boolean contentDisposition, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ServerLoadMetrics metrics)	Deprecated. Use processFileDownload(File, boolean, boolean, HttpServletRequest, HttpServletResponse, Counter) instead
org.springframework.web.servlet.ModelAndView	processFileDownload(File file, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Deprecated. Use processFileDownload(File, boolean, boolean, HttpServletRequest, HttpServletResponse, Counter) instead

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpDownloadProcessor

public HttpDownloadProcessor(@NotNull
                             DigestCalculator digestCalculator,
                             @NotNull
                             ExtensionsProvider extensionsProvider,
                             @NotNull
                             DomainIsolationProtection domainIsolationProtection)

Method Detail

processFileDownload

@Nullable
@Deprecated
public org.springframework.web.servlet.ModelAndView processFileDownload(@NotNull
                                                                        File file,
                                                                        @NotNull
                                                                        javax.servlet.http.HttpServletRequest request,
                                                                        @NotNull
                                                                        javax.servlet.http.HttpServletResponse response)
                                                                 throws IOException

Deprecated.

Use processFileDownload(File, boolean, boolean, HttpServletRequest, HttpServletResponse, Counter) instead

performs all necessary operations to send file contents into response.

Parameters:

file - file to send

request - original request

response - response

Returns:

spring model and view to return from controller

Throws:

IOException - on response or file IO errors

processFileDownload

@Nullable
@Deprecated
public org.springframework.web.servlet.ModelAndView processFileDownload(@NotNull
                                                                        File file,
                                                                        boolean contentDisposition,
                                                                        @NotNull
                                                                        javax.servlet.http.HttpServletRequest request,
                                                                        @NotNull
                                                                        javax.servlet.http.HttpServletResponse response,
                                                                        @Nullable
                                                                        ServerLoadMetrics metrics)
                                                                 throws IOException

Deprecated.

Use processFileDownload(File, boolean, boolean, HttpServletRequest, HttpServletResponse, Counter) instead

This method is used in StaticUIExtensions, StaticPageContentController. Left here for compatibility

Throws:

IOException

processFileDownload

@Nullable
public org.springframework.web.servlet.ModelAndView processFileDownload(@NotNull
                                                                        File file,
                                                                        boolean contentDisposition,
                                                                        boolean restrictMimeTypes,
                                                                        @NotNull
                                                                        javax.servlet.http.HttpServletRequest request,
                                                                        @NotNull
                                                                        javax.servlet.http.HttpServletResponse response,
                                                                        @Nullable
                                                                        Counter loadMetric)
                                                                 throws IOException

performs all necessary operations to send file contents into response.

Parameters:

file - file to send

request - original request

response - response

contentDisposition - whether Content-Disposition header should be set or not

restrictMimeTypes - 'false' to use all known mime types (should only be used for serving files coming from trusted sources), 'true' to select from "text/plain" : "application/octet-stream"

Returns:

spring model and view to return from controller

Throws:

IOException - on response or file IO errors

processArtifactDownload

@Nullable
public org.springframework.web.servlet.ModelAndView processArtifactDownload(@NotNull
                                                                            SBuild build,
                                                                            @NotNull
                                                                            BuildArtifact artifact,
                                                                            @NotNull
                                                                            javax.servlet.http.HttpServletRequest request,
                                                                            @NotNull
                                                                            javax.servlet.http.HttpServletResponse response)
                                                                     throws IOException

performs all necessary operations to send build artifact contents into response.

Parameters:

artifact - file to send

request - original request

response - response

Returns:

spring model and view to return from controller

Throws:

IOException - on response or file IO errors

processArtifactDownload

@Nullable
public org.springframework.web.servlet.ModelAndView processArtifactDownload(@NotNull
                                                                            SBuild build,
                                                                            @NotNull
                                                                            BuildArtifact artifact,
                                                                            boolean setContentDisposition,
                                                                            @Nullable
                                                                            String forcedETagContent,
                                                                            @NotNull
                                                                            javax.servlet.http.HttpServletRequest request,
                                                                            @NotNull
                                                                            javax.servlet.http.HttpServletResponse response)
                                                                     throws IOException

Processes request to download content of the specified build's artifact and writes the response.

Parameters:

build - build to serve artifact form

artifact - build's artifact to serve

setContentDisposition - if "true", "Content-Disposition" header will be set

forcedETagContent - if set, the value of the strong ETag to use. If null, default ETag calculation will be used

request - original request

response - response

Returns:

spring model and view to return from controller

Throws:

IOException - on response or file IO errors

Since:

2017.1

processDownload

@Deprecated
public org.springframework.web.servlet.ModelAndView processDownload(@NotNull
                                                                    HttpDownloadProcessor.FileInfo info,
                                                                    boolean contentDisposition,
                                                                    @NotNull
                                                                    javax.servlet.http.HttpServletRequest request,
                                                                    @NotNull
                                                                    javax.servlet.http.HttpServletResponse response)
                                                             throws IOException

Deprecated.

Use processDownload(FileInfo, boolean, boolean, HttpServletRequest, HttpServletResponse) instead

Throws:

IOException

processDownload

public org.springframework.web.servlet.ModelAndView processDownload(@NotNull
                                                                    HttpDownloadProcessor.FileInfo info,
                                                                    boolean contentDisposition,
                                                                    boolean restrictMimeTypes,
                                                                    @NotNull
                                                                    javax.servlet.http.HttpServletRequest request,
                                                                    @NotNull
                                                                    javax.servlet.http.HttpServletResponse response)
                                                             throws IOException

Parameters:

restrictMimeTypes - 'false' to use all known mime types (should only be used for serving files coming from trusted sources), 'true' to select from "text/plain" : "application/octet-stream"

Throws:

IOException