jetbrains.buildServer.web

Interface WebAccessHelper

public interface WebAccessHelper

The helper interface for providing additional information to the WebAccessService.

If the particular method returns null, the default implementation is used.

Since:

6.0

Author:

Maxim Podkolzine (maxim.podkolzine@jetbrains.com)

See Also:

WebAccessService

Method Summary

Modifier and Type	Method and Description
boolean	allowDownloadZip() Returns whether downloading all files in zip is allowed.
java.lang.String	getDesiredId() Returns the desired id (would be used in UI).
default java.lang.String	getEncoding(java.io.File file) Returns passed file assumed encoding
java.lang.String	getFileNameForZip() Returns the zip file name.

Method Detail

getDesiredId

@Nullable
java.lang.String getDesiredId()

Returns the desired id (would be used in UI).

Returns:

desired id, or null

allowDownloadZip

boolean allowDownloadZip()

Returns whether downloading all files in zip is allowed.

Returns:

true iff downloading all files in zip is allowed

getFileNameForZip

@Nullable
java.lang.String getFileNameForZip()

Returns the zip file name.

Returns:

zip file name, or null

getEncoding

@Nullable
default java.lang.String getEncoding(@NotNull
                                               java.io.File file)

Returns passed file assumed encoding

Parameters:

file - file to get encoding

Returns:

encoding or null if it is not possible to get it