Package org.ametys.plugins.extraction.execution

Class ExtractionDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.extraction.execution.ExtractionDAO

All Implemented Interfaces:

LogEnabled, Initializable, Component, Serviceable

public class ExtractionDAO
extends AbstractLogEnabled
implements Serviceable, Component, Initializable

Object representing the extraction definition file content

Field Summary

Fields

Modifier and Type	Field	Description
static String	ROLE	The Avalon role

Constructor Summary

Constructors

Constructor	Description
ExtractionDAO()

Method Summary

Modifier and Type	Method	Description
void	copyRights(String sourceContext, String targetContext)	Copy rights from one context to another one
void	copyRightsRecursively(String sourceContext, String targetContext, TraversableSource file)	Copy rights from one context to another one
void	deleteRights(String context)	Delete rights from a context
void	deleteRightsRecursively(String context, TraversableSource file)	Copy rights from one context to another one
String	getExtractionAbsolutePathFromContext(String context)	Get the absolute path of an extraction or an extraction from the context
Map<String,Object>	getExtractionContainerProperties(TraversableSource folder)	Get extraction container properties
Map<String,Object>	getExtractionProperties(Extraction extraction, TraversableSource file)	Get extraction properties
String	getExtractionRightPath(Source source)	Get the relative path of an extraction or an extraction container
Map<String,Object>	getRootProperties()	Get the root container properties
UserIdentity	getUserIdentityByExtractionPath(FileSource extractionPath)	get the author of extraction
Boolean	hasAnyAssignableDescendant(UserIdentity userIdentity, TraversableSource folder)	Check if a folder has descendant for a given user
Boolean	hasAnyReadableDescendant(UserIdentity userIdentity, TraversableSource folder)	Check if a folder has a descendant in read access for a given user
Boolean	hasAnyWritableDescendant(UserIdentity userIdentity, TraversableSource folder)	Check if a folder has descendant in write access for a given user
boolean	hasAssignationRightOnExtractionContainer(UserIdentity userIdentity, TraversableSource folder)	Check if a user has right affectation rights on an extraction container
boolean	hasReadRightOnExtraction(UserIdentity userIdentity, TraversableSource extraction, UserIdentity author)	Check if a user has read rights on an extraction
boolean	hasReadRightOnExtractionContainer(UserIdentity userIdentity, TraversableSource folder)	Check if a user has read rights on an extraction container
boolean	hasRightAffectationRightOnExtraction(UserIdentity userIdentity, TraversableSource extraction, UserIdentity author)	Check if a user has right affectation rights on an extraction container
boolean	hasWriteRightOnExtraction(UserIdentity userIdentity, TraversableSource extraction, UserIdentity author)	Check if a user has write rights on an extraction
boolean	hasWriteRightOnExtractionAndParent(UserIdentity userIdentity, TraversableSource extraction, UserIdentity author, TraversableSource file)	Check if a user has write rights on an extraction
boolean	hasWriteRightOnExtractionContainer(UserIdentity userIdentity, TraversableSource folder)	Check if a user has write rights on an extraction container
void	initialize()
Map<String,Object>	moveExtractionDefinitionFile(String srcRelPath, String parentRelPath)	Move an extraction file or folder inside a given directory
Map<String,Object>	moveSource(String srcUri, String parentTargetUri, String sourceContext, String targetContext)	Move a file or folder
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The Avalon role

Constructor Detail

ExtractionDAO

public ExtractionDAO()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

getRootProperties

public Map<String,Object> getRootProperties()
                                           throws IOException

Get the root container properties

Returns:

The root container properties

Throws:

IOException - If an error occurred while reading folder

getExtractionContainerProperties

public Map<String,Object> getExtractionContainerProperties(TraversableSource folder)

Get extraction container properties

Parameters:

folder - the source of the extraction container

Returns:

The extraction container properties

getExtractionProperties

public Map<String,Object> getExtractionProperties(Extraction extraction,
                                                        TraversableSource file)

Get extraction properties

Parameters:

extraction - the extraction

file - the source of the extraction

Returns:

The extraction properties

hasAnyReadableDescendant

public Boolean hasAnyReadableDescendant(UserIdentity userIdentity,
                                        TraversableSource folder)

Check if a folder has a descendant in read access for a given user

Parameters:

userIdentity - the user

folder - the source of the extraction container

Returns:

true if the folder has a descendant in read access, false otherwise

hasAnyWritableDescendant

public Boolean hasAnyWritableDescendant(UserIdentity userIdentity,
                                        TraversableSource folder)

Check if a folder has descendant in write access for a given user

Parameters:

userIdentity - the user

folder - the source of the extraction container

Returns:

true if the folder has descendant in write access, false otherwise

hasAnyAssignableDescendant

public Boolean hasAnyAssignableDescendant(UserIdentity userIdentity,
                                          TraversableSource folder)

Check if a folder has descendant for a given user

Parameters:

userIdentity - the user

