Package org.alfresco.repo.virtual.store

Class VirtualStoreImpl

java.lang.Object

org.alfresco.repo.virtual.store.VirtualStoreImpl

All Implemented Interfaces:

VirtualFolderDefinitionResolver, VirtualStore

public class VirtualStoreImpl
extends Object
implements VirtualStore, VirtualFolderDefinitionResolver

Field Summary

Fields inherited from interface org.alfresco.repo.virtual.store.VirtualStore

FILING_OR_MATERIAL_ADHERENCE, MATERIAL_ADHERENCE

Constructor Summary

Constructors

Constructor	Description
VirtualStoreImpl()

Method Summary

Modifier and Type	Method	Description
NodeRef	adhere(Reference reference, int mode)
boolean	canMaterialize(Reference reference)
boolean	canVirtualize(NodeRef nodeRef)
FilingData	createFilingData(Reference parentReference, QName assocTypeQName, QName assocQName, QName nodeTypeQName, Map<QName,Serializable> properties)
Set<AccessPermission>	getAllSetPermissions(Reference reference)
List<ChildAssociationRef>	getChildAssocs(Reference parentReference, Set<QName> childNodeTypeQNames)	Retrieve immediate children references of a given reference where the child nodes are in the given inclusive list.
List<ChildAssociationRef>	getChildAssocs(Reference parentReference, QNamePattern typeQNamePattern, QNamePattern qnamePattern, int maxResults, boolean preload)	Gets all child references associations where the pattern of the association qualified name is an exact match.
List<ChildAssociationRef>	getChildAssocsByPropertyValue(Reference parentReference, QName propertyQName, Serializable value)	Retrieve the immediate children of a given node based on the value of a property of those children.
Collection<ChildAssociationRef>	getChildAssocsWithoutParentAssocsOfType(Reference parentReference, QName assocTypeQName)	Gets the set of child associations of a certain parent node without parent associations of a certain type to other nodes with the same parent! In effect the 'orphans' with respect to a certain association type.
Reference	getChildByName(Reference reference, QName assocTypeQName, String childName)	Get the reference of the virtualized artefact with the given name within the virtual context (only) of the parent reference. The name is case-insensitive as Alfresco has to support case-insensitive clients as standard.
Path	getPath(Reference reference)
Map<QName,Serializable>	getProperties(Reference reference)
NodePermissionEntry	getSetPermissions(Reference reference)
QName	getType(Reference ref)
VirtualUserPermissions	getUserPermissions()
AccessStatus	hasPermission(Reference reference, String perm)	Check that the given authentication has a particular permission for the given virtualized artefact.
AccessStatus	hasPermission(Reference reference, PermissionReference perm)	Check that the given authentication has a particular permission for the given virtualized artefact.
boolean	isVirtual(NodeRef nodeRef)
List<Reference>	list(Reference reference)	Lists all immediate children of the referred virtualized artefact. Note: this could be a long list (and will be trimmed at a pre-configured maximum).
PagingResults<Reference>	list(Reference ref, boolean actual, boolean virtual, boolean files, boolean folders, String pattern, Set<QName> ignoreTypeQNames, Set<QName> ignoreAspectQNames, List<Pair<QName,Boolean>> sortProps, PagingRequest pagingRequest)	Lists page of immediate children of the referred virtualized artefact with optional filtering (exclusion of certain child file/folder subtypes, actual-virtual filtering) and sorting.
PagingResults<Reference>	list(Reference ref, boolean actual, boolean virtual, boolean files, boolean folders, String pattern, Set<QName> searchTypeQNames, Set<QName> ignoreTypeQNames, Set<QName> ignoreAspectQNames, List<Pair<QName,Boolean>> sortProps, PagingRequest pagingRequest)	Lists page of immediate children of the referred virtualized artefact with optional filtering (exclusion of certain child file/folder subtypes, actual-virtual filtering) and sorting. Pattern uses '*' as a wildcard
PagingResults<Reference>	list(Reference ref, boolean actual, boolean virtual, Set<QName> searchTypeQNames, Set<QName> ignoreTypeQNames, Set<QName> ignoreAspectQNames, List<Pair<QName,Boolean>> sortProps, PagingRequest pagingRequest)	Lists page of immediate children of the referred virtualized artefact with optional filtering (exclusion of certain child file/folder subtypes, actual-virtual filtering) and sorting.
NodeRef	materialize(Reference reference)
Collection<NodeRef>	materializeIfPossible(Collection<NodeRef> nodeRefs)
NodeRef	materializeIfPossible(NodeRef nodeRef)
VirtualFolderDefinition	resolveVirtualFolderDefinition(Reference reference)
List<Reference>	search(Reference reference, String namePattern, boolean fileSearch, boolean folderSearch, boolean includeSubFolders)	Perform a search against the name of the files or folders within a virtualized artefact Reference hierarchy.
void	setEnvironment(ActualEnvironment environment)
void	setUserPermissions(VirtualUserPermissions userPermissions)
void	setVirtualizationMethods(List<VirtualizationMethod> methdods)
Reference	virtualize(NodeRef nodeRef)

