ExplorerResourcesDAO (Ametys 4.2.x

java.lang.Object
- org.ametys.runtime.plugin.component.AbstractLogEnabled
- - org.ametys.plugins.explorer.resources.actions.ExplorerResourcesDAO

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

Direct Known Subclasses:

ExplorerResourcesDAO, WorkspaceExplorerResourceDAO
```
public class ExplorerResourcesDAO
extends AbstractLogEnabled
implements Serviceable, Component, Contextualizable
```
Explorer resources DAO

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class ExplorerResourcesDAO.VersionInformation

Nested Classes
Modifier and Type	Class and Description
`private static class`	`ExplorerResourcesDAO.VersionInformation`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Context`	`_cocoonContext` The cocoon context
`protected Context`	`_context` The avalon context
`protected CurrentUserProvider`	`_currentUserProvider` The current user provider.
`protected ExplorerApplicationExtensionPoint`	`_explorerApplicationEP` The explorer application EP
`protected I18nUtils`	`_i18nUtils` I18n utils
`protected ResourceMetadataPopulatorExtensionPoint`	`_metadataPopulatorEP` The metadata populator extension point.
`protected ObservationManager`	`_observationManager` Observer manager.
`protected AmetysObjectResolver`	`_resolver` Ametys resolver
`protected RightManager`	`_rightManager` The rights manager
`protected ThreadDAO`	`_threadDAO` The thread DAO
`protected TikaProvider`	`_tikaProvider` The tika provider.
`protected UserHelper`	`_userHelper` The users manager
`static String`	`RIGHTS_COLLECTION_ADD` Right id to add a folder
`static String`	`RIGHTS_COLLECTION_DELETE` Right id to delete a folder
`static String`	`RIGHTS_COLLECTION_EDIT` Right id to edit a folder
`static String`	`RIGHTS_RESOURCE_ADD` Right id to add a resource
`static String`	`RIGHTS_RESOURCE_COMMENT` Right id to comment a resource
`static String`	`RIGHTS_RESOURCE_DELETE` Right id to delete a resource
`static String`	`RIGHTS_RESOURCE_EDIT_DC` Right id to edit DC metadata of a resource
`static String`	`RIGHTS_RESOURCE_MODERATE_COMMENT` Right id to moderate comment a resource
`static String`	`RIGHTS_RESOURCE_RENAME` Right id to rename a resource
`static String`	`RIGHTS_RESOURCE_UNLOCK_ALL` Right id to unlock all resources
`static String`	`ROLE` Avalon Role

Constructor Summary

Constructors
Constructor and Description

ExplorerResourcesDAO()

Constructors
Constructor and Description
`ExplorerResourcesDAO()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`_addLockToken(Node node)`
`protected boolean`	`_canAddComment(UserIdentity user, CommentableResource resource)` Indicates if an user can add a comment of a given resource
`protected boolean`	`_canDeleteComment(UserIdentity user, CommentableResource resource, JCRPost comment)` Indicates if an user can delete a comment of a given resource
`protected boolean`	`_canEditComment(UserIdentity user, CommentableResource resource, JCRPost comment)` Indicates if an user can edit a comment of a given resource
`private Map<String,Object>`	`_comment2json(JCRPost comment, boolean isEdition)`
`protected String`	`_getComment(JCRPost post)` Get the content of a comment as a String
`protected String`	`_getCommentForEditing(JCRPost post)` Get the content of a comment to edit as a String
`private void`	`_getMatchingExplorerNode(ExplorerNode explorerNode, String value, List<String> allowedExtensions, List<String> matchingPaths)`
`private void`	`_getMatchingResource(Resource resource, String value, List<String> allowedExtensions, List<String> matchingPaths)`
`private void`	`_saveChangesIfNeeded(ModifiableResource resource)`
`protected void`	`_setComment(JCRPost comment, String content)` Update the content of a comment
`private void`	`_updateContributorIfNeeded(ModifiableResource resource, String contributor)`
`private void`	`_updateCoverageIfNeeded(ModifiableResource resource, String coverage)`
`private void`	`_updateCreatorIfNeeded(ModifiableResource resource, String creator)`
`private void`	`_updateDateIfNeeded(ModifiableResource resource, String dateStr)`
`private void`	`_updateDCSubjectIfNeeded(ModifiableResource resource, List<String> subjects)`
`private void`	`_updateDescriptionIfNeeded(ModifiableResource resource, String description)`
`private void`	`_updateLanguageIfNeeded(ModifiableResource resource, String language)`
`private void`	`_updatePublisherIfNeeded(ModifiableResource resource, String publisher)`
`private void`	`_updateRelationIfNeeded(ModifiableResource resource, String relation)`
`private void`	`_updateRightsIfNeeded(ModifiableResource resource, String rights)`
`private void`	`_updateSourceIfNeeded(ModifiableResource resource, String source)`
`private void`	`_updateTitleIfNeeded(ModifiableResource resource, String title)`
`private void`	`_updateTypeIfNeeded(ModifiableResource resource, String type)`
`Map<String,Object>`	`addCMISCollection(String parentId, String originalName, String url, String login, String password, String repoId, boolean renameIfExists)` Creates a new CMIS folder (see `CMISRootResourcesCollection`)
`Map<String,Object>`	`addComment(String resourceId, String comment)` Add a comment to a resource
`ResourceCollection`	`addResourceCollection(ModifiableResourceCollection parent, String desiredName, Boolean renameIfExists, List<String> errors)` Add a resource collection
`Map<String,Object>`	`addResourceCollection(String parentId, String desiredName, Boolean renameIfExists)` Add a resource collection
`boolean`	`checkLock(AmetysObject ao)` Check lock on a Ametys object
`void`	`checkpoint(ModifiableResource resource)` Creates a new version
`void`	`checkUserRight(AmetysObject object, String rightId)` Check the user privilege on object
`void`	`contextualize(Context context)`
`Map<String,Object>`	`copyResource(List<String> ids, ModifiableResourceCollection target)` Copy file resources
`Map<String,Object>`	`copyResource(List<String> ids, String target)` Copy file resources
`ModifiableResource`	`createResource(ModifiableResourceCollection collection, String name)` Creates a `ModifiableResource` under current `ModifiableResourceCollection`.
`Map<String,Object>`	`deleteComment(String resourceId, String commentId)` Delete the comment of a resource
`Map<String,Object>`	`deleteObject(List<String> ids)` Delete an object
`String`	`deleteObject(RemovableAmetysObject object, List<String> errors)` Delete an object
`Map<String,Object>`	`editCMISCollection(String id, String url, String login, String password, String repoId)` Edits a CMIS folder (see `CMISRootResourcesCollection`)
`Map<String,Object>`	`editComment(String resourceId, String commentId, String comment)` Edit the comment of a resource
`void`	`extractResourceMetadata(ModifiableResource resource, String mimeType)` Extract the resource's metadata and populate the object accordingly.
`List<String>`	`filterResourcesByRegExp(String id, String value, List<String> allowedExtensions)` Get the path of pages which match filter regexp
`Map<String,String>`	`getCMISProperties(String id)` Get the CMIS properties of collection
`Map<String,Object>`	`getComment(String commentId, boolean isEdition)` Get a comment of a resource
`List<Map<String,Object>>`	`getComments(String resourceId, boolean isEdition)` Get the comments of a resource
`Map<String,Object>`	`getDCMetadata(String id)` Get the DublinCore metadata of a `DublinCoreAwareAmetysObject`
`Map<String,Object>`	`getDefaultInfoAsRootNode(ExplorerNode rootNode)` Get the necessary default info for a root node.
`Map<String,Object>`	`getDefaultInfoAsRootNode(String id)` Get the necessary default info for a root node.
`Map<String,Object>`	`getExplorerNodeProperties(ExplorerNode node)` Get the explorer node properties
`Map<String,Object>`	`getNodesInfo(List<String> ids)` Get the informations on given nodes (resources or collections)
`String`	`getResourceCollectionType()` Get the type of child resource collection
`Map<String,Object>`	`getResourceProperties(Resource resource)` Get the resource properties
`List<ExplorerNode>`	`getResourcesRootNodes()` Get the root nodes for resources
`List<Map<String,Object>>`	`getRootNodesInfo()` Retrieves the set of standard data for the explorer root node
`boolean`	`getUserRight(UserIdentity user, String right, AmetysObject object)` Retrieve the rights for the user
`protected Set<String>`	`getUserRights(ExplorerNode node)` Get the user rights on the resource collection
`boolean`	`hasRight(String id, String rightId)` Check current user right on given explorer node
`boolean`	`isCMISCollection(String id)` Determines if a object is a `CMISRootResourcesCollection`
`Map<String,Object>`	`moveObject(List<String> ids, JCRTraversableAmetysObject targetNode)` Move objects
`Map<String,Object>`	`moveObject(List<String> ids, String targetId)` Move objects
`JCRAmetysObject`	`renameObject(JCRAmetysObject object, String name, List<String> errors)` Rename a resource, or resource collection
`Map<String,Object>`	`renameObject(String id, String name)` Rename a resource, or resource collection
`JCRResource`	`renameResource(JCRResource resource, String name, List<String> errors)` Rename a resource
`Map<String,Object>`	`renameResource(String id, String name)` Rename a resource
`boolean`	`resourceExists(String parentId, String name)` Determines if a resource with given name already exists
`boolean`	`resourceExists(TraversableAmetysObject parent, String name)` Determines if a resource with given name already exists
`List<Map<String,Object>>`	`resourceHistory(String id)` Get the history versions of a resource
`void`	`restoreResource(String id, String versionName)` This action restores an old version of a `Resource`.
`void`	`service(ServiceManager manager)`
`void`	`setDCMetadata(ModifiableResource resource, Map<String,Object> values)` Set the Dublin Core metadata of a `Resource`.
`void`	`setDCMetadata(String resourceId, Map<String,Object> values)` Set the Dublin Core metadata of a `Resource`.
`void`	`updateResource(ModifiableResource resource, InputStream is, String fileName)` Updates resource input stream and metadata

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
```
  Avalon Role
- RIGHTS_RESOURCE_UNLOCK_ALL
```
public static final String RIGHTS_RESOURCE_UNLOCK_ALL
```
  Right id to unlock all resources
  
  See Also:
  
  Constant Field Values
- RIGHTS_RESOURCE_ADD
```
public static final String RIGHTS_RESOURCE_ADD
```
  Right id to add a resource
  
  See Also:
  
  Constant Field Values
- RIGHTS_RESOURCE_RENAME
```
public static final String RIGHTS_RESOURCE_RENAME
```
  Right id to rename a resource
  
  See Also:
  
  Constant Field Values
- RIGHTS_RESOURCE_DELETE
```
public static final String RIGHTS_RESOURCE_DELETE
```
  Right id to delete a resource
  
  See Also:
  
  Constant Field Values
- RIGHTS_RESOURCE_EDIT_DC
```
public static final String RIGHTS_RESOURCE_EDIT_DC
```
  Right id to edit DC metadata of a resource
  
  See Also:
  
  Constant Field Values
- RIGHTS_RESOURCE_COMMENT
```
public static final String RIGHTS_RESOURCE_COMMENT
```
  Right id to comment a resource
  
  See Also:
  
  Constant Field Values
- RIGHTS_RESOURCE_MODERATE_COMMENT
```
public static final String RIGHTS_RESOURCE_MODERATE_COMMENT
```
  Right id to moderate comment a resource
  
  See Also:
  
  Constant Field Values
- RIGHTS_COLLECTION_ADD
```
public static final String RIGHTS_COLLECTION_ADD
```
  Right id to add a folder
  
  See Also:
  
  Constant Field Values
- RIGHTS_COLLECTION_EDIT
```
public static final String RIGHTS_COLLECTION_EDIT
```
  Right id to edit a folder
  
  See Also:
  
  Constant Field Values
- RIGHTS_COLLECTION_DELETE
```
public static final String RIGHTS_COLLECTION_DELETE
```
  Right id to delete a folder
  
  See Also:
  
  Constant Field Values
- _resolver
```
protected AmetysObjectResolver _resolver
```
  Ametys resolver
- _rightManager
```
protected RightManager _rightManager
```
  The rights manager
- _observationManager
```
protected ObservationManager _observationManager
```
  Observer manager.
- _currentUserProvider
```
protected CurrentUserProvider _currentUserProvider
```
  The current user provider.
- _i18nUtils
```
protected I18nUtils _i18nUtils
```
  I18n utils
- _context
```
protected Context _context
```
  The avalon context
- _cocoonContext
```
protected Context _cocoonContext
```
  The cocoon context
- _tikaProvider
```
protected TikaProvider _tikaProvider
```
  The tika provider.
- _metadataPopulatorEP
```
protected ResourceMetadataPopulatorExtensionPoint _metadataPopulatorEP
```
  The metadata populator extension point.
- _userHelper
```
protected UserHelper _userHelper
```
  The users manager
- _explorerApplicationEP
```
protected ExplorerApplicationExtensionPoint _explorerApplicationEP
```
  The explorer application EP
- _threadDAO
```
protected ThreadDAO _threadDAO
```
  The thread DAO

Constructor Detail
- ExplorerResourcesDAO
```
public ExplorerResourcesDAO()
```

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:: service in interface Serviceable
Throws:: ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:: contextualize in interface Contextualizable
Throws:: ContextException

getResourcesRootNodes
```
public List<ExplorerNode> getResourcesRootNodes()
```
Get the root nodes for resources

Returns:

the root nodes

getRootNodesInfo
```
public List<Map<String,Object>> getRootNodesInfo()
```
Retrieves the set of standard data for the explorer root node

Returns:

The data structured in a map

getDefaultInfoAsRootNode
```
public Map<String,Object> getDefaultInfoAsRootNode(String id)
```
Get the necessary default info for a root node. Can be used to construct a root node for a tree (client side).

Parameters:

id - The root node id

Returns:

A map which contains a set of default info (such as id, applicationId, path, type etc...)

getDefaultInfoAsRootNode
```
public Map<String,Object> getDefaultInfoAsRootNode(ExplorerNode rootNode)
```
Get the necessary default info for a root node. Can be used to construct a root node for a tree (client side).

Parameters:

rootNode - The root node

Returns:

A map which contains a set of default info (such as id, applicationId, path, type etc...)

getNodesInfo
```
public Map<String,Object> getNodesInfo(List<String> ids)
```
Get the informations on given nodes (resources or collections)

Parameters:

ids - The ids of node

Returns:

the nodes information

getExplorerNodeProperties
```
public Map<String,Object> getExplorerNodeProperties(ExplorerNode node)
```
Get the explorer node properties

Parameters:

node - The explorer node

Returns:

The properties

getResourceProperties
```
public Map<String,Object> getResourceProperties(Resource resource)
```
Get the resource properties

Parameters:

resource - The resources

Returns:

The properties

filterResourcesByRegExp

public List<String> filterResourcesByRegExp(String id,
                                            String value,
                                            List<String> allowedExtensions)

Get the path of pages which match filter regexp

Parameters:: id - The id of explorer node to start search; value - the value to match; allowedExtensions - The allowed file extensions (lower-case). Can be null or empty to not filter on file extensions
Returns:: the matching paths

_getMatchingExplorerNode

private void _getMatchingExplorerNode(ExplorerNode explorerNode,
                                      String value,
                                      List<String> allowedExtensions,
                                      List<String> matchingPaths)

_getMatchingResource

private void _getMatchingResource(Resource resource,
                                  String value,
                                  List<String> allowedExtensions,
                                  List<String> matchingPaths)

getUserRights
```
protected Set<String> getUserRights(ExplorerNode node)
```
Get the user rights on the resource collection

Parameters:

node - The explorer node

Returns:

The user's rights

hasRight
```
public boolean hasRight(String id,
                        String rightId)
```
Check current user right on given explorer node

Parameters:

id - The id of the explorer node

rightId - The if of right to check

Returns:

true if user has right

checkLock
```
public boolean checkLock(AmetysObject ao)
```
Check lock on a Ametys object

Parameters:

ao - the Ametys object

Returns:

false if the Ametys object is locked and can not be edited or deleted

_addLockToken

private void _addLockToken(Node node)

checkUserRight

public void checkUserRight(AmetysObject object,
                           String rightId)
                    throws IllegalAccessException

Check the user privilege on object

Parameters:: object - the object; rightId - the right id
Throws:: IllegalAccessException - if the user has no sufficient rights

getUserRight

public boolean getUserRight(UserIdentity user,
                            String right,
                            AmetysObject object)

Retrieve the rights for the user

Parameters:: user - The user; right - The right; object - The object
Returns:: True if the user has the right

addResourceCollection
```
public Map<String,Object> addResourceCollection(String parentId,
                                                String desiredName,
                                                Boolean renameIfExists)
```
Add a resource collection

Parameters:

parentId - The identifier of the parent in which the resource collection will be added

desiredName - The desired name for the resource collection

renameIfExists - If false, in case of existing name the resource collection will not be created, if true it will be created and renamed

Returns:

The result map with id, parentId, name and message keys

addResourceCollection
```
public ResourceCollection addResourceCollection(ModifiableResourceCollection parent,
                                                String desiredName,
                                                Boolean renameIfExists,
                                                List<String> errors)
```
Add a resource collection

Parameters:

parent - The parent collection in which the resource collection will be added

desiredName - The desired name for the resource collection

renameIfExists - If false, in case of existing name the resource collection will not be created, if true it will be created and renamed

errors - An optional list of possible error messages in case the creation failed. Possible values are: locked, already-exist.

Returns:

The created resource collection or null if creation failed

getResourceCollectionType
```
public String getResourceCollectionType()
```
Get the type of child resource collection

Returns:

the type of child resource collection

renameObject
```
public Map<String,Object> renameObject(String id,
                                       String name)
                                throws RepositoryException
```
Rename a resource, or resource collection

Parameters:

id - The id of the object to rename

name - The desired name to set to the object.

Returns:

The result map with id, name and message keys

Throws:

RepositoryException - If there is a repository error

renameObject
```
public JCRAmetysObject renameObject(JCRAmetysObject object,
                                    String name,
                                    List<String> errors)
                             throws RepositoryException
```
Rename a resource, or resource collection

Parameters:

object - The object to rename

name - The desired name to set to the object.

errors - An optional list of possible error messages in case the operation failed. Possible values are: locked, already-exist.

Returns:

The new object

Throws:

RepositoryException - If there is a repository error

deleteObject
```
public Map<String,Object> deleteObject(List<String> ids)
```
Delete an object

Parameters:

ids - The list of identifiers for the objects to delete

Returns:

The result map with a message key in case of an error

deleteObject
```
public String deleteObject(RemovableAmetysObject object,
                           List<String> errors)
```
Delete an object

Parameters:

object - The object to delete

errors - An optional list of possible error messages in case the creation failed. Possible values are: locked.

Returns:

the parent id of the removed object

renameResource
```
public Map<String,Object> renameResource(String id,
                                         String name)
                                  throws RepositoryException
```
Rename a resource

Parameters:

id - The id of the resource to rename

name - The desired name to set to the resource.

Returns:

The result map with id, name and message keys

Throws:

RepositoryException - If there is a repository error

renameResource
```
public JCRResource renameResource(JCRResource resource,
                                  String name,
                                  List<String> errors)
                           throws RepositoryException
```
Rename a resource

Parameters:

resource - The resource to rename

name - The desired name to set to the resource.

errors - An optional list of possible error messages in case the operation failed. Possible values are: locked, already-exist.

Returns:

The new resource

Throws:

RepositoryException - If there is a repository error

copyResource
```
public Map<String,Object> copyResource(List<String> ids,
                                       String target)
                                throws RepositoryException
```
Copy file resources

Parameters:

ids - The list of identifiers for the resources to copy

target - The id of target to copy into

Returns:

The result map with a message key in case of an error or with the list of uncopied/copied resources

Throws:

RepositoryException - If there is a repository error

copyResource
```
public Map<String,Object> copyResource(List<String> ids,
                                       ModifiableResourceCollection target)
                                throws RepositoryException
```
Copy file resources

Parameters:

ids - The list of identifiers for the resources to copy

target - The target to copy into

Returns:

The result map with a message key in case of an error or with the list of uncopied/copied resources

Throws:

RepositoryException - If there is a repository error

moveObject
```
public Map<String,Object> moveObject(List<String> ids,
                                     String targetId)
                              throws RepositoryException
```
Move objects

Parameters:

ids - The list of identifiers for the objects to move

targetId - The id of target to move into

Returns:

The result map with a message key in case of an error or with the list of unmoved/moved objects

Throws:

RepositoryException - If there is a repository error

moveObject
```
public Map<String,Object> moveObject(List<String> ids,
                                     JCRTraversableAmetysObject targetNode)
                              throws RepositoryException
```
Move objects

Parameters:

ids - The list of identifiers for the objects to move

targetNode - The target to move into

Returns:

The result map with a message key in case of an error or with the list of unmoved/moved objects

Throws:

RepositoryException - If there is a repository error

resourceHistory
```
public List<Map<String,Object>> resourceHistory(String id)
                                         throws RepositoryException
```
Get the history versions of a resource

Parameters:

id - the id of resource

Returns:

The versions

Throws:

RepositoryException - if an error occurred

restoreResource
```
public void restoreResource(String id,
                            String versionName)
```
This action restores an old version of a Resource.

Parameters:

id - the id of resource

versionName - the name of version to restore

resourceExists
```
public boolean resourceExists(String parentId,
                              String name)
```
Determines if a resource with given name already exists

Parameters:

parentId - the id of parent collection

name - the name of resource

Returns:

true if a resource with same name exists

resourceExists
```
public boolean resourceExists(TraversableAmetysObject parent,
                              String name)
```
Determines if a resource with given name already exists

Parameters:

parent - the parent collection

name - the name of resource

Returns:

true if a resource with same name exists

setDCMetadata

public void setDCMetadata(String resourceId,
                          Map<String,Object> values)
                   throws ProcessingException

Set the Dublin Core metadata of a Resource.

Parameters:: resourceId - the id of resource; values - the DC values
Throws:: ProcessingException - if an error occurred

setDCMetadata

public void setDCMetadata(ModifiableResource resource,
                          Map<String,Object> values)

Set the Dublin Core metadata of a Resource.

Parameters:: resource - the resource; values - the DC values

_updateTitleIfNeeded

private void _updateTitleIfNeeded(ModifiableResource resource,
                                  String title)

_updateCreatorIfNeeded

private void _updateCreatorIfNeeded(ModifiableResource resource,
                                    String creator)

_updateDateIfNeeded

private void _updateDateIfNeeded(ModifiableResource resource,
                                 String dateStr)

_updateRightsIfNeeded

private void _updateRightsIfNeeded(ModifiableResource resource,
                                   String rights)

_updateCoverageIfNeeded

private void _updateCoverageIfNeeded(ModifiableResource resource,
                                     String coverage)

_updateRelationIfNeeded

private void _updateRelationIfNeeded(ModifiableResource resource,
                                     String relation)

_updateLanguageIfNeeded

private void _updateLanguageIfNeeded(ModifiableResource resource,
                                     String language)

_updateSourceIfNeeded

private void _updateSourceIfNeeded(ModifiableResource resource,
                                   String source)

_updateTypeIfNeeded

private void _updateTypeIfNeeded(ModifiableResource resource,
                                 String type)

_updateContributorIfNeeded

private void _updateContributorIfNeeded(ModifiableResource resource,
                                        String contributor)

_updatePublisherIfNeeded

private void _updatePublisherIfNeeded(ModifiableResource resource,
                                      String publisher)

_updateDescriptionIfNeeded

private void _updateDescriptionIfNeeded(ModifiableResource resource,
                                        String description)

_updateDCSubjectIfNeeded

private void _updateDCSubjectIfNeeded(ModifiableResource resource,
                                      List<String> subjects)

_saveChangesIfNeeded

private void _saveChangesIfNeeded(ModifiableResource resource)

getDCMetadata
```
public Map<String,Object> getDCMetadata(String id)
```
Get the DublinCore metadata of a DublinCoreAwareAmetysObject

Parameters:

id - the id of resource

Returns:

the DC metadata

addCMISCollection

public Map<String,Object> addCMISCollection(String parentId,
                                            String originalName,
                                            String url,
                                            String login,
                                            String password,
                                            String repoId,
                                            boolean renameIfExists)

Creates a new CMIS folder (see CMISRootResourcesCollection)

Parameters:: parentId - the id of parent folder; originalName - the original name if CMIS folder; url - The url of CMIS repository; login - The user's login to access CMIS repository; password - The user's password to access CMIS repository; repoId - The id of CMIS repository; renameIfExists - true to automatically renamed CMIS folder if requested name already exists
Returns:: the result map with id of created node

editCMISCollection

public Map<String,Object> editCMISCollection(String id,
                                             String url,
                                             String login,
                                             String password,
                                             String repoId)

Edits a CMIS folder (see CMISRootResourcesCollection)

Parameters:: id - the id of CMIS folder; url - The url of CMIS repository; login - The user's login to access CMIS repository; password - The user's password to access CMIS repository; repoId - The id of CMIS repository
Returns:: the result map with id of edited node

isCMISCollection
```
public boolean isCMISCollection(String id)
```
Determines if a object is a CMISRootResourcesCollection

Parameters:

id - The id of object

Returns:

true if it is a CMIS root folder

getCMISProperties
```
public Map<String,String> getCMISProperties(String id)
```
Get the CMIS properties of collection

Parameters:

id - The id of CMIS collection

Returns:

the CMIS properties to access CMIS repository

updateResource

public void updateResource(ModifiableResource resource,
                           InputStream is,
                           String fileName)

Updates resource input stream and metadata

Parameters:: resource - The resource; is - The resource input stream; fileName - The file name

extractResourceMetadata
```
public void extractResourceMetadata(ModifiableResource resource,
                                    String mimeType)
```
Extract the resource's metadata and populate the object accordingly.

Parameters:

resource - the resource to populate.

mimeType - the resource MIME type.

checkpoint
```
public void checkpoint(ModifiableResource resource)
```
Creates a new version

Parameters:

resource - the resource

createResource
```
public ModifiableResource createResource(ModifiableResourceCollection collection,
                                         String name)
```
Creates a ModifiableResource under current ModifiableResourceCollection.

Parameters:

collection - the parent ModifiableResourceCollection

name - the name of the child resource

Returns:

the new resource created.

Throws:

AmetysRepositoryException - if an error occurs.

RepositoryIntegrityViolationException - if an object with the same name already exists and same name siblings is not allowed.

addComment

public Map<String,Object> addComment(String resourceId,
                                     String comment)

Add a comment to a resource

Parameters:: resourceId - The id of the resource; comment - The comment
Returns:: the result

_canAddComment
```
protected boolean _canAddComment(UserIdentity user,
                                 CommentableResource resource)
```
Indicates if an user can add a comment of a given resource

Parameters:

user - An user identity

resource - The resource to comment

Returns:

True if the user can add a comment

editComment

public Map<String,Object> editComment(String resourceId,
                                      String commentId,
                                      String comment)

Edit the comment of a resource

Parameters:: resourceId - The id of the resource; commentId - The id of comment to edit; comment - The comment
Returns:: the result

_canEditComment

protected boolean _canEditComment(UserIdentity user,
                                  CommentableResource resource,
                                  JCRPost comment)

Indicates if an user can edit a comment of a given resource

Parameters:: user - An user identity; resource - The resource; comment - The comment to edit
Returns:: True if the user can edit the comment

_setComment

protected void _setComment(JCRPost comment,
                           String content)

Update the content of a comment

Parameters:: comment - The comment to update; content - The content as string

_getComment
```
protected String _getComment(JCRPost post)
                      throws AmetysRepositoryException
```
Get the content of a comment as a String

Parameters:

post - the post

Returns:

The content as String

Throws:

AmetysRepositoryException - if failed to parse comment

_getCommentForEditing
```
protected String _getCommentForEditing(JCRPost post)
                                throws AmetysRepositoryException
```
Get the content of a comment to edit as a String

Parameters:

post - the post

Returns:

The content as String

Throws:

AmetysRepositoryException - if failed to parse comment

deleteComment

public Map<String,Object> deleteComment(String resourceId,
                                        String commentId)

Delete the comment of a resource

Parameters:: resourceId - The id of the resource; commentId - The id of comment to delete
Returns:: the result

_canDeleteComment

protected boolean _canDeleteComment(UserIdentity user,
                                    CommentableResource resource,
                                    JCRPost comment)

Indicates if an user can delete a comment of a given resource

Parameters:: user - An user identity; resource - The resource; comment - The comment to edit
Returns:: True if the user can edit the comment

getComments
```
public List<Map<String,Object>> getComments(String resourceId,
                                            boolean isEdition)
```
Get the comments of a resource

Parameters:

resourceId - The id of the resource

isEdition - true to get the comments in edit mode

Returns:

The comments

getComment
```
public Map<String,Object> getComment(String commentId,
                                     boolean isEdition)
```
Get a comment of a resource

Parameters:

commentId - The id of the comment

isEdition - true to get the comment in edit mode

Returns:

The comments

_comment2json

private Map<String,Object> _comment2json(JCRPost comment,
                                         boolean isEdition)

Class ExplorerResourcesDAO

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

ROLE

RIGHTS_RESOURCE_UNLOCK_ALL

RIGHTS_RESOURCE_ADD

RIGHTS_RESOURCE_RENAME

RIGHTS_RESOURCE_DELETE

RIGHTS_RESOURCE_EDIT_DC

RIGHTS_RESOURCE_COMMENT

RIGHTS_RESOURCE_MODERATE_COMMENT

RIGHTS_COLLECTION_ADD

RIGHTS_COLLECTION_EDIT

RIGHTS_COLLECTION_DELETE

_resolver

_rightManager

_observationManager

_currentUserProvider

_i18nUtils

_context

_cocoonContext

_tikaProvider

_metadataPopulatorEP

_userHelper

_explorerApplicationEP

_threadDAO

Constructor Detail

ExplorerResourcesDAO

Method Detail

service

contextualize

getResourcesRootNodes

getRootNodesInfo

getDefaultInfoAsRootNode

getDefaultInfoAsRootNode

getNodesInfo

getExplorerNodeProperties

getResourceProperties

filterResourcesByRegExp

_getMatchingExplorerNode

_getMatchingResource

getUserRights

hasRight

checkLock

_addLockToken

checkUserRight

getUserRight

addResourceCollection

addResourceCollection

getResourceCollectionType

renameObject

renameObject

deleteObject

deleteObject

renameResource

renameResource

copyResource

copyResource

moveObject

moveObject

resourceHistory

restoreResource

resourceExists

resourceExists

setDCMetadata

setDCMetadata

_updateTitleIfNeeded

_updateCreatorIfNeeded

_updateDateIfNeeded

_updateRightsIfNeeded

_updateCoverageIfNeeded

_updateRelationIfNeeded

_updateLanguageIfNeeded

_updateSourceIfNeeded

_updateTypeIfNeeded