org.alfresco.repo.virtual.store

Interface VirtualStore

All Known Implementing Classes:

VirtualStoreImpl

public interface VirtualStore

Interface for public and internal reference operations.

Handles most virtualized Reference meta-data interactions analogous to actual Alfresco public Repository Services.

Author:

Bogdan Horje

See Also:

The Public Repository Services

Field Summary

Fields

Modifier and Type	Field and Description
static int	FILING_OR_MATERIAL_ADHERENCE
static int	MATERIAL_ADHERENCE

Method Summary

Modifier and Type	Method and Description
NodeRef	adhere(Reference reference, int mode)
boolean	canMaterialize(Reference reference)
boolean	canVirtualize(NodeRef nodeRef)
FilingData	createFilingData(Reference reference, QName assocTypeQName, QName assocQName, QName nodeTypeQName, Map<QName,Serializable> properties)
Set<AccessPermission>	getAllSetPermissions(Reference reference)
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>	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>	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 parentReference, 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 reference)
AccessStatus	hasPermission(Reference reference, PermissionReference perm) Check that the given authentication has a particular permission for the given virtualized artefact.
AccessStatus	hasPermission(Reference reference, String 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)
List<Reference>	search(Reference reference, String namePattern, boolean fileSearch, boolean folderSearch, boolean includeSubFolders) Deprecated. FileFolderService.search(NodeRef, String, boolean, boolean, boolean) alignment : for shallow search use list, listFolders, listFiles, searchSimple. For deep listing use listDeepFolders. Avoid calling this method with any name pattern except for "*".
Reference	virtualize(NodeRef nodeRef)

Field Detail

MATERIAL_ADHERENCE

static final int MATERIAL_ADHERENCE

See Also:

Constant Field Values

FILING_OR_MATERIAL_ADHERENCE

static final int FILING_OR_MATERIAL_ADHERENCE

See Also:

Constant Field Values

Method Detail

materializeIfPossible

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

Throws:

VirtualizationException

materializeIfPossible

NodeRef materializeIfPossible(NodeRef nodeRef)
                       throws VirtualizationException

Throws:

VirtualizationException

isVirtual

boolean isVirtual(NodeRef nodeRef)
           throws VirtualizationException

Throws:

VirtualizationException

canVirtualize

boolean canVirtualize(NodeRef nodeRef)
               throws VirtualizationException

Throws:

VirtualizationException

virtualize

Reference virtualize(NodeRef nodeRef)
              throws VirtualizationException

Throws:

VirtualizationException

materialize

NodeRef materialize(Reference reference)
             throws VirtualizationException

Throws:

VirtualizationException

adhere

NodeRef adhere(Reference reference,
               int mode)
        throws VirtualizationException

Throws:

VirtualizationException

canMaterialize

boolean canMaterialize(Reference reference)
                throws VirtualizationException

Throws:

VirtualizationException

getPath

Path getPath(Reference reference)
      throws VirtualizationException

Throws:

VirtualizationException

getProperties

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

Parameters:

reference -

Returns:

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

Throws:

VirtualizationException

getChildByName

Reference getChildByName(Reference parentReference,
                         QName assocTypeQName,
                         String childName)
                  throws VirtualizationException

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.

Parameters:

parentReference - parent Reference

assocTypeQName -

childName -

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)

getChildAssocs

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.

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.

getChildAssocs

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

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

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

getChildAssocsByPropertyValue

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.

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

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.

getChildAssocsWithoutParentAssocsOfType

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.

Parameters:

parent - the parent reference

assocTypeQName - the association type QName

Returns:

a Collection of child associations

list

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

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

Parameters:

ref -

actual -

virtual -

files -

folders -

pattern -

ignoreQNames -

searchTypeQNames -

ignoreAspectQNames -

sortProps -

pagingRequest -

Throws:

VirtualizationException

list

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

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.

Parameters:

ref -

actual -

virtual -

files -

folders -

pattern -

ignoreQNames -

sortProps -

pagingRequest -

Throws:

VirtualizationException

list

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

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.

Throws:

VirtualizationException

list

List<Reference> list(Reference reference)
              throws VirtualizationException

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.

Parameters:

reference -

Throws:

VirtualizationException

search

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

Deprecated. FileFolderService.search(NodeRef, String, boolean, boolean, boolean) alignment : for shallow search use list, listFolders, listFiles, searchSimple. For deep listing use listDeepFolders. Avoid calling this method with any name pattern except for "*".

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.

Parameters:

reference -

namePattern -

fileSearch -

folderSearch -

includeSubFolders -

Throws:

VirtualizationException

getType

QName getType(Reference reference)
       throws VirtualizationException

Parameters:

reference -

Returns:

qualified type of the referred virtualized artefact

Throws:

VirtualizationException

createFilingData

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

Parameters:

reference -

assocTypeQName -

assocQName -

nodeTypeQName -

properties -

Returns:

FilingData of the given parent location

Throws:

VirtualizationException

hasPermission

AccessStatus hasPermission(Reference reference,
                           String perm)
                    throws VirtualizationException

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

Parameters:

reference -

perm -

Returns:

an AccessStatus

Throws:

VirtualizationException

hasPermission

AccessStatus hasPermission(Reference reference,
                           PermissionReference perm)
                    throws VirtualizationException

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

Parameters:

reference -

perm -

Returns:

an AccessStatus

Throws:

VirtualizationException

getSetPermissions

NodePermissionEntry getSetPermissions(Reference reference)
                               throws VirtualizationException

Throws:

VirtualizationException

getAllSetPermissions

Set<AccessPermission> getAllSetPermissions(Reference reference)