Methods inherited from class java.lang.Object

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

Constructor Detail

VirtualStoreImpl

public VirtualStoreImpl()

Method Detail

setVirtualizationMethods

public void setVirtualizationMethods(List<VirtualizationMethod> methdods)

setEnvironment

public void setEnvironment(ActualEnvironment environment)

isVirtual

public boolean isVirtual(NodeRef nodeRef)
                  throws VirtualizationException

Specified by:

isVirtual in interface VirtualStore

Throws:

VirtualizationException

canVirtualize

public boolean canVirtualize(NodeRef nodeRef)
                      throws VirtualizationException

Specified by:

canVirtualize in interface VirtualStore

Throws:

VirtualizationException

canMaterialize

public boolean canMaterialize(Reference reference)
                       throws VirtualizationException

Specified by:

canMaterialize in interface VirtualStore

Throws:

VirtualizationException

virtualize

public Reference virtualize(NodeRef nodeRef)
                     throws VirtualizationException

Specified by:

virtualize in interface VirtualStore

Throws:

VirtualizationException

materialize

public NodeRef materialize(Reference reference)
                    throws VirtualizationException

Specified by:

materialize in interface VirtualStore

Throws:

VirtualizationException

materializeIfPossible

public Collection<NodeRef> materializeIfPossible(Collection<NodeRef> nodeRefs)
                                          throws VirtualizationException

Specified by:

materializeIfPossible in interface VirtualStore

Throws:

VirtualizationException

materializeIfPossible

public NodeRef materializeIfPossible(NodeRef nodeRef)
                              throws VirtualizationException

Specified by:

materializeIfPossible in interface VirtualStore

Throws:

VirtualizationException

getChildAssocs

public List<ChildAssociationRef> getChildAssocs(Reference parentReference,
                                                QNamePattern typeQNamePattern,
                                                QNamePattern qnamePattern,
                                                int maxResults,
                                                boolean preload)
                                         throws InvalidNodeRefException

Description copied from interface: VirtualStore

Gets all child references associations where the pattern of the association qualified name is an exact match.

Specified by:

getChildAssocs in interface VirtualStore

Parameters:

parentReference - the parent node - usually a container

typeQNamePattern - the qualified name of the association ( null to ignore)

qnamePattern - the path qualified name (null to ignore)

maxResults - the number of results to get

preload - true if the nodes must be preloaded into the cache

Returns:

Returns a list of ChildAssociationRef instances

Throws:

InvalidNodeRefException - if the node could not be found

See Also:

QName

getChildAssocs

public List<ChildAssociationRef> getChildAssocs(Reference parentReference,
                                                Set<QName> childNodeTypeQNames)

Description copied from interface: VirtualStore

Retrieve immediate children references of a given reference where the child nodes are in the given inclusive list.

Specified by:

getChildAssocs in interface VirtualStore

Parameters:

parentReference - the parent node - usually a container

childNodeTypeQNames - the types that the children may be. Subtypes are not automatically calculated and the list must therefore be exhaustive.

Returns:

Returns a list of ChildAssociationRef instances.

getChildAssocsWithoutParentAssocsOfType

public Collection<ChildAssociationRef> getChildAssocsWithoutParentAssocsOfType(Reference parentReference,
                                                                               QName assocTypeQName)

Description copied from interface: VirtualStore

Gets the set of child associations of a certain parent node without parent associations of a certain type to other nodes with the same parent! In effect the 'orphans' with respect to a certain association type.

Specified by:

getChildAssocsWithoutParentAssocsOfType in interface VirtualStore

assocTypeQName - the association type QName

Returns:

a Collection of child associations

getChildAssocsByPropertyValue

public List<ChildAssociationRef> getChildAssocsByPropertyValue(Reference parentReference,
                                                               QName propertyQName,
                                                               Serializable value)

Description copied from interface: VirtualStore

Retrieve the immediate children of a given node based on the value of a property of those children.

If the property to be searched is multi-valued then will match on any one values.

Please note, the following system maintained properties that cannot be used with this method.

• cm:name - use getChildByName instead
• cm:created
• cm:creator
• cm:modified
• cm:modifier
• sys:node-uuid
• sys:node-dbid
• sys:store-identifier
• sys:store-protocol

Specified by:

getChildAssocsByPropertyValue in interface VirtualStore

Parameters:

parentReference - the parent reference - usually a container

propertyQName - the fully qualified name of the property

value - the value to search for. Must be a simple type such as String, Number, Date or Boolean, it cannot be a collection, a content property, MLText or a float.

Returns:

Returns a list of ChildAssociationRef instances.

getChildByName

public Reference getChildByName(Reference reference,
                                QName assocTypeQName,
                                String childName)
                         throws VirtualizationException

Description copied from interface: VirtualStore

Get the reference of the virtualized artefact with the given name within the virtual context (only) of the parent reference.
The name is case-insensitive as Alfresco has to support case-insensitive clients as standard.

Specified by:

getChildByName in interface VirtualStore

Parameters:

reference - parent Reference

Returns:

the virtual child reference for the given name in the context of the given parent reference

Throws:

VirtualizationException

See Also:

NodeService.getChildByName(org.alfresco.service.cmr.repository.NodeRef, QName, String)

resolveVirtualFolderDefinition

public VirtualFolderDefinition resolveVirtualFolderDefinition(Reference reference)
                                                       throws VirtualizationException

Specified by:

resolveVirtualFolderDefinition in interface VirtualFolderDefinitionResolver

Returns:

the VirtualFolderDefinition of the given Reference considering inner paths

Throws:

VirtualizationException

list

public PagingResults<Reference> list(Reference ref,
                                     boolean actual,
                                     boolean virtual,
                                     boolean files,
                                     boolean folders,
                                     String pattern,
                                     Set<QName> searchTypeQNames,
                                     Set<QName> ignoreTypeQNames,
                                     Set<QName> ignoreAspectQNames,
                                     List<Pair<QName,Boolean>> sortProps,
                                     PagingRequest pagingRequest)
                              throws VirtualizationException

Description copied from interface: VirtualStore

Lists page of immediate children of the referred virtualized artefact with optional filtering (exclusion of certain child file/folder subtypes, actual-virtual filtering) and sorting.
Pattern uses '*' as a wildcard

Specified by:

list in interface VirtualStore

Throws:

VirtualizationException

list

public PagingResults<Reference> list(Reference ref,
                                     boolean actual,
                                     boolean virtual,
                                     boolean files,
                                     boolean folders,
                                     String pattern,
                                     Set<QName> ignoreTypeQNames,
                                     Set<QName> ignoreAspectQNames,
                                     List<Pair<QName,Boolean>> sortProps,
                                     PagingRequest pagingRequest)
                              throws VirtualizationException

Description copied from interface: VirtualStore

Lists page of immediate children of the referred virtualized artefact with optional filtering (exclusion of certain child file/folder subtypes, actual-virtual filtering) and sorting.

Specified by:

list in interface VirtualStore

Throws:

VirtualizationException

list

