com.tenduke.fileplus.impl

Class DefaultFileEngine

java.lang.Object

com.tenduke.fileplus.impl.DefaultFileEngine

All Implemented Interfaces:

FileEngine

Direct Known Subclasses:

MongoFileEngine

public class DefaultFileEngine
extends Object
implements FileEngine

Default implementation class that defines file and directory access.

Author:

frej

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIGURATION_KEY_TMP_FILE_DIR Configuration key for temporary file directory,

Constructor Summary

Constructors

Constructor and Description
DefaultFileEngine(com.tenduke.sdk2.api.security.Actor actor, com.tenduke.sdk2.objectmodel.identity.Account account, Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants) Initializes a new instance of the DefaultFileEngine class.

Method Summary

Modifier and Type	Method and Description
void	cp(String source, String target) Copies an entry in storage (directory copy is recursive).
RegularFile	createFile(String path, File file) Creates file.
RegularFile	createFile(String path, com.tenduke.sdk2.api.io.Resource file) Creates file.
protected boolean	doCheckDirExists(String path, Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants) Checks if given directory path exists.
protected boolean	doCheckFileExists(String path, Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants) Checks if given regular file exists.
protected String	doChrootPath(String path) Applies chroot scope to path and returns the resulting path "under" getChroot().
protected void	doCopyDirectory(Directory dir, String target, Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants) Copies a Directory to given path.
protected RegularFile	doCopyFile(RegularFile file, String target, Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants) Copies a RegularFile to given path.
protected RegularFile	doCreateFile(String path, com.tenduke.sdk2.api.io.Resource file, Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants) Creates file.
protected com.tenduke.sdk2.utils.storage.StorageUri	doCreateFileIdentifier(RegularFile file) Creates storage file identifier for a regular file object.
protected void	doDeleteDirectory(Directory dir, Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants) Deletes specified directory and all contents in it.
protected void	doDeleteDirectoryRecursively(String path, Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants) Deletes specified directory and all content recursively.
protected void	doDeleteFile(RegularFile file, Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants) Deletes specified file.
protected AccessPolicy	doGetAccessPolicy(String path) Gets access policy for given path.
protected AccessPolicy	doGetAndCheckAccessPolicy(String path, AccessPolicy newAccessPolicy) Gets access policy for given path.
protected File	doGetAsLocalFile(String path, Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants) Gets stored file based on path.
protected com.tenduke.sdk2.api.io.Resource	doGetFileResource(String path, Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants) Gets stored file based on path.
protected FileEntry	doLs(String path, Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants) Lists directory contents or information about file that path denotes.
void	doMkdir(String path, Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants) Creates a new Directory.
protected void	doMoveDirectory(Directory dir, String target, Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants) Moves a Directory to a new path.
protected void	doMoveFile(RegularFile file, String target, Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants) Moves a RegularFile to a new path.
protected List<AccessPolicy>	doQueryAccessPolicys(UUID fileEntryId, String referenceFieldName) Queries AccessPolicy entities based on file entry id and reference field name.
protected Directory	doQueryDir(String path, Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants) Queries Directory by path.
protected RegularFile	doQueryFile(String path, Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants) Queries RegularFile by path.
protected com.tenduke.sdk2.objectmodel.identity.Account	doResolveAccount(com.tenduke.sdk2.api.security.Actor actor) Resolves Account that the actor is related to.
protected void	doSetAccessPolicy(String path, AccessPolicy accessPolicy) Sets access policy for given path.
protected String	doUnchrootPath(String chrootedPath) Removes chroot scope from path and returns the result.
com.tenduke.sdk2.api.KeyValuePair<File,Boolean>	ensureFileIsLocal(String path) Gets stored file ensuring local access.
boolean	exists(String path) Checks if given path already exists.
AccessPolicy	getAccessPolicy(String path) Gets access policy for given path.
protected com.tenduke.sdk2.api.security.Actor	getActor() Gets actor set for this instance.
protected UUID	getActorId() Gets actor's id.
protected com.tenduke.sdk2.api.security.AuthorityChecker	getAuthorityChecker() Gets AuthorityChecker from service locator.
String	getChroot() Gets root path that constrains file engine into an account specific hierarchy.
protected com.tenduke.sdk2.api.persistence.EntityManager<? extends com.tenduke.sdk2.api.persistence.EntityTransaction>	getEntityManager() Gets entity manager used to manage persistence for file engine objects.
com.tenduke.sdk2.api.io.Resource	getFileResource(String path) Gets stored file based on path.
protected com.tenduke.sdk2.api.storage.StorageProvider	getStorageProvider() Gets storage provider from service locator.
protected com.tenduke.sdk2.api.UuidGenerator	getUuidGenerator() Gets UUID generator from service locator.
List<String>	ls(String path) Lists directory contents or information about file that path denotes.
void	mkdir(String path) Creates a new Directory.
void	mv(String source, String target) Moves a directory or file.
void	rm(String path) Removes an entry from storage.
void	setAccessPolicy(String path, AccessPolicy accessPolicy) Sets access policy for given path.
void	setChroot(String chroot) Sets root path that constrains file engine into an account specific hierarchy.
RegularFile	updateFile(RegularFile file) Updates file entry.

