LocalUWSFileManager

java.lang.Object
- uws.service.file.LocalUWSFileManager

All Implemented Interfaces:

UWSFileManager
```
public class LocalUWSFileManager
extends java.lang.Object
implements UWSFileManager
```
All UWS files are stored in the local machine into the specified directory.
The name of the log file, the result files and the backup files may be customised by overriding the following functions: getLogFileName(uws.service.log.UWSLog.LogLevel, String), getResultFileName(Result, UWSJob), getBackupFileName(JobOwner) and getBackupFileName().

By default, results and backups are grouped by owner/user and owners/users are grouped thanks to DefaultOwnerGroupIdentifier. By using the appropriate constructor, you can change these default behaviours.

A log file rotation is set by default so that avoiding a too big log file after several months/years of use. By default the rotation is done every month on the 1st at 6am. This frequency can be changed easily thanks to the function setLogRotationFreq(String).

Version:

4.4 (08/2018)

Author:

Grégory Mantelet (CDS;ARI)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`LocalUWSFileManager.DirectoryFilter` Filter which lets returning only the directories.
`protected class`	`LocalUWSFileManager.LocalAllUserBackupInputs` Lets iterating on all user backup files.
`protected class`	`LocalUWSFileManager.OwnerFileFilter` Filter which lets returning only the backup file(s) of the specified user/owner.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static java.lang.String`	`DEFAULT_BACKUP_FILE_NAME` Default name of the general UWS backup file.
`protected static java.lang.String`	`DEFAULT_LOG_FILE_NAME` Default name of the log file.
`protected boolean`	`groupUserDirectories` Gather user directories, set by set.
`protected java.io.PrintWriter`	`logOutput` Output toward the service log file.
`protected EventFrequency`	`logRotation` Frequency at which the log file must be "rotated" (the file is renamed with the date of its first write and a new log file is created).
`protected boolean`	`oneDirectoryForEachUser` Indicate whether a directory must be used to gather all jobs, results and errors related to one identified user.
`protected OwnerGroupIdentifier`	`ownerGroupId` Object giving the policy about how to group user directories.
`protected java.io.File`	`rootDirectory` Directory in which all files managed by this class will be written and read.
`protected java.io.File`	`tmpDirectory` Directory in which temporary files (e.g.

Fields inherited from interface uws.service.file.UWSFileManager
TMP_UPLOAD_DIR

Constructor Summary

Constructors
Constructor and Description
`LocalUWSFileManager(java.io.File root)` Builds a `UWSFileManager` which manages all UWS files in the given directory.
`LocalUWSFileManager(java.io.File root, boolean oneDirectoryForEachUser, boolean groupUserDirectories)` Builds a `UWSFileManager` which manages all UWS files in the given directory.
`LocalUWSFileManager(java.io.File root, boolean oneDirectoryForEachUser, boolean groupUserDirectories, OwnerGroupIdentifier ownerGroupIdentifier)` Builds a `UWSFileManager` which manages all UWS files in the given directory.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`cleanOwnerDirectory(JobOwner owner)` Removes the owner directory if there is no more file in it (except the backup file which is no more required).
`protected boolean`	`createParentDir(java.io.File f)` Creates the parent directory(ies) if it(they) does/do not exist.
`boolean`	`deleteError(ErrorSummary error, UWSJob job)` Deletes the error file corresponding to the given job error summary.
`boolean`	`deleteResult(Result result, UWSJob job)` Deletes the result file corresponding to the given job result's description.
`void`	`deleteUpload(UploadFile upload)` Delete definitely the specified file, submitted inline in an HTTP request.
`java.util.Iterator<java.io.InputStream>`	`getAllUserBackupInputs()` Gets an input stream on the backup file of ALL the job owners (~ UWS user).
`protected java.lang.String`	`getBackupFileName()` Gets the name of the UWS general backup file.
`protected java.lang.String`	`getBackupFileName(JobOwner owner)` Gets the name of the backup file of the given job owner (~ UWS user).
`java.io.InputStream`	`getBackupInput()` Gets an input stream on the backup file of the whole UWS.
`java.io.InputStream`	`getBackupInput(JobOwner owner)` Gets an input stream on the backup file of ONLY the given job owner (~ UWS user).
`java.io.OutputStream`	`getBackupOutput()` Gets an output stream on the backup file of the whole UWS.
`java.io.OutputStream`	`getBackupOutput(JobOwner owner)` Gets an output stream on the backup file of ONLY the given job owner (~ UWS user).
`protected java.io.File`	`getErrorFile(ErrorSummary error, UWSJob job)` Gets the file corresponding to the described error.
`protected java.lang.String`	`getErrorFileName(ErrorSummary error, UWSJob job)` Gets the name of the file in which the described error is/must be written.
`java.io.InputStream`	`getErrorInput(ErrorSummary error, UWSJob job)` Gets an input stream on the error file corresponding to the given error and job.
`java.io.OutputStream`	`getErrorOutput(ErrorSummary error, UWSJob job)` Gets an output stream on the error file corresponding to the given error and job.
`long`	`getErrorSize(ErrorSummary error, UWSJob job)` Gets the size of the specified error summary file.
`protected java.io.File`	`getFile(UploadFile upload)` Create a File instance from the given upload file description.
`protected java.io.File`	`getLogFile(UWSLog.LogLevel level, java.lang.String context)` Gets the UWS log file.
`protected java.lang.String`	`getLogFileName(UWSLog.LogLevel level, java.lang.String context)` Gets the name of the UWS log file.
`java.io.InputStream`	`getLogInput(UWSLog.LogLevel level, java.lang.String context)` Gets an input stream on the log file of this UWS.
`java.io.PrintWriter`	`getLogOutput(UWSLog.LogLevel level, java.lang.String context)` Gets an output stream on the log file of this UWS.
`java.lang.String`	`getLogRotationFreq()` Get the frequency of the log file rotation in a human readable way.
`java.io.File`	`getOwnerDirectory(JobOwner owner)` Gets the directory of the given owner.
`protected java.io.File`	`getResultFile(Result result, UWSJob job)` Gets the file corresponding to the given result.
`protected java.lang.String`	`getResultFileName(Result result, UWSJob job)` Gets the name of the file in which the given result is/must be written.
`java.io.InputStream`	`getResultInput(Result result, UWSJob job)` Gets an input stream on the result file corresponding to the given job result.
`java.io.OutputStream`	`getResultOutput(Result result, UWSJob job)` Gets an output stream on the result file corresponding to the given job result.
`long`	`getResultSize(Result result, UWSJob job)` Gets the size of the specified result file.
`java.io.File`	`getTmpDirectory()` Get the temporary directory to use in this service.
`java.io.InputStream`	`getUploadInput(UploadFile upload)` Open a stream toward the specified file, submitted inline in an HTTP request.
`java.lang.String`	`moveUpload(UploadFile upload, UWSJob destination)` Move the specified file from its current location to a location related to the given job.
`java.io.InputStream`	`openURI(java.net.URI uri)` Open a stream toward the given URI.
`protected void`	`printLogHeader(java.io.PrintWriter out)` Print a header into the log file so that separating older log messages to the new ones.
`void`	`setLogRotationFreq(java.lang.String interval)` Set the frequency at which a rotation of the log file must be done.
`boolean`	`setTmpDirectory(java.io.File newTmpDir)` Set the temporary directory to use in this service.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_LOG_FILE_NAME
```
protected static final java.lang.String DEFAULT_LOG_FILE_NAME
```
    Default name of the log file.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BACKUP_FILE_NAME
```
protected static final java.lang.String DEFAULT_BACKUP_FILE_NAME
```
    Default name of the general UWS backup file.
    
    See Also:
    
    Constant Field Values
  - rootDirectory
```
protected final java.io.File rootDirectory
```
    Directory in which all files managed by this class will be written and read.
  - tmpDirectory
```
protected java.io.File tmpDirectory
```
    Directory in which temporary files (e.g. uploads) should be stored.
    
    Since:
    
    4.4
  - logOutput
```
protected java.io.PrintWriter logOutput
```
    Output toward the service log file.
  - logRotation
```
protected EventFrequency logRotation
```
    Frequency at which the log file must be "rotated" (the file is renamed with the date of its first write and a new log file is created). Thus, too big log files can be avoided.
  - oneDirectoryForEachUser
```
protected final boolean oneDirectoryForEachUser
```
    Indicate whether a directory must be used to gather all jobs, results and errors related to one identified user. If FALSE, all jobs, results and errors will be in only one directory, whoever owns them.
  - groupUserDirectories
```
protected final boolean groupUserDirectories
```
    Gather user directories, set by set. At the end, several user group directories may be created. This option is considered only if oneDirectoryForEachUser is TRUE.
  - ownerGroupId
```
protected final OwnerGroupIdentifier ownerGroupId
```
    Object giving the policy about how to group user directories.
- Constructor Detail
  - LocalUWSFileManager
```
public LocalUWSFileManager(java.io.File root)
                    throws UWSException