public PagingResults<Reference> list(Reference ref,
                                     boolean actual,
                                     boolean virtual,
                                     Set<QName> searchTypeQNames,
                                     Set<QName> ignoreTypeQNames,
                                     Set<QName> ignoreAspectQNames,
                                     List<Pair<QName,Boolean>> sortProps,
                                     PagingRequest pagingRequest)
                              throws VirtualizationException

Description copied from interface: VirtualStore

Lists page of immediate children of the referred virtualized artefact with optional filtering (exclusion of certain child file/folder subtypes, actual-virtual filtering) and sorting.

Specified by:

list in interface VirtualStore

Throws:

VirtualizationException

list

public List<Reference> list(Reference reference)
                     throws VirtualizationException

Description copied from interface: VirtualStore

Lists all immediate children of the referred virtualized artefact.
Note: this could be a long list (and will be trimmed at a pre-configured maximum). You should consider using a paging request.

Specified by:

list in interface VirtualStore

Throws:

VirtualizationException

search

public List<Reference> search(Reference reference,
                              String namePattern,
                              boolean fileSearch,
                              boolean folderSearch,
                              boolean includeSubFolders)
                       throws VirtualizationException

Description copied from interface: VirtualStore

Perform a search against the name of the files or folders within a virtualized artefact Reference hierarchy.
Wildcard characters are * and ?.
Warning: Please avoid using this method with any "namePattern" other than "*". Although it works, its performance is poor which is why this method is deprecated.

Specified by:

search in interface VirtualStore

Throws:

VirtualizationException

getProperties

public Map<QName,Serializable> getProperties(Reference reference)
                                            throws VirtualizationException

Specified by:

getProperties in interface VirtualStore

Returns:

all virtual properties of the referred virtualized artefact keyed by their qualified name

Throws:

VirtualizationException

getType

public QName getType(Reference ref)
              throws VirtualizationException

Specified by:

getType in interface VirtualStore

Returns:

qualified type of the referred virtualized artefact

Throws:

VirtualizationException

createFilingData

public FilingData createFilingData(Reference parentReference,
                                   QName assocTypeQName,
                                   QName assocQName,
                                   QName nodeTypeQName,
                                   Map<QName,Serializable> properties)
                            throws VirtualizationException

Specified by:

createFilingData in interface VirtualStore

Returns:

FilingData of the given parent location

Throws:

VirtualizationException

hasPermission

public AccessStatus hasPermission(Reference reference,
                                  String perm)
                           throws VirtualizationException

Description copied from interface: VirtualStore

Check that the given authentication has a particular permission for the given virtualized artefact. (The default behaviour is to inherit permissions)

Specified by:

hasPermission in interface VirtualStore

Returns:

an AccessStatus

Throws:

VirtualizationException

hasPermission

public AccessStatus hasPermission(Reference reference,
                                  PermissionReference perm)
                           throws VirtualizationException

Description copied from interface: VirtualStore

Check that the given authentication has a particular permission for the given virtualized artefact. (The default behaviour is to inherit permissions)

Specified by:

hasPermission in interface VirtualStore

Returns:

an AccessStatus

Throws:

VirtualizationException

setUserPermissions

public void setUserPermissions(VirtualUserPermissions userPermissions)

Parameters:

userPermissions - user permissions

getUserPermissions

public VirtualUserPermissions getUserPermissions()

Returns:

a VirtualUserPermissions clone

getSetPermissions

public NodePermissionEntry getSetPermissions(Reference reference)
                                      throws VirtualizationException

Specified by:

getSetPermissions in interface VirtualStore

Throws:

VirtualizationException

getAllSetPermissions

public Set<AccessPermission> getAllSetPermissions(Reference reference)

Specified by:

getAllSetPermissions in interface VirtualStore

getPath

public Path getPath(Reference reference)
             throws VirtualizationException

Specified by:

getPath in interface VirtualStore

Throws:

VirtualizationException

adhere

public NodeRef adhere(Reference reference,
                      int mode)
               throws VirtualizationException

Specified by:

adhere in interface VirtualStore

Throws:

VirtualizationException