Methods inherited from class java.lang.Object

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

Field Detail

CONFIGURATION_KEY_TMP_FILE_DIR

public static final String CONFIGURATION_KEY_TMP_FILE_DIR

Configuration key for temporary file directory,

See Also:

Constant Field Values

Constructor Detail

DefaultFileEngine

public DefaultFileEngine(com.tenduke.sdk2.api.security.Actor actor,
                         com.tenduke.sdk2.objectmodel.identity.Account account,
                         Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants)

Initializes a new instance of the DefaultFileEngine class.

Parameters:

actor - The effective actor using this instance.

account - Account that actor is related to. Not null argument will constrain this instance to the account storage scope.

permissionGrants - Permission grants used to authorize operations with AuthorityChecker.

Method Detail

getChroot

public String getChroot()

Gets root path that constrains file engine into an account specific hierarchy.

Specified by:

getChroot in interface FileEngine

Returns:

root path that constrains file engine into an account specific hierarchy.

setChroot

public void setChroot(String chroot)

Sets root path that constrains file engine into an account specific hierarchy.

Specified by:

setChroot in interface FileEngine

Parameters:

chroot - root path that constrains file engine into an account specific hierarchy.

getAccessPolicy

public AccessPolicy getAccessPolicy(String path)
                             throws PathException

Gets access policy for given path. Null access policy indicates that default policy is applied.

Specified by:

getAccessPolicy in interface FileEngine

Parameters:

path - Path to get access policy for.

Returns:

AccessPolicy set for the path or null if none has been defined.

Throws:

PathException - for errors parsing path, errors using path, or errors trying to access access policy.

setAccessPolicy

public void setAccessPolicy(String path,
                            AccessPolicy accessPolicy)
                     throws PathException

Sets access policy for given path. Null access policy indicates that default policy is applied.

Specified by:

setAccessPolicy in interface FileEngine

Parameters:

path - Path to set access policy for.

accessPolicy - The access policy to set for the path. The entity's id field is always managed by this method. For new policy instances the id is set to random and for entities found by the path the id is copied from the existing entity before updating. A null value will cause current policy object to be deleted if one is found.

Throws:

PathException - for errors parsing path, errors using path, or errors trying to access access policy.

ls

public List<String> ls(String path)
                throws PathException

Lists directory contents or information about file that path denotes. Results are formated using FileEntry.pathAsListEntry().

Specified by:

ls in interface FileEngine

Parameters:

path - Path to list content from.

Returns:

Given path's content or null if no such directory exists.

Throws:

PathException - for errors parsing path or using path.

mkdir

public void mkdir(String path)
           throws PathException

Creates a new Directory.

Specified by:

mkdir in interface FileEngine

Parameters:

path - Path of directory to create.

Throws:

PathException - for errors parsing path or creating directory.

mv

public void mv(String source,
               String target)
        throws PathException

Moves a directory or file.

Specified by:

mv in interface FileEngine

Parameters:

source - Source path of entry to move.

target - Target path to move to.

Throws:

PathException - for errors parsing paths or errors using paths.

cp

public void cp(String source,
               String target)
        throws PathException