```
    Builds a UWSFileManager which manages all UWS files in the given directory.
    
    There will be one directory for each owner ID and owner directories will be grouped thanks to DefaultOwnerGroupIdentifier.
    
    Parameters:
    
    root - UWS root directory.
    
    Throws:
    
    java.lang.NullPointerException - If the given root directory is null.
    
    UWSException - If the given file is not a directory or has not the READ and WRITE permissions.
    
    See Also:
    
    LocalUWSFileManager(File, boolean, boolean, OwnerGroupIdentifier)
  - LocalUWSFileManager
```
public LocalUWSFileManager(java.io.File root,
                           boolean oneDirectoryForEachUser,
                           boolean groupUserDirectories)
                    throws UWSException
```
    Builds a UWSFileManager which manages all UWS files in the given directory.
    
    If, according to the third parameter, the owner directories must be grouped, the DefaultOwnerGroupIdentifier will be used.
    
    Parameters:
    
    root - UWS root directory.
    
    oneDirectoryForEachUser - true to create one directory for each owner ID, false otherwise.
    
    groupUserDirectories - true to group user directories, false otherwise. note: this value is ignored if the previous parameter is false.
    
    Throws:
    
    java.lang.NullPointerException - If the given root directory is null.
    
    UWSException - If the given file is not a directory or has not the READ and WRITE permissions.
    
    See Also:
    
    LocalUWSFileManager(File, boolean, boolean, OwnerGroupIdentifier)
  - LocalUWSFileManager
```
public LocalUWSFileManager(java.io.File root,
                           boolean oneDirectoryForEachUser,
                           boolean groupUserDirectories,
                           OwnerGroupIdentifier ownerGroupIdentifier)
                    throws UWSException
