Package org.opencms.ui.apps.logfile
Interface I_CmsLogDownloadProvider
-
- All Known Implementing Classes:
CmsDefaultLogDownloadProvider
public interface I_CmsLogDownloadProvider
Provides log file download functionality.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
canDownloadAllLogs()
Checks if the user can download a zip with all logs.java.lang.String
getDownloadPrefix()
Gets the prefix to use for the download file name.java.util.Set<java.lang.String>
getLogFiles()
Gets the set of log file paths.java.io.InputStream
readAllLogs()
Gets the input stream for the download with all logs (only works if canDownloadAllLogs() returned true)java.io.InputStream
readLog(java.lang.String path)
Gets the input stream for the download of a single log file
-
-
-
Method Detail
-
canDownloadAllLogs
boolean canDownloadAllLogs()
Checks if the user can download a zip with all logs.- Returns:
- true if the user can download a zip with all logs
-
getDownloadPrefix
java.lang.String getDownloadPrefix()
Gets the prefix to use for the download file name.- Returns:
- the prefix for the download
-
getLogFiles
java.util.Set<java.lang.String> getLogFiles()
Gets the set of log file paths.- Returns:
- the set of log file paths
-
readAllLogs
java.io.InputStream readAllLogs()
Gets the input stream for the download with all logs (only works if canDownloadAllLogs() returned true)- Returns:
- the input stream for the collected logs zip file
-
readLog
java.io.InputStream readLog(java.lang.String path)
Gets the input stream for the download of a single log file- Parameters:
path
- the full path of the log file (must be a value in the set returned by getLogFiles())- Returns:
- the input stream for the download
-
-