Copies an entry in storage (directory copy is recursive).

Specified by:

cp in interface FileEngine

Parameters:

source - Source path of entry to copy.

target - Target path to copy to.

Throws:

PathException - for errors parsing paths or errors using paths.

rm

public void rm(String path)
        throws PathException

Removes an entry from storage.

Specified by:

rm in interface FileEngine

Parameters:

path - Path denoting directory or file to remove.

Throws:

PathException - for errors parsing path or errors while using path.

exists

public boolean exists(String path)
               throws PathException

Checks if given path already exists.

Specified by:

exists in interface FileEngine

Parameters:

path - Path to check.

Returns:

true if path specifies a file or directory that exists.

Throws:

PathException - for errors parsing path.

createFile

public RegularFile createFile(String path,
                              File file)
                       throws PathException

Creates file.

Specified by:

createFile in interface FileEngine

Parameters:

path - Path to create file in.

file - File that holds the data for the file to create. If a null file is passed in a file entry will still be created with status FileEntry.STATUS_NULL_FILE.

Returns:

Result RegularFile.

Throws:

PathException - for errors parsing path or using path.

createFile

public RegularFile createFile(String path,
                              com.tenduke.sdk2.api.io.Resource file)
                       throws PathException

Creates file.

Specified by:

createFile in interface FileEngine

Parameters:

path - Path to create file in.

file - File that holds the data for the file to create. If a null file is passed in a file entry will still be created with status FileEntry.STATUS_NULL_FILE.

Returns:

Result RegularFile.

Throws:

PathException - for errors parsing path or using path.

updateFile

public RegularFile updateFile(RegularFile file)
                       throws PathException

Updates file entry.

Specified by:

updateFile in interface FileEngine

Parameters:

file - Entry to update.

Returns:

Result RegularFile.

Throws:

PathException - for errors parsing path or using path.

ensureFileIsLocal

public com.tenduke.sdk2.api.KeyValuePair<File,Boolean> ensureFileIsLocal(String path)
                                                                  throws PathException

Gets stored file ensuring local access.

Specified by:

ensureFileIsLocal in interface FileEngine

Parameters:

path - Path to find file in.

Returns:

Result key value pair holding File and flag to indicate if caller should delete file when done using it. Null return value means file was not found.

Throws:

PathException - for errors parsing path or using path.

getFileResource

public com.tenduke.sdk2.api.io.Resource getFileResource(String path)
                                                 throws PathException

Gets stored file based on path.

Specified by:

getFileResource in interface FileEngine

Parameters:

path - Path to find file in.

Returns:

Result file Resource. The caller must close the returned resource object.

Throws:

PathException - for errors parsing path or using path.

doChrootPath

protected String doChrootPath(String path)

Applies chroot scope to path and returns the resulting path "under" getChroot().

Parameters:

path - Path to move under chroot.

Returns:

result chrooted path.

doUnchrootPath

protected String doUnchrootPath(String chrootedPath)

Removes chroot scope from path and returns the result.

Parameters:

chrootedPath - Path from which to remove chroot scope.

Returns:

result path.

doGetAccessPolicy

protected AccessPolicy doGetAccessPolicy(String path)
                                  throws PathException

Gets access policy for given path. Null access policy indicates that default policy is applied.

Parameters:

path - Path to get access policy for.

Returns:

AccessPolicy set for the path or null if none has been defined.

Throws:

PathException - for errors parsing path or setting access policy for the path.

doGetAndCheckAccessPolicy

protected AccessPolicy doGetAndCheckAccessPolicy(String path,
                                                 AccessPolicy newAccessPolicy)
                                          throws PathException

Gets access policy for given path. Also makes sure that the new policy object has reference fields initialized correctly.

Parameters:

path - Path to get access policy for.

newAccessPolicy - Optional new entity to set reference field information for.

Returns:

AccessPolicy set for the path or null if none has been defined.

Throws:

PathException - for errors parsing path or setting access policy for the path.

doQueryAccessPolicys

protected List<AccessPolicy> doQueryAccessPolicys(UUID fileEntryId,
                                                  String referenceFieldName)
                                           throws PathException

Queries AccessPolicy entities based on file entry id and reference field name.