```
    Builds a UWSFileManager which manages all UWS files in the given directory.
    Parameters:
    
    root - UWS root directory.
    
    oneDirectoryForEachUser - true to create one directory for each owner ID, false otherwise.
    
    groupUserDirectories - true to group user directories, false otherwise. note: this value is ignored if the previous parameter is false.
    ownerGroupIdentifier - The "function" to use to identify the group of a job owner.
    note 1: this value is ignored if one of the two previous parameters is false.
    
    note 2: if this value is null but the previous parameters are true, DefaultOwnerGroupIdentifier will be chosen as default group identifier.
    Throws:
    
    java.lang.NullPointerException - If the given root directory is null.
    
    UWSException - If the given file is not a directory or has not the READ and WRITE permissions.
- Method Detail
  - getOwnerDirectory
```
public java.io.File getOwnerDirectory(JobOwner owner)
```
    Gets the directory of the given owner.
    
    Parameters:
    
    owner - A job owner.
    
    Returns:
    
    Its directory.
  - cleanOwnerDirectory
```
protected void cleanOwnerDirectory(JobOwner owner)
                            throws java.io.IOException
```
    Removes the owner directory if there is no more file in it (except the backup file which is no more required).
    
    Parameters:
    
    owner - The user whose the directory must be removed.
    
    Throws:
    
    java.io.IOException - If there is an error while removing the owner directory.
  - getLogRotationFreq
```
public final java.lang.String getLogRotationFreq()
```
    Get the frequency of the log file rotation in a human readable way.
    
    Returns:
    
    A human readable frequency of the log file rotation.
  - setLogRotationFreq
```
public final void setLogRotationFreq(java.lang.String interval)
```
    Set the frequency at which a rotation of the log file must be done.
    
    "rotation" means here, to close the currently used log file, to rename it so that suffixing it with the date at which the first log has been written in it, and to create a new log file.
    
    The frequency string must respect the following syntax:
    - 'D' hh mm : daily schedule at hh:mm
    - 'W' dd hh mm : weekly schedule at the given day of the week (1:sunday, 2:monday, ..., 7:saturday) at hh:mm
    - 'M' dd hh mm : monthly schedule at the given day of the month at hh:mm
    - 'h' mm : hourly schedule at the given minute
    - 'm' : scheduled every minute (for completness :-))
    Where: hh = integer between 0 and 23, mm = integer between 0 and 59, dd (for 'W') = integer between 1 and 7 (1:sunday, 2:monday, ..., 7:saturday), dd (for 'M') = integer between 1 and 31.
    
    Warning: The frequency type is case sensitive! Then you should particularly pay attention at the case when using the frequency types 'M' (monthly) and 'm' (every minute).
    
    Parsing errors are not thrown but "resolved" silently. The "solution" depends of the error. 2 cases of errors are considered:
    
    Frequency type mismatch: It happens when the first character is not one of the expected (D, W, M, h, m). That means: bad case (i.e. 'd' rather than 'D'), another character. In this case, the frequency will be: daily at 00:00.
    
    Parameter(s) missing or incorrect: With the "daily" frequency ('D'), at least 2 parameters must be provided ; 3 for "weekly" ('W') and "monthly" ('M') ; only 1 for "hourly" ('h') ; none for "every minute" ('m'). This number of parameters is a minimum: only the n first parameters will be considered while the others will be ignored. If this minimum number of parameters is not respected or if a parameter value is incorrect, all parameters will be set to their default value (which is 0 for all parameter except dd for which it is 1).
    
    Examples:
    
    "" or NULL = every day at 00:00
    
    "D 06 30" or "D 6 30" = every day at 06:30
    
    "D 24 30" = every day at 00:00, because hh must respect the rule: 0 ≤ hh ≤ 23
    
    "d 06 30" or "T 06 30" = every day at 00:00, because the frequency type "d" (lower case of "D") or "T" do not exist
    
    "W 2 6 30" = every week on Tuesday at 06:30
    
    "W 8 06 30" = every week on Sunday at 00:00, because with 'W' dd must respect the rule: 1 ≤ dd ≤ 7
    
    "M 2 6 30" = every month on the 2nd at 06:30
    
    "M 32 6 30" = every month on the 1st at 00:00, because with 'M' dd must respect the rule: 1 ≤ dd ≤ 31
    
    "M 5 6 30 12" = every month on the 5th at 06:30, because at least 3 parameters are expected and so considered: "12" and eventual other parameters are ignored
    Parameters:
    
    interval - Interval between two log rotations.
  getLogFileName
  
  protected java.lang.String getLogFileName(UWSLog.LogLevel level, java.lang.String context)
  
  Gets the name of the UWS log file.
  
  By default: DEFAULT_LOG_FILE_NAME.
  
  Parameters:
  
  level - Level of the message to log (DEBUG, INFO, WARNING, ERROR, FATAL).
  
  context - Context of the message to log (UWS, HTTP, THREAD, JOB, ...).
  
  Returns:
  
  The name of the UWS log file.
  
  getLogFile
  
  protected java.io.File getLogFile(UWSLog.LogLevel level, java.lang.String context)
  
  Gets the UWS log file.
  
  Parameters:
  
  level - Level of the message to log (DEBUG, INFO, WARNING, ERROR, FATAL).
  
  context - Context of the message to log (UWS, HTTP, THREAD, JOB, ...).
  
  Returns:
  
  The UWS log file.
  
  See Also:
  
  getLogFileName(uws.service.log.UWSLog.LogLevel, String)
  
  getLogInput
  
  public java.io.InputStream getLogInput(UWSLog.LogLevel level, java.lang.String context) throws java.io.IOException
  
  Description copied from interface: UWSFileManager
  
  Gets an input stream on the log file of this UWS.
  
  Specified by:
  
  getLogInput in interface UWSFileManager
  
  Parameters:
  
  level - Level of the message to log (DEBUG, INFO, WARNING, ERROR or FATAL).
  
  context - Context of the message to log (UWS, HTTP, JOB, THREAD, ...).
  
  Returns:
  
  An input on the log file or null if there is no log file.
  
  Throws:
  
  java.io.IOException - If there is an error while opening an input stream on the log file.
  
  getLogOutput
  
  public java.io.PrintWriter getLogOutput(UWSLog.LogLevel level, java.lang.String context) throws java.io.IOException
  
  Description copied from interface: UWSFileManager
  
  Gets an output stream on the log file of this UWS.
  Note: The log file must be automatically created if needed.
  
  Specified by:
  
  getLogOutput in interface UWSFileManager
  
  Parameters:
  
  level - Level of the message to log (DEBUG, INFO, WARNING, ERROR or FATAL).
  
  context - Context of the message to log (UWS, HTTP, JOB, THREAD, ...).
  
  Returns:
  
  An output on the log file.
  
  Throws:
  
  java.io.IOException - If there is an error while creating the log file or while opening an output stream on it.
  
  printLogHeader
  
  protected void printLogHeader(java.io.PrintWriter out)
  
  Print a header into the log file so that separating older log messages to the new ones.
  
  getFile
  
  protected final java.io.File getFile(UploadFile upload)
  
  Create a File instance from the given upload file description. This function is able to deal with location as URI and as file path.
  
  Parameters:
  
  upload - Description of an uploaded file.
  
  Returns:
  
  The corresponding File object.
  
  Since:
  
  4.1
  
  getTmpDirectory
  
  public java.io.File getTmpDirectory()
  
  Description copied from interface: UWSFileManager
  
  Get the temporary directory to use in this service.
  Note: This directory is generally used when files are uploaded in a received HTTP request.
  
  Important: As qualified above, this directory is temporary. It means that it should be sometimes emptied. It is particularly important because when a delete or move operation fails on a files, no log or error might be published and the files would take some space for no more reason.
  
  Specified by:
  
  getTmpDirectory in interface UWSFileManager
  
  Returns:
  
  The temporary directory to use. Never null.
  
  setTmpDirectory
  
  public boolean setTmpDirectory(java.io.File newTmpDir)
  
  Description copied from interface: UWSFileManager
  
  Set the temporary directory to use in this service.
  Note: This directory is generally used when files are uploaded in a received HTTP request.
  
  Important: As qualified above, this directory is temporary. It means that it should be sometimes emptied. It is particularly important because when a delete or move operation fails on a files, no log or error might be published and the files would take some space for no more reason.
  
  Specified by:
  
  setTmpDirectory in interface UWSFileManager
  
  Parameters:
  
  newTmpDir - The new temporary directory to use.
  
  Returns:
  
  true if the path of the temporary directory has been successfully updated, false otherwise (e.g. null, not a directory, not writable, not readable).
  
  getUploadInput
  
  public java.io.InputStream getUploadInput(UploadFile upload) throws java.io.IOException
  
  Description copied from interface: UWSFileManager
  
  Open a stream toward the specified file, submitted inline in an HTTP request.
  
  Specified by:
  
  getUploadInput in interface UWSFileManager
  
  Parameters:
  
  upload - Description of the uploaded file.
  
  Returns:
  
  Input to the specified uploaded file.
  
  Throws:
  
  java.io.IOException - If any error occurs while opening the stream.
  
  openURI
  
  public java.io.InputStream openURI(java.net.URI uri) throws UnsupportedURIProtocolException, java.io.IOException
  
  Description copied from interface: UWSFileManager
  
  Open a stream toward the given URI.
  Most of the time, the given URI uses the protocol http, https or ftp, which makes the URI perfectly understandable by URL which is then able to open easily a stream (cf URL.openStream()). However, a different scheme/protocol could be used ; particularly VO ones like "ivo" and "vos". It is for these particular cases that this function has been designed: in order to provide an implementation supporting additional protocols.
  
  Specified by:
  
  openURI in interface UWSFileManager
  
  Parameters:
  
  uri - URI of any resource to read.
  
  Returns:
  
  Input to the specified resource.
  
  Throws:
  
  java.io.IOException - If another error occurs while opening the stream.
  
  UnsupportedURIProtocolException
  
  deleteUpload
  
  public void deleteUpload(UploadFile upload) throws java.io.IOException
  
  Description copied from interface: UWSFileManager
  
  Delete definitely the specified file, submitted inline in an HTTP request.
  
  Specified by:
  
  deleteUpload in interface UWSFileManager
  
  Parameters:
  
  upload - Description of the uploaded file.
  
  Throws:
  
  java.io.IOException - If any error occurs while deleting the file.
  
  moveUpload
  
  public java.lang.String moveUpload(UploadFile upload, UWSJob destination) throws java.io.IOException
  
  Description copied from interface: UWSFileManager
  
  Move the specified file from its current location to a location related to the given job.
  Note: This function is generally used only once: after the HTTP request parsing, when creating or updating a job and only if the action has been accepted.
  
  Important: This function might not be able to update the location inside the given UploadFile. For this reason, it is strongly recommended to not call directly this function, but to use UploadFile.move(UWSJob).
  
  Specified by:
  
  moveUpload in interface UWSFileManager
  
  Parameters:
  
  upload - Description of the uploaded file to move.
  
  destination - Job in which the uploaded file will be used.
  
  Returns:
  
  The new location of the uploaded file.
  
  Throws:
  
  java.io.IOException - If any error occurs while moving the file.
  
  getResultFileName
  
  protected java.lang.String getResultFileName(Result result, UWSJob job)
  
  Gets the name of the file in which the given result is/must be written.
  
  By default: jobID + "_" + resultID + "." + getFileExtension(resultMIMEType)
  
  note: there is no file extension if the MIME type of the result is unknown !
  
  Parameters:
  
  result - The result whose the file name is asked.
  
  job - The job which owns the given result.
  
  Returns:
  
  Name of the file corresponding to the given result.
  
  See Also:
  
  UWSToolBox.getFileExtension(String)
  
  getResultFile
  
  protected java.io.File getResultFile(Result result, UWSJob job)
  
  Gets the file corresponding to the given result.
  
  Parameters:
  
  result - The result whose the file is asked.
  
  job - The job which owns the given result.
  
  Returns:
  
  The file corresponding to the given result.
  
  See Also:
  
  getOwnerDirectory(JobOwner), getResultFileName(Result, UWSJob)
  
  getResultInput
  
  public java.io.InputStream getResultInput(Result result, UWSJob job) throws java.io.IOException
  
  Description copied from interface: UWSFileManager
  
  Gets an input stream on the result file corresponding to the given job result.
  
  Specified by:
  
  getResultInput in interface UWSFileManager
  
  Parameters:
  
  result - The description of the result file to read.
  
  job - The job of the given result.
  
  Returns:
  
  An input of the corresponding result file or null if there is no result file.
  
  Throws:
  
  java.io.IOException - If there is an error while opening an input stream on the result file.
  
  getResultOutput
  
  public java.io.OutputStream getResultOutput(Result result, UWSJob job) throws java.io.IOException
  
  Description copied from interface: UWSFileManager
  
  Gets an output stream on the result file corresponding to the given job result.
  Note: The result file must be automatically created if needed.
  
  Specified by:
  
  getResultOutput in interface UWSFileManager
  
  Parameters:
  
  result - The description of the result file to write.
  
  job - The job of the given result.
  
  Returns:
  
  An output of the corresponding result file.
  
  Throws:
  
  java.io.IOException - If there is an error while creating the result file or while opening an output stream on it.
  
  getResultSize
  
  public long getResultSize(Result result, UWSJob job) throws java.io.IOException
  
  Description copied from interface: UWSFileManager
  
  Gets the size of the specified result file.
  
  Specified by:
  
  getResultSize in interface UWSFileManager
  
  Parameters:
  
  result - Description of the result file whose the size is wanted.
  
  job - The job of the given result.
  
  Returns:
  
  The size (in bytes) of the specified result file or -1 if unknown or the file does not exist.
  
  Throws:
  
  java.io.IOException - If there is an error while getting the result file size.
  
  deleteResult
  
  public boolean deleteResult(Result result, UWSJob job) throws java.io.IOException
  
  Description copied from interface: UWSFileManager
  
  Deletes the result file corresponding to the given job result's description.
  
  Specified by:
  
  deleteResult in interface UWSFileManager
  
  Parameters:
  
  result - The description of the result file to delete.
  
  job - The job of the given result.
  
  Returns:
  
  true if the result file has been deleted or if the result file does not exists, false otherwise.
  
  Throws:
  
  java.io.IOException - If there is a grave and unexpected error while deleting the result file.
  
  getErrorFileName
  
  protected java.lang.String getErrorFileName(ErrorSummary error, UWSJob job)
  
  Gets the name of the file in which the described error is/must be written.
  
  By default: jobID + "_ERROR.log"
  
  Parameters:
  
  error - The description of the error whose the file name is asked.
  
  job - The job which owns the given error.
  
  Returns:
  
  Name of the file corresponding to the described error.
  
  getErrorFile
  
  protected java.io.File getErrorFile(ErrorSummary error, UWSJob job)
  
  Gets the file corresponding to the described error.
  
  Parameters:
  
  error - The error whose the file is asked.
  
  job - The job which owns the given error.
  
  Returns:
  
  The file corresponding to the described error.
  
  See Also:
  
  getOwnerDirectory(JobOwner), getErrorFileName(ErrorSummary, UWSJob)
  
  getErrorInput
  
  public java.io.InputStream getErrorInput(ErrorSummary error, UWSJob job) throws java.io.IOException
  
  Description copied from interface: UWSFileManager
  
  Gets an input stream on the error file corresponding to the given error and job.
  
  Specified by:
  
  getErrorInput in interface UWSFileManager
  
  Parameters:
  
  error - The description of the error file to read.
  
  job - The job of the given error.
  
  Returns:
  
  An input of the corresponding error file or null if there is no error file.
  
  Throws:
  
  java.io.IOException - If there is an error while opening an input stream on the error file.
  
  getErrorOutput
  
  public java.io.OutputStream getErrorOutput(ErrorSummary error, UWSJob job) throws java.io.IOException
  
  Description copied from interface: UWSFileManager
  
  Gets an output stream on the error file corresponding to the given error and job.
  Note: The error file must be automatically created if needed.
  
  Specified by:
  
  getErrorOutput in interface UWSFileManager
  
  Parameters:
  
  error - The description of the error file to write.
  
  job - The job of the given error.
  
  Returns:
  
  An output of the corresponding error file.
  
  Throws:
  
  java.io.IOException - If there is an error while creating the error file or while opening an output stream on it.
  
  getErrorSize
  
  public long getErrorSize(ErrorSummary error, UWSJob job) throws java.io.IOException
  
  Description copied from interface: UWSFileManager
  
  Gets the size of the specified error summary file.
  
  Specified by:
  
  getErrorSize in interface UWSFileManager
  
  Parameters:
  
  error - Description of the error file whose the size is wanted.
  
  job - The job of the given error.
  
  Returns:
  
  The size (in bytes) of the specified error file or -1 if unknown or the file does not exist.
  
  Throws:
  
  java.io.IOException - If there is an error while getting the error file size.
  
  deleteError
  
  public boolean deleteError(ErrorSummary error, UWSJob job) throws java.io.IOException
  
  Description copied from interface: UWSFileManager
  
  Deletes the error file corresponding to the given job error summary.
  
  Specified by:
  
  deleteError in interface UWSFileManager
  
  Parameters:
  
  error - The description of the error file to delete.
  
  job - The job of the given error.
  
  Returns:
  
  true if the error file has been deleted or if the error file does not exists, false otherwise.
  
  Throws:
  
  java.io.IOException - If there is a grave and unexpected error while deleting the error file.
  
  getBackupFileName
  
  protected java.lang.String getBackupFileName(JobOwner owner) throws java.lang.IllegalArgumentException
  
  Gets the name of the backup file of the given job owner (~ UWS user).
  
  By default: ownerID + ".backup"
  
  Parameters:
  
  owner - The job owner whose the name of the backup file is asked.
  
  Returns:
  
  The name of the backup file of the given owner.
  
  Throws:
  
  java.lang.IllegalArgumentException - If the given owner is null or an empty string.
  
  getBackupInput
  
  public java.io.InputStream getBackupInput(JobOwner owner) throws java.lang.IllegalArgumentException, java.io.IOException
  
  Description copied from interface: UWSFileManager
  
  Gets an input stream on the backup file of ONLY the given job owner (~ UWS user).
  
  Specified by:
  
  getBackupInput in interface UWSFileManager
  
  Parameters:
  
  owner - Owner whose the jobs must be fetched from the file on which the input stream is asked.
  
  Returns:
  
  An input on the backup file of the given owner or null if there is no backup file.
  
  Throws:
  
  java.lang.IllegalArgumentException - If the given owner is null.
  
  java.io.IOException - If there is an error while opening an input stream on the backup file.
  
  getAllUserBackupInputs
  
  public java.util.Iterator<java.io.InputStream> getAllUserBackupInputs()
  
  Description copied from interface: UWSFileManager
  
  Gets an input stream on the backup file of ALL the job owners (~ UWS user).
  
  Specified by:
  
  getAllUserBackupInputs in interface UWSFileManager
  
  Returns:
  
  An iterator on all job owner's backup file.
  
  getBackupOutput
  
  public java.io.OutputStream getBackupOutput(JobOwner owner) throws java.lang.IllegalArgumentException, java.io.IOException
  
  Description copied from interface: UWSFileManager
  
  Gets an output stream on the backup file of ONLY the given job owner (~ UWS user).
  Note: The backup file must be automatically created if needed.
  
  Specified by:
  
  getBackupOutput in interface UWSFileManager
  
  Parameters:
  
  owner - Owner whose the jobs must be saved in the file on which the output stream is asked.
  
  Returns:
  
  An output on the backup file of the given owner.
  
  Throws:
  
  java.lang.IllegalArgumentException - If the given owner is null.
  
  java.io.IOException - If there is an error while creating the backup file or while opening an output stream on it.
  
  getBackupFileName
  
  protected java.lang.String getBackupFileName()
  
  Gets the name of the UWS general backup file.
  
  By default: DEFAULT_BACKUP_FILE_NAME
  
  Returns:
  
  The name of the UWS general backup file.
  
  getBackupInput
  
  public java.io.InputStream getBackupInput() throws java.io.IOException
  
  Description copied from interface: UWSFileManager
  
  Gets an input stream on the backup file of the whole UWS.
  
  Specified by:
  
  getBackupInput in interface UWSFileManager
  
  Returns:
  
  An input on the backup file of the whole UWS or null if there is no backup file.
  
  Throws:
  
  java.io.IOException - If there is an error while opening an input stream of the backup file.
  
  getBackupOutput
  
  public java.io.OutputStream getBackupOutput() throws java.io.IOException
  
  Description copied from interface: UWSFileManager
  
  Gets an output stream on the backup file of the whole UWS.
  Note: The backup file must be automatically created if needed.
  
  Specified by:
  
  getBackupOutput in interface UWSFileManager
  
  Returns:
  
  An output on the backup file of the whole UWS.
  
  Throws:
  
  java.io.IOException - If there is an error while creating the backup file or while opening an output stream on it.
  
  createParentDir
  
  protected boolean createParentDir(java.io.File f)
  
  Creates the parent directory(ies) if it(they) does/do not exist.
  
  Parameters:
  
  f - The file whose the parent directory must exist after the call of this function.
  
  Returns:
  
  true if the parent directory now exists, false otherwise.

Class LocalUWSFileManager

Nested Class Summary

Field Summary

Fields inherited from interface uws.service.file.UWSFileManager

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_LOG_FILE_NAME

DEFAULT_BACKUP_FILE_NAME

rootDirectory

tmpDirectory

logOutput

logRotation

oneDirectoryForEachUser

groupUserDirectories

ownerGroupId

Constructor Detail

LocalUWSFileManager

LocalUWSFileManager

LocalUWSFileManager

Method Detail

getOwnerDirectory

cleanOwnerDirectory

getLogRotationFreq

setLogRotationFreq

getLogFileName

getLogFile

getLogInput

getLogOutput

printLogHeader

getFile

getTmpDirectory

setTmpDirectory

getUploadInput

openURI

deleteUpload

moveUpload

getResultFileName

getResultFile

getResultInput

getResultOutput

getResultSize

deleteResult

getErrorFileName

getErrorFile

getErrorInput

getErrorOutput

getErrorSize

deleteError

getBackupFileName

getBackupInput

getAllUserBackupInputs

getBackupOutput

getBackupFileName

getBackupInput

getBackupOutput

createParentDir