Class MasterRemoteFile
- java.lang.Object
-
- org.syncany.plugins.transfer.files.RemoteFile
-
- org.syncany.plugins.transfer.files.MasterRemoteFile
-
public class MasterRemoteFile extends RemoteFile
The master file represents the file that stores the salt for the master key. The file is only mandatory if the repository is encrypted.Name pattern: The file must always be called master Initializing an instance with a different name will throw an exception.
-
-
Constructor Summary
Constructors Constructor Description MasterRemoteFile()
Initializes a new master file with the name master.MasterRemoteFile(java.lang.String name)
Initializes a new master file, given a name.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.lang.String
validateName(java.lang.String name)
Parses the name of the file and validates it against the classes name pattern.-
Methods inherited from class org.syncany.plugins.transfer.files.RemoteFile
createRemoteFile, createRemoteFile, equals, getAttributes, getName, hashCode, setAttributes, toString
-
-
-
-
Constructor Detail
-
MasterRemoteFile
public MasterRemoteFile() throws StorageException
Initializes a new master file with the name master.- Throws:
StorageException
- Never throws an exception.
-
MasterRemoteFile
public MasterRemoteFile(java.lang.String name) throws StorageException
Initializes a new master file, given a name. This constructor might be called by thecreateRemoteFile()
method of theRemoteFile
.- Parameters:
name
- Master file name; must always be master- Throws:
StorageException
- If the name is not master
-
-
Method Detail
-
validateName
protected java.lang.String validateName(java.lang.String name) throws StorageException
Description copied from class:RemoteFile
Parses the name of the file and validates it against the classes name pattern. WhileRemoteFile
has no name pattern (and never throws an exception), sub-classes might by overriding this method.- Overrides:
validateName
in classRemoteFile
- Parameters:
name
- The name of the file (as it is identified by Syncany)- Returns:
- Returns a (potentially changed) name, after validating the name
- Throws:
StorageException
- If the name does not match the name pattern defined by the class.
Note:RemoteFile
does never throw this exceptions, however, subclasses might.
-
-