Parameters:

fileEntryId - Identifier of file entry that access policy is related to.

referenceFieldName - Reference field name used in AccessPolicy for referencing file entry.

Returns:

List of access policies.

Throws:

PathException - For errors querying file entry's access policies.

doSetAccessPolicy

protected void doSetAccessPolicy(String path,
                                 AccessPolicy accessPolicy)
                          throws PathException

Sets access policy for given path. Null access policy indicates that default policy is applied.

Parameters:

path - Path to set access policy for.

accessPolicy - The access policy to set for the path. The entity's id field is always managed by this method. For new policy instances the id is set to random and for entities found by the path the id is copied from the existing entity before updating. A null value will cause an existing policy object to be deleted.

Throws:

PathException - for errors parsing path, errors using path, or errors trying to access access policy.

doCheckDirExists

protected boolean doCheckDirExists(String path,
                                   Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants)
                            throws PathException

Checks if given directory path exists.

Parameters:

path - Path to check.

permissionGrants - Permissions granted to authorize operations.

Returns:

true if path specifies a directory that exists.

Throws:

PathException - for errors parsing path.

doCheckFileExists

protected boolean doCheckFileExists(String path,
                                    Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants)
                             throws PathException

Checks if given regular file exists.

Parameters:

path - Path to check.

permissionGrants - Permissions granted to authorize operations.

Returns:

true if path specifies a file that exists.

Throws:

PathException - for errors parsing path.

doLs

protected FileEntry doLs(String path,
                         Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants)
                  throws PathException

Lists directory contents or information about file that path denotes.

Parameters:

path - Path to list content from.

permissionGrants - Permissions granted to authorize operations.

Returns:

FileEntry object in specified path or null if no such directory exists. To access contents of directory use AbstractDynamicRelatedObject.relatedObjects(java.lang.Class, com.tenduke.sdk2.api.object.Multiplicity) with relation object type set to Directory or RegularFile and multiplicity as Multiplicity.ONE_TO_MANY.

Throws:

PathException - for errors parsing path or using path.

doMkdir

public void doMkdir(String path,
                    Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants)
             throws PathException

Creates a new Directory.

Parameters:

path - Path of directory to create.

permissionGrants - Permissions granted to authorize operations.

Throws:

PathException - for errors parsing path or creating directory.

doGetFileResource

protected com.tenduke.sdk2.api.io.Resource doGetFileResource(String path,
                                                             Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants)
                                                      throws PathException

Gets stored file based on path.

Parameters:

path - Path to find file in.

permissionGrants - Permissions granted to authorize operations.

Returns:

Result file Resource. The caller must close the returned resource object.

Throws:

PathException - for errors parsing path or using path.

doGetAsLocalFile

protected File doGetAsLocalFile(String path,
                                Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants)
                         throws PathException

Gets stored file based on path.

Parameters:

path - Path to find file in.

permissionGrants - Permissions granted to authorize operations.

Returns:

Result File.

Throws:

PathException - for errors parsing path or using path.

doCreateFile

protected RegularFile doCreateFile(String path,
                                   com.tenduke.sdk2.api.io.Resource file,
                                   Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants)
                            throws PathException

Creates file.

Parameters:

path - Path to create file in.

file - File that holds the data for the file to create. If a null file is passed in a file entry will still be created with status FileEntry.STATUS_NULL_FILE.

permissionGrants - Permissions granted to authorize operations.

Returns:

Result RegularFile.

Throws:

PathException - for errors parsing path or using path.

doCreateFileIdentifier

protected com.tenduke.sdk2.utils.storage.StorageUri doCreateFileIdentifier(RegularFile file)
                                                                    throws PathException

Creates storage file identifier for a regular file object.

Parameters:

file - RegularFile to create storage file identifier for.

Returns:

Result file identifier to use with StorageProvider.

Throws:

PathException - for errors creating file identifier.

doMoveDirectory

protected void doMoveDirectory(Directory dir,
                               String target,
                               Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants)
                        throws PathException

Moves a Directory to a new path.

Parameters:

dir - Directory to move.

target - New path to move to.

permissionGrants - Permissions granted to authorize operations.

Throws:

PathException - for errors parsing paths or errors using paths (e.g. target exists will cause an exception).

doMoveFile

protected void doMoveFile(RegularFile file,
                          String target,
                          Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants)
                   throws PathException

Moves a RegularFile to a new path.

Parameters:

file - File to move.

target - New path to move to.

permissionGrants - Permissions granted to authorize operations.

Throws:

PathException - for errors parsing paths or errors using paths (e.g. target exists will cause an exception).

doCopyDirectory

protected void doCopyDirectory(Directory dir,
                               String target,
                               Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants)
                        throws PathException

Copies a Directory to given path.

Parameters:

dir - Directory to copy.

target - New path to copy to.

permissionGrants - Permissions granted to authorize operations.

Throws:

PathException - for errors parsing paths or errors using paths (e.g. target exists will cause an exception).

doCopyFile

protected RegularFile doCopyFile(RegularFile file,
                                 String target,
                                 Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants)
                          throws PathException

Copies a RegularFile to given path.

Parameters:

file - File to copy.

target - New path to copy to.

permissionGrants - Permissions granted to authorize operations.

Returns:

Result file entry.

Throws:

PathException - for errors parsing paths or errors using paths (e.g. target exists will cause an exception).

doDeleteFile

protected void doDeleteFile(RegularFile file,
                            Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants)
                     throws PathException

Deletes specified file.

Parameters:

file - File to delete.

permissionGrants - Permissions granted to authorize operations.

Throws:

PathException - for errors deleting file.

doDeleteDirectory

protected void doDeleteDirectory(Directory dir,
                                 Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants)
                          throws PathException

Deletes specified directory and all contents in it.

Parameters:

dir - Directory to delete.

permissionGrants - Permissions granted to authorize operations.

Throws:

PathException - for errors parsing path or using path.

doDeleteDirectoryRecursively

protected void doDeleteDirectoryRecursively(String path,
                                            Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants)
                                     throws PathException

Deletes specified directory and all content recursively.

Parameters:

path - Starting node in Directory tree to delete.

permissionGrants - Permissions granted to authorize operations.

Throws:

PathException - for errors parsing path or using path.

doQueryDir

protected Directory doQueryDir(String path,
                               Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants)
                        throws PathException

Queries Directory by path.

Parameters:

path - Path to match.

permissionGrants - Permissions granted to authorize operations.

Returns:

Directory with specified path or null if not found.

Throws:

PathException - for errors parsing path.

doQueryFile

protected RegularFile doQueryFile(String path,
                                  Iterable<com.tenduke.sdk2.api.security.PermissionGrant> permissionGrants)
                           throws PathException

Queries RegularFile by path.

Parameters:

path - Path to match.

permissionGrants - Permissions granted to authorize operations.

Returns:

RegularFile with specified path or null if not found.

Throws:

PathException - for errors parsing path.

doResolveAccount

protected com.tenduke.sdk2.objectmodel.identity.Account doResolveAccount(com.tenduke.sdk2.api.security.Actor actor)

Resolves Account that the actor is related to.

Parameters:

actor - The actor to resolve account for.

Returns:

Related Account or null if none specified.

getActor

protected com.tenduke.sdk2.api.security.Actor getActor()

Gets actor set for this instance.

Returns:

actor.

getActorId

protected UUID getActorId()

Gets actor's id.

Returns:

actor's id or null if actor is null or actor's id is null.

getUuidGenerator

protected com.tenduke.sdk2.api.UuidGenerator getUuidGenerator()

Gets UUID generator from service locator.

Returns:

UUID generator.

getEntityManager

protected com.tenduke.sdk2.api.persistence.EntityManager<? extends com.tenduke.sdk2.api.persistence.EntityTransaction> getEntityManager()

Gets entity manager used to manage persistence for file engine objects.

Returns:

entity manager.

getAuthorityChecker

protected com.tenduke.sdk2.api.security.AuthorityChecker getAuthorityChecker()

Gets AuthorityChecker from service locator.

Returns:

AuthorityChecker.

getStorageProvider

protected com.tenduke.sdk2.api.storage.StorageProvider getStorageProvider()

Gets storage provider from service locator.

Returns:

storage provider.