com.liulishuo.filedownloader.util

Class FileDownloadUtils

java.lang.Object

com.liulishuo.filedownloader.util.FileDownloadUtils

public class FileDownloadUtils
extends java.lang.Object

The utils for FileDownloader.

Constructor Summary

Constructors

Constructor and Description
FileDownloadUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	checkPermission(java.lang.String permission)
static long	convertContentLengthString(java.lang.String s)
static java.lang.String[]	convertHeaderString(java.lang.String nameAndValuesString)
static FileDownloadOutputStream	createOutputStream(java.lang.String path)
static java.lang.String	defaultUserAgent()
static void	deleteTargetFile(java.lang.String targetFilePath)
static void	deleteTaskFiles(java.lang.String targetFilepath, java.lang.String tempFilePath)
static void	deleteTempFile(java.lang.String tempFilePath)
static long	findContentLength(int id, FileDownloadConnection connection)
static long	findContentLengthFromContentRange(FileDownloadConnection connection)
static java.lang.String	findEtag(int id, FileDownloadConnection connection)
static java.lang.String	findFilename(FileDownloadConnection connection, java.lang.String url)
static long	findInstanceLengthForTrial(FileDownloadConnection connection)
static long	findInstanceLengthFromContentRange(FileDownloadConnection connection)
static java.lang.String	formatString(java.lang.String msg, java.lang.Object... args)
static java.lang.String	generateFileName(java.lang.String url)
static java.lang.String	generateFilePath(java.lang.String directory, java.lang.String filename)
static int	generateId(java.lang.String url, java.lang.String path)
static int	generateId(java.lang.String url, java.lang.String path, boolean pathAsDirectory)
static java.io.File	getConvertedMarkedFile(android.content.Context context)
static java.lang.String	getDefaultSaveFilePath(java.lang.String url)
static java.lang.String	getDefaultSaveRootPath()
static long	getFreeSpaceBytes(java.lang.String path)
static int	getMinProgressStep()
static long	getMinProgressTime()
static java.lang.String	getParent(java.lang.String path) The same to File.getParent(), for non-creating a file object.
static java.lang.String	getStack()
static java.lang.String	getStack(boolean printLine)
static java.lang.String	getStack(java.lang.StackTraceElement[] stackTrace, boolean printLine)
static java.lang.String	getTargetFilePath(java.lang.String path, boolean pathAsDirectory, java.lang.String filename)
static java.lang.String	getTempPath(java.lang.String targetPath)
static java.lang.String	getThreadPoolName(java.lang.String name)
static boolean	isAcceptRange(int responseCode, FileDownloadConnection connection)
static boolean	isBreakpointAvailable(int id, FileDownloadModel model)
static boolean	isBreakpointAvailable(int id, FileDownloadModel model, java.lang.Boolean outputStreamSupportSeek)
static boolean	isBreakpointAvailable(int id, FileDownloadModel model, java.lang.String path, java.lang.Boolean outputStreamSupportSeek)
static boolean	isDownloaderProcess(android.content.Context context)
static boolean	isFilenameConverted(android.content.Context context)
static boolean	isFilenameValid(java.lang.String filename) Checks whether the filename looks legitimate.
static boolean	isNeedSync(long bytesDelta, long timestampDelta)
static boolean	isNetworkNotOnWifiType()
static void	markConverted(android.content.Context context)
static java.lang.String	md5(java.lang.String string)
static boolean	needMakeServiceForeground(android.content.Context context)
static java.lang.String	parseContentDisposition(java.lang.String contentDisposition) The same to com.android.providers.downloads.Helpers#parseContentDisposition.
static long	parseContentLengthFromContentRange(java.lang.String contentRange)
static long	parseContentRangeFoInstanceLength(java.lang.String contentRange)
static void	setDefaultSaveRootPath(java.lang.String path) The path is used as the default directory in the case of the task without set path.
static void	setMinProgressStep(int minProgressStep)
static void	setMinProgressTime(long minProgressTime)

