org.jahia.modules.external.modules

Class ModulesDataSource

java.lang.Object

org.jahia.modules.external.vfs.VFSDataSource

org.jahia.modules.external.modules.ModulesDataSource

All Implemented Interfaces:

org.jahia.modules.external.ExternalDataSource, org.jahia.modules.external.ExternalDataSource.CanLoadChildrenInBatch, org.jahia.modules.external.ExternalDataSource.Initializable, org.jahia.modules.external.ExternalDataSource.LazyProperty, org.jahia.modules.external.ExternalDataSource.Writable

public class ModulesDataSource
extends org.jahia.modules.external.vfs.VFSDataSource
implements org.jahia.modules.external.ExternalDataSource.Initializable, org.jahia.modules.external.ExternalDataSource.LazyProperty

Data source provider that is mapped to the /modules filesystem folder with deployed Jahia modules.

Since:

7.0

Author:

david

Nested Class Summary

Nested classes/interfaces inherited from interface org.jahia.modules.external.ExternalDataSource

org.jahia.modules.external.ExternalDataSource.AccessControllable, org.jahia.modules.external.ExternalDataSource.CanCheckAvailability, org.jahia.modules.external.ExternalDataSource.CanLoadChildrenInBatch, org.jahia.modules.external.ExternalDataSource.Initializable, org.jahia.modules.external.ExternalDataSource.LazyProperty, org.jahia.modules.external.ExternalDataSource.Referenceable, org.jahia.modules.external.ExternalDataSource.Searchable, org.jahia.modules.external.ExternalDataSource.Writable

Field Summary

Fields

Modifier and Type	Field and Description
static String	CND
static String	CND_SLASH
static String	J_ANALYZER
static String	J_AUTO_CREATED
static String	J_AVAILABLE_QUERY_OPERATORS
static String	J_DEFAULT_VALUES
static String	J_INDEX
static String	J_IS_FACETABLE
static String	J_IS_FULL_TEXT_SEARCHABLE
static String	J_IS_HIDDEN
static String	J_IS_HIERARCHICAL
static String	J_IS_INTERNATIONALIZED
static String	J_IS_QUERY_ORDERABLE
static String	J_ITEM_TYPE
static String	J_MANDATORY
static String	J_MULTIPLE
static String	J_ON_CONFLICT_ACTION
static String	J_ON_PARENT_VERSION
static String	J_PROTECTED
static String	J_REQUIRED_TYPE
static String	J_SCOREBOOST
static String	J_SELECTOR_OPTIONS
static String	J_SELECTOR_TYPE
static String	J_VALUE_CONSTRAINTS
static String	JNT_DEFINITION_FILE
static String	JNT_EDITABLE_FILE
static String	JNT_MIXIN_NODE_TYPE
static String	JNT_NODE_TYPE
static String	JNT_PRIMARY_NODE_TYPE
static HashSet<String>	NODETYPES_TYPES
static String	SOURCE_CODE
protected static String	UNSTRUCTURED_CHILD_NODE
protected static String	UNSTRUCTURED_PROPERTY

Constructor Summary

Constructors

Constructor and Description
ModulesDataSource()

Method Summary

Methods