folder - the source of the extraction container

Returns:

true if the folder has descendant, false otherwise

hasReadRightOnExtractionContainer

public boolean hasReadRightOnExtractionContainer(UserIdentity userIdentity,
                                                 TraversableSource folder)

Check if a user has read rights on an extraction container

Parameters:

userIdentity - the user

folder - the source of the extraction container

Returns:

true if the user has read rights on an extraction container, false otherwise

hasWriteRightOnExtractionContainer

public boolean hasWriteRightOnExtractionContainer(UserIdentity userIdentity,
                                                  TraversableSource folder)

Check if a user has write rights on an extraction container

Parameters:

userIdentity - the user

folder - the source of the extraction container

Returns:

true if the user has write rights on an extraction container, false otherwise

hasAssignationRightOnExtractionContainer

public boolean hasAssignationRightOnExtractionContainer(UserIdentity userIdentity,
                                                        TraversableSource folder)

Check if a user has right affectation rights on an extraction container

Parameters:

userIdentity - the user

folder - the source of the extraction container

Returns:

true if the user have right affectation rights on an extraction container, false otherwise

hasReadRightOnExtraction

public boolean hasReadRightOnExtraction(UserIdentity userIdentity,
                                        TraversableSource extraction,
                                        UserIdentity author)

Check if a user has read rights on an extraction

Parameters:

userIdentity - the user

extraction - the source for the extraction

author - the extraction author

Returns:

true if the user has read rights on an extraction, false otherwise

hasWriteRightOnExtraction

public boolean hasWriteRightOnExtraction(UserIdentity userIdentity,
                                         TraversableSource extraction,
                                         UserIdentity author)

Check if a user has write rights on an extraction

Parameters:

userIdentity - the user

extraction - the source for the extraction

author - the extraction author

Returns:

true if the user has write rights on an extraction, false otherwise

hasWriteRightOnExtractionAndParent

public boolean hasWriteRightOnExtractionAndParent(UserIdentity userIdentity,
                                                  TraversableSource extraction,
                                                  UserIdentity author,
                                                  TraversableSource file)

Check if a user has write rights on an extraction

Parameters:

userIdentity - the user

extraction - the source for the extraction

author - the extraction author

file - file

Returns:

true if the user has write rights on an extraction, false otherwise

hasRightAffectationRightOnExtraction

public boolean hasRightAffectationRightOnExtraction(UserIdentity userIdentity,
                                                    TraversableSource extraction,
                                                    UserIdentity author)

Check if a user has right affectation rights on an extraction container

Parameters:

userIdentity - the user

extraction - the source for the extraction

author - the extraction author

Returns:

true if the user has right affectation rights on an extraction, false otherwise

getExtractionRightPath

public String getExtractionRightPath(Source source)

Get the relative path of an extraction or an extraction container

Parameters:

source - The source of the extraction or extraction container

Returns:

the relative path

getExtractionAbsolutePathFromContext

public String getExtractionAbsolutePathFromContext(String context)
                                            throws IOException

Get the absolute path of an extraction or an extraction from the context

Parameters:

context - The context

Returns:

the relative path

Throws:

IOException - if I/O error occurred.

copyRights

public void copyRights(String sourceContext,
                       String targetContext)

Copy rights from one context to another one

Parameters:

sourceContext - the source context

targetContext - the target context

deleteRights

public void deleteRights(String context)

Delete rights from a context

Parameters:

context - the context

moveExtractionDefinitionFile

public Map<String,Object> moveExtractionDefinitionFile(String srcRelPath,
                                                             String parentRelPath)
                                                      throws IOException

Move an extraction file or folder inside a given directory

Parameters:

srcRelPath - The relative URI of file/folder to move

parentRelPath - The URI relative of parent target file

Returns:

a result map with the name and uri of moved file in case of success.

Throws:

IOException - If an error occurred manipulating the source

moveSource

public Map<String,Object> moveSource(String srcUri,
                                           String parentTargetUri,
                                           String sourceContext,
                                           String targetContext)
                                    throws IOException

Move a file or folder

Parameters:

srcUri - The URI of file/folder to move

parentTargetUri - The URI of parent target file

sourceContext - the source context

targetContext - the target context

Returns:

a result map with the name and uri of moved file in case of success.

Throws:

IOException - If an error occurred manipulating the source

copyRightsRecursively

public void copyRightsRecursively(String sourceContext,
                                  String targetContext,
                                  TraversableSource file)

Copy rights from one context to another one

Parameters:

sourceContext - the source context

targetContext - the target context

file - the source of the file to copy

deleteRightsRecursively

public void deleteRightsRecursively(String context,
                                    TraversableSource file)

Copy rights from one context to another one

Parameters:

context - the context

file - the source of the file to copy

getUserIdentityByExtractionPath

public UserIdentity getUserIdentityByExtractionPath(FileSource extractionPath)

get the author of extraction

Parameters:

extractionPath - the path of the extraction

Returns:

the author