Methods inherited from class java.lang.Object

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

Constructor Detail

FileDownloadUtils

public FileDownloadUtils()

Method Detail

setMinProgressStep

public static void setMinProgressStep(int minProgressStep)
                               throws java.lang.IllegalAccessException

Parameters:

minProgressStep - The minimum bytes interval in per step to sync to the file and the database.

Used for adjudging whether is time to sync the downloaded so far bytes to database and make sure sync the downloaded buffer to local file.

More smaller more frequently, then download more slowly, but will more safer in scene of the process is killed unexpected.

Default 65536, which follow the value in com.android.providers.downloads.Constants.

Throws:

java.lang.IllegalAccessException

See Also:

DownloadStatusCallback.onProgress(long), setMinProgressTime(long)

setMinProgressTime

public static void setMinProgressTime(long minProgressTime)
                               throws java.lang.IllegalAccessException

Parameters:

minProgressTime - The minimum millisecond interval in per time to sync to the file and the database.

Used for adjudging whether is time to sync the downloaded so far bytes to database and make sure sync the downloaded buffer to local file.

More smaller more frequently, then download more slowly, but will more safer in scene of the process is killed unexpected.

Default 2000, which follow the value in com.android.providers.downloads.Constants.

Throws:

java.lang.IllegalAccessException

See Also:

DownloadStatusCallback.onProgress(long), setMinProgressStep(int)

getMinProgressStep

public static int getMinProgressStep()

getMinProgressTime

public static long getMinProgressTime()

isFilenameValid

public static boolean isFilenameValid(java.lang.String filename)

Checks whether the filename looks legitimate.

getDefaultSaveRootPath

public static java.lang.String getDefaultSaveRootPath()

getDefaultSaveFilePath

public static java.lang.String getDefaultSaveFilePath(java.lang.String url)

generateFileName

public static java.lang.String generateFileName(java.lang.String url)

generateFilePath

public static java.lang.String generateFilePath(java.lang.String directory,
                                                java.lang.String filename)

See Also:

getTargetFilePath(String, boolean, String)

setDefaultSaveRootPath

public static void setDefaultSaveRootPath(java.lang.String path)

The path is used as the default directory in the case of the task without set path.

Parameters:

path - default root path for save download file.

See Also:

BaseDownloadTask.setPath(String, boolean)

getTempPath

public static java.lang.String getTempPath(java.lang.String targetPath)

Parameters:

targetPath - The target path for the download task.

Returns:

The temp path is targetPath in downloading status; The temp path is used for storing the file not completed downloaded yet.

generateId

public static int generateId(java.lang.String url,
                             java.lang.String path)

Parameters:

url - The downloading URL.

path - The absolute file path.

Returns:

The download id.

generateId

public static int generateId(java.lang.String url,
                             java.lang.String path,
                             boolean pathAsDirectory)

Parameters:

url - The downloading URL.

path - If pathAsDirectory is true, path would be the absolute directory to place the file; If pathAsDirectory is false, path would be the absolute file path.

Returns:

The download id.

md5

public static java.lang.String md5(java.lang.String string)

getStack

public static java.lang.String getStack()

getStack

public static java.lang.String getStack(boolean printLine)

getStack

public static java.lang.String getStack(java.lang.StackTraceElement[] stackTrace,
                                        boolean printLine)

isDownloaderProcess

public static boolean isDownloaderProcess(android.content.Context context)

Parameters:

context - the context

Returns:

true if the FileDownloadService is allowed to run on the current process, false otherwise.

convertHeaderString

public static java.lang.String[] convertHeaderString(java.lang.String nameAndValuesString)

getFreeSpaceBytes

public static long getFreeSpaceBytes(java.lang.String path)

formatString

public static java.lang.String formatString(java.lang.String msg,
                                            java.lang.Object... args)

markConverted

public static void markConverted(android.content.Context context)

isFilenameConverted

public static boolean isFilenameConverted(android.content.Context context)

Returns:

Whether has converted all files' name from 'filename'(in old architecture) to 'filename.temp', if it's in downloading state.

If true, You can check whether the file has completed downloading with File.exists() directly.

when FileDownloadService.onCreate() is invoked, This value will be assigned to true only once since you upgrade the filedownloader version to 0.3.3 or higher.

getConvertedMarkedFile

public static java.io.File getConvertedMarkedFile(android.content.Context context)

parseContentRangeFoInstanceLength

public static long parseContentRangeFoInstanceLength(java.lang.String contentRange)

parseContentDisposition

public static java.lang.String parseContentDisposition(java.lang.String contentDisposition)

The same to com.android.providers.downloads.Helpers#parseContentDisposition.

Parse the Content-Disposition HTTP Header. The format of the header is defined here: http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html This header provides a filename for content that is going to be downloaded to the file system. We only support the attachment type.

getTargetFilePath

public static java.lang.String getTargetFilePath(java.lang.String path,
                                                 boolean pathAsDirectory,
                                                 java.lang.String filename)

Parameters:

path - If pathAsDirectory is true, the path would be the absolute directory to settle down the file; If pathAsDirectory is false, the path would be the absolute file path.

pathAsDirectory - whether the path is a directory.

filename - the file's name.

Returns:

the absolute path of the file. If can't find by params, will return null.

getParent

public static java.lang.String getParent(java.lang.String path)

The same to File.getParent(), for non-creating a file object.

Returns:

this file's parent pathname or null.

getThreadPoolName

public static java.lang.String getThreadPoolName(java.lang.String name)

isNetworkNotOnWifiType

public static boolean isNetworkNotOnWifiType()

checkPermission

public static boolean checkPermission(java.lang.String permission)

convertContentLengthString

public static long convertContentLengthString(java.lang.String s)

findEtag

public static java.lang.String findEtag(int id,
                                        FileDownloadConnection connection)

isAcceptRange

public static boolean isAcceptRange(int responseCode,
                                    FileDownloadConnection connection)

findInstanceLengthForTrial

public static long findInstanceLengthForTrial(FileDownloadConnection connection)

findInstanceLengthFromContentRange

public static long findInstanceLengthFromContentRange(FileDownloadConnection connection)

findContentLength

public static long findContentLength(int id,
                                     FileDownloadConnection connection)

findContentLengthFromContentRange

public static long findContentLengthFromContentRange(FileDownloadConnection connection)

parseContentLengthFromContentRange

public static long parseContentLengthFromContentRange(java.lang.String contentRange)

findFilename

public static java.lang.String findFilename(FileDownloadConnection connection,
                                            java.lang.String url)
                                     throws FileDownloadSecurityException

Throws:

FileDownloadSecurityException

createOutputStream

public static FileDownloadOutputStream createOutputStream(java.lang.String path)
                                                   throws java.io.IOException

Throws:

java.io.IOException

isBreakpointAvailable

public static boolean isBreakpointAvailable(int id,
                                            FileDownloadModel model)

isBreakpointAvailable

public static boolean isBreakpointAvailable(int id,
                                            FileDownloadModel model,
                                            java.lang.Boolean outputStreamSupportSeek)

Returns:

can resume by break point

isBreakpointAvailable

public static boolean isBreakpointAvailable(int id,
                                            FileDownloadModel model,
                                            java.lang.String path,
                                            java.lang.Boolean outputStreamSupportSeek)

deleteTaskFiles

public static void deleteTaskFiles(java.lang.String targetFilepath,
                                   java.lang.String tempFilePath)

deleteTempFile

public static void deleteTempFile(java.lang.String tempFilePath)

deleteTargetFile

public static void deleteTargetFile(java.lang.String targetFilePath)

isNeedSync

public static boolean isNeedSync(long bytesDelta,
                                 long timestampDelta)

defaultUserAgent

public static java.lang.String defaultUserAgent()

needMakeServiceForeground

public static boolean needMakeServiceForeground(android.content.Context context)