Modifier and Type	Method and Description
javax.jcr.Binary[]	getBinaryPropertyValues(String path, String propertyName)
List<String>	getChildren(String path) Return the children of the specified path.
List<org.jahia.modules.external.ExternalData>	getChildrenNodes(String path) Return the children of the specified path.
String	getDataType(org.apache.commons.vfs2.FileObject fileObject) Allows to know the nodetype associated to a filetype.
String[]	getI18nPropertyValues(String path, String lang, String propertyName)
org.jahia.modules.external.ExternalData	getItemByIdentifier(String identifier) Return item by identifier
org.jahia.modules.external.ExternalData	getItemByPath(String path) Return item by path.
protected String	getMessage(String message)
protected String	getMessage(String message, Object... args)
String[]	getPropertyValues(String path, String propertyName)
protected File	getRealFile(String relativePath)
protected File	getRealRoot()
Set<String>	getSupportedNodeTypes() Return list of supported node types.
protected Locale	getUILocale()
protected void	invalidateVfsParentCache(String fullFolderPath, File file)
boolean	isNodeType(String name) Test if the name is a known node type in the system.
boolean	itemExists(String path)
void	move(String oldPath, String newPath) Move a file from one path to another one.
void	order(String path, List<String> children) reorder children nodes according to the list passed as parameter
void	removeItemByPath(String path)
void	saveItem(org.jahia.modules.external.ExternalData data)
void	setFileTypeMapping(Map<String,String> fileTypeMapping) Inject mapping of file types to node types
void	setFolderTypeMapping(Map<String,String> folderTypeMapping) Inject mapping of folder name (type) to node types
void	setJcrStoreService(org.jahia.services.content.JCRStoreService jcrStoreService)
void	setModule(org.jahia.data.templates.JahiaTemplatesPackage module) Injection on runtime of the template package associated with this module source provider.
void	setModulesImportExportHelper(ModulesImportExportHelper modulesImportExportHelper)
void	setModulesSourceSpringInitializer(ModulesSourceSpringInitializer modulesSourceSpringInitializer)
void	setRootResource(org.springframework.core.io.Resource root) Set the root folder of this module source
void	setSupportedNodeTypes(Set<String> supportedNodeTypes) Injection of supported node types
void	start()
void	stop()

Methods inherited from class org.jahia.modules.external.vfs.VFSDataSource

getContentType, getFile, getFileContent, getManager, getRoot, getRootPath, isSupportsHierarchicalIdentifiers, isSupportsUuid, setRoot

Methods inherited from class java.lang.Object

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

Field Detail

UNSTRUCTURED_PROPERTY

protected static final String UNSTRUCTURED_PROPERTY

See Also:

Constant Field Values

UNSTRUCTURED_CHILD_NODE

protected static final String UNSTRUCTURED_CHILD_NODE

See Also:

Constant Field Values

CND

public static final String CND

See Also:

Constant Field Values

CND_SLASH

public static final String CND_SLASH

See Also:

Constant Field Values

JNT_EDITABLE_FILE

public static final String JNT_EDITABLE_FILE

See Also:

Constant Field Values

J_AUTO_CREATED

public static final String J_AUTO_CREATED

See Also:

Constant Field Values

J_MANDATORY

public static final String J_MANDATORY

See Also:

Constant Field Values

J_ON_PARENT_VERSION

public static final String J_ON_PARENT_VERSION

See Also:

Constant Field Values

J_PROTECTED

public static final String J_PROTECTED

See Also:

Constant Field Values

J_SELECTOR_TYPE

public static final String J_SELECTOR_TYPE

See Also:

Constant Field Values

J_SELECTOR_OPTIONS

public static final String J_SELECTOR_OPTIONS

See Also:

Constant Field Values

J_REQUIRED_TYPE

public static final String J_REQUIRED_TYPE

See Also:

Constant Field Values

J_VALUE_CONSTRAINTS

public static final String J_VALUE_CONSTRAINTS

See Also:

Constant Field Values

J_DEFAULT_VALUES

public static final String J_DEFAULT_VALUES

See Also:

Constant Field Values

J_MULTIPLE

public static final String J_MULTIPLE

See Also:

Constant Field Values

J_AVAILABLE_QUERY_OPERATORS

public static final String J_AVAILABLE_QUERY_OPERATORS

See Also:

Constant Field Values

J_IS_FULL_TEXT_SEARCHABLE

public static final String J_IS_FULL_TEXT_SEARCHABLE

See Also:

Constant Field Values

J_IS_QUERY_ORDERABLE

public static final String J_IS_QUERY_ORDERABLE

See Also:

Constant Field Values

J_IS_FACETABLE

public static final String J_IS_FACETABLE

See Also:

Constant Field Values

J_IS_HIERARCHICAL

public static final String J_IS_HIERARCHICAL

See Also:

Constant Field Values

J_IS_INTERNATIONALIZED

public static final String J_IS_INTERNATIONALIZED

See Also:

Constant Field Values

J_IS_HIDDEN

public static final String J_IS_HIDDEN

See Also:

Constant Field Values

J_INDEX

public static final String J_INDEX

See Also:

Constant Field Values

J_SCOREBOOST

public static final String J_SCOREBOOST

See Also:

Constant Field Values

J_ANALYZER

public static final String J_ANALYZER

See Also:

Constant Field Values

J_ON_CONFLICT_ACTION

public static final String J_ON_CONFLICT_ACTION

See Also:

Constant Field Values

J_ITEM_TYPE

public static final String J_ITEM_TYPE

See Also:

Constant Field Values

SOURCE_CODE

public static final String SOURCE_CODE

See Also:

Constant Field Values

JNT_NODE_TYPE

public static final String JNT_NODE_TYPE

See Also:

Constant Field Values

JNT_MIXIN_NODE_TYPE

public static final String JNT_MIXIN_NODE_TYPE

See Also:

Constant Field Values

JNT_PRIMARY_NODE_TYPE

public static final String JNT_PRIMARY_NODE_TYPE

See Also:

Constant Field Values

JNT_DEFINITION_FILE

public static final String JNT_DEFINITION_FILE

See Also:

Constant Field Values

NODETYPES_TYPES

public static final HashSet<String> NODETYPES_TYPES

Constructor Detail

ModulesDataSource

public ModulesDataSource()

Method Detail

start

public void start()

Specified by:

start in interface org.jahia.modules.external.ExternalDataSource.Initializable

invalidateVfsParentCache

protected void invalidateVfsParentCache(String fullFolderPath,
                            File file)

stop

public void stop()

Specified by:

stop in interface org.jahia.modules.external.ExternalDataSource.Initializable

getChildren

public List<String> getChildren(String path)
                         throws javax.jcr.RepositoryException

Return the children of the specified path.

Specified by:

getChildren in interface org.jahia.modules.external.ExternalDataSource

Overrides:

getChildren in class org.jahia.modules.external.vfs.VFSDataSource

Parameters:

path - path of which we want to know the children

Returns:

the children of the specified path

Throws:

javax.jcr.RepositoryException

getChildrenNodes

public List<org.jahia.modules.external.ExternalData> getChildrenNodes(String path)
                                                               throws javax.jcr.RepositoryException

Return the children of the specified path.

Specified by:

getChildrenNodes in interface org.jahia.modules.external.ExternalDataSource.CanLoadChildrenInBatch

Overrides:

getChildrenNodes in class org.jahia.modules.external.vfs.VFSDataSource

Parameters:

path - path of which we want to know the children

Returns:

the children of the specified path

Throws:

javax.jcr.RepositoryException

getDataType

public String getDataType(org.apache.commons.vfs2.FileObject fileObject)
                   throws org.apache.commons.vfs2.FileSystemException

Allows to know the nodetype associated to a filetype.

Overrides:

getDataType in class org.jahia.modules.external.vfs.VFSDataSource

Parameters:

fileObject - the file object that we want to know the associated nodetype

Returns:

the associated nodetype

Throws:

org.apache.commons.vfs2.FileSystemException

isNodeType

public boolean isNodeType(String name)

Test if the name is a known node type in the system.

Parameters:

name -

Returns:

getItemByIdentifier

public org.jahia.modules.external.ExternalData getItemByIdentifier(String identifier)
                                                            throws javax.jcr.ItemNotFoundException

Return item by identifier

Specified by:

getItemByIdentifier in interface org.jahia.modules.external.ExternalDataSource

Overrides:

getItemByIdentifier in class org.jahia.modules.external.vfs.VFSDataSource

Parameters:

identifier -

Returns:

Throws:

javax.jcr.ItemNotFoundException

getItemByPath

public org.jahia.modules.external.ExternalData getItemByPath(String path)
                                                      throws javax.jcr.PathNotFoundException

Return item by path.

Specified by:

getItemByPath in interface org.jahia.modules.external.ExternalDataSource

Overrides:

getItemByPath in class org.jahia.modules.external.vfs.VFSDataSource

Parameters:

path -

Returns:

Throws:

javax.jcr.PathNotFoundException

itemExists

public boolean itemExists(String path)

Specified by:

itemExists in interface org.jahia.modules.external.ExternalDataSource

Overrides:

itemExists in class org.jahia.modules.external.vfs.VFSDataSource

getSupportedNodeTypes

public Set<String> getSupportedNodeTypes()

Return list of supported node types.

Specified by:

getSupportedNodeTypes in interface org.jahia.modules.external.ExternalDataSource

Overrides:

getSupportedNodeTypes in class org.jahia.modules.external.vfs.VFSDataSource

Returns:

removeItemByPath

public void removeItemByPath(String path)
                      throws javax.jcr.RepositoryException

Specified by:

removeItemByPath in interface org.jahia.modules.external.ExternalDataSource.Writable

Overrides:

removeItemByPath in class org.jahia.modules.external.vfs.VFSDataSource

Throws:

javax.jcr.RepositoryException

move

public void move(String oldPath,
        String newPath)
          throws javax.jcr.RepositoryException

Move a file from one path to another one. If file is of type CND the definitions will be first remove from the registry.

Specified by:

move in interface org.jahia.modules.external.ExternalDataSource.Writable

Overrides:

move in class org.jahia.modules.external.vfs.VFSDataSource

Parameters:

oldPath -

newPath -

Throws:

javax.jcr.PathNotFoundException

javax.jcr.RepositoryException

getMessage

protected String getMessage(String message)

getMessage

protected String getMessage(String message,
                Object... args)

getUILocale

protected Locale getUILocale()

order

public void order(String path,
         List<String> children)
           throws javax.jcr.RepositoryException

reorder children nodes according to the list passed as parameter

Specified by:

order in interface org.jahia.modules.external.ExternalDataSource.Writable

Overrides:

order in class org.jahia.modules.external.vfs.VFSDataSource

Parameters:

path -

children -

Throws:

javax.jcr.PathNotFoundException

javax.jcr.RepositoryException

saveItem

public void saveItem(org.jahia.modules.external.ExternalData data)
              throws javax.jcr.RepositoryException

Specified by:

saveItem in interface org.jahia.modules.external.ExternalDataSource.Writable

Overrides:

saveItem in class org.jahia.modules.external.vfs.VFSDataSource

Throws:

javax.jcr.RepositoryException

setFileTypeMapping

public void setFileTypeMapping(Map<String,String> fileTypeMapping)

Inject mapping of file types to node types

Parameters:

fileTypeMapping -

setFolderTypeMapping

public void setFolderTypeMapping(Map<String,String> folderTypeMapping)

Inject mapping of folder name (type) to node types

Parameters:

folderTypeMapping -

setRootResource

public void setRootResource(org.springframework.core.io.Resource root)

Set the root folder of this module source

Parameters:

root -

setSupportedNodeTypes

public void setSupportedNodeTypes(Set<String> supportedNodeTypes)

Injection of supported node types

Parameters:

supportedNodeTypes -

setModule

public void setModule(org.jahia.data.templates.JahiaTemplatesPackage module)

Injection on runtime of the template package associated with this module source provider.

Parameters:

module -

getPropertyValues

public String[] getPropertyValues(String path,
                         String propertyName)
                           throws javax.jcr.PathNotFoundException

Specified by:

getPropertyValues in interface org.jahia.modules.external.ExternalDataSource.LazyProperty

Throws:

javax.jcr.PathNotFoundException

getI18nPropertyValues

public String[] getI18nPropertyValues(String path,
                             String lang,
                             String propertyName)
                               throws javax.jcr.PathNotFoundException

Specified by:

getI18nPropertyValues in interface org.jahia.modules.external.ExternalDataSource.LazyProperty

Throws:

javax.jcr.PathNotFoundException

getBinaryPropertyValues

public javax.jcr.Binary[] getBinaryPropertyValues(String path,
                                         String propertyName)
                                           throws javax.jcr.PathNotFoundException

Specified by:

getBinaryPropertyValues in interface org.jahia.modules.external.ExternalDataSource.LazyProperty

Throws:

javax.jcr.PathNotFoundException

getRealFile

protected File getRealFile(String relativePath)
                    throws org.apache.commons.vfs2.FileSystemException

Throws:

org.apache.commons.vfs2.FileSystemException

getRealRoot

protected File getRealRoot()

setJcrStoreService

public void setJcrStoreService(org.jahia.services.content.JCRStoreService jcrStoreService)

setModulesSourceSpringInitializer

public void setModulesSourceSpringInitializer(ModulesSourceSpringInitializer modulesSourceSpringInitializer)

setModulesImportExportHelper

public void setModulesImportExportHelper(ModulesImportExportHelper modulesImportExportHelper)