Package org.ametys.plugins.explorer.cmis

Class CMISRootResourcesCollection

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

org.ametys.plugins.explorer.cmis.CMISRootResourcesCollection

All Implemented Interfaces:

ExplorerNode, ResourceCollection, AmetysObject, DataHolder, ModifiableDataHolder, JCRAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableAmetysObject, RemovableAmetysObject, TraversableAmetysObject

public class CMISRootResourcesCollection
extends AbstractAmetysObject
implements JCRAmetysObject, ResourceCollection

AmetysObject implementing the root of CMISResourcesCollections

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPLICATION_ID	application id for resources collections.
static final String	DATA_MOUNT_POINT	Attribute for repository root path
static final String	DATA_PASSWORD	Metadata for user password
static final String	DATA_REPOSITORY_ID	Metadata for repository id
static final String	DATA_REPOSITORY_URL	Metadata for repository url
static final String	DATA_USER	Metadata for user login

Constructor Summary

Constructors

Constructor	Description
CMISRootResourcesCollection(javax.jcr.Node node, String parentPath, CMISTreeFactory factory)	Creates a CMISRootResourcesCollection.

Method Summary

Modifier and Type	Method	Description
String	getApplicationId()	Returns the application id corresponding to this Node.
AmetysObject	getChild(String path)	Retrieves a given child from its relative path.
CollectionIterable<AmetysObject>	getChildren()	Retrieves children of the current object.
ModifiableComposite	getComposite(String compositePath)	Retrieves the composite at the given path
ModifiableComposite	getComposite(String compositePath, boolean createNew)	Retrieves the composite at the given path
protected ModifiableDataHolder	getDataHolder()	Returns the DataHolder of this AmetysObject.
String	getDescription()	Get the description of the application
String	getExplorerPath()	Returns the path of this explorer node in the explorer hierarchy (which is a subset of the whole repository). If this collection is the root explorer node, "" is returned.
String	getIconCls()	Returns the icon css class for this Node.
String	getId()	Retrieves the unique identifier of this AmetysObject. It must be unique in the whole repository and must never be null. It must conform to the URI syntax: <protocol>://<protocol-specific-part>
ModifiableCompositeMetadata	getMetadataHolder()	Returns the root CompositeMetadata of this AmetysObject.
String	getMountPoint()	Get the CMIS mount point
String	getName()	Retrieves the name of the current object.
javax.jcr.Node	getNode()	Gives access to the underlying JCR node.
<A extends AmetysObject> A	getParent()	Returns the parent object in the Ametys hierarchy.
Optional<? extends ModifiableDataHolder>	getParentDataHolder()	Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root
String	getParentPath()	Returns the path of the parent object in the Ametys hierarchy.
String	getPassword()	Get the password to connect to CMIS repository
String	getPath()	Retrieves the path of the current object.
ModifiableRepositoryData	getRepositoryData()	Retrieves the repository data used by this DataHolder
String	getRepositoryId()	Get the CMIS repository id
String	getRepositoryUrl()	Get the CMIS repository URL
String	getResourcePath()	Returns the path of this resource collection in its hierarchy (which is a subset of the whole repository). If this collection is the root collection, "" is returned.
ModifiableDataHolder	getRootDataHolder()	Retrieves the DataHolder that is the root of the current one
String	getUser()	Get the user to connect to CMIS repository
boolean	hasChild(String name)	Tests if this Object has at least one child with the given name.
boolean	hasChildExplorerNodes()	Returns true if this explorer node contains child explorer nodes.
boolean	hasChildResources()	Returns true if this explorer node contains resources.
boolean	needsSave()	Returns true if there is pending changes.
void	remove()	Removes this AmetysObject from the Ametys tree.
void	removeValue(String dataPath)	Removes the stored value of the data at the given path
void	rename(String newName)	Rename the AmetysObject
void	revertChanges()	Discard pending changes and revert to the currently persisted version.
void	saveChanges()	Persists pending changes. If the underlying Node is new, the Session is globally saved.
void	setMountPoint(String mountPoint)	Set a mount point for the CMIS Repository
void	setPassword(String password)	Set a password for the CMIS Repository
void	setRepositoryId(String id)	Set the id of the CMIS repository
void	setRepositoryUrl(String url)	Set the URL of the CMIS repository
void	setUser(String user)	Set a user name for the CMIS Repository
void	setValue(String dataPath, Object value)	Sets the value of the data at the given path
void	setValue(String dataPath, Object value, String dataType)	Sets the value of the data at the given path
<T extends SynchronizationResult> T	synchronizeValues(Map<String,Object> values)	Synchronizes the given values with the current ones

Methods inherited from class org.ametys.plugins.repository.AbstractAmetysObject

dataToJSON, dataToJSON, dataToSAX, dataToSAX, equals, getDataNames, getModelItemTypeExtensionPoint, getType, getValue, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, hasDifferences, hashCode, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ametys.plugins.repository.AmetysObject

equals, hashCode

Methods inherited from interface org.ametys.plugins.repository.data.holder.DataHolder

copyTo, copyTo, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToSAX, dataToSAX, dataToSAX, dataToSAX, getDataNames, getModelItemTypeExtensionPoint, getType, getValue, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, hasDifferences, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple

Methods inherited from interface org.ametys.plugins.repository.TraversableAmetysObject

getChildAt, getChildPosition

Field Details

APPLICATION_ID

public static final String APPLICATION_ID

application id for resources collections.

See Also:

• Constant Field Values

DATA_REPOSITORY_ID

public static final String DATA_REPOSITORY_ID

Metadata for repository id

See Also:

• Constant Field Values

DATA_REPOSITORY_URL

public static final String DATA_REPOSITORY_URL

Metadata for repository url

See Also:

• Constant Field Values

DATA_MOUNT_POINT

public static final String DATA_MOUNT_POINT

Attribute for repository root path

See Also:

• Constant Field Values

DATA_USER

public static final String DATA_USER

Metadata for user login

See Also:

• Constant Field Values

DATA_PASSWORD

public static final String DATA_PASSWORD

Metadata for user password

See Also:

• Constant Field Values

Constructor Details

CMISRootResourcesCollection

public CMISRootResourcesCollection(javax.jcr.Node node,
 String parentPath,
 CMISTreeFactory factory)

Creates a CMISRootResourcesCollection.

Parameters:

node - the node backing this AmetysObject

parentPath - the parentPath in the Ametys hierarchy

factory - the CMISRootResourcesCollectionFactory which created this AmetysObject

Method Details

getChild

public AmetysObject getChild(String path)
                      throws AmetysRepositoryException,
UnknownAmetysObjectException

Description copied from interface: TraversableAmetysObject

Retrieves a given child from its relative path. The path cannot be null, empty nor begin with a '/'.

Specified by:

getChild in interface TraversableAmetysObject

Parameters:

path - the path of the child which can contains a position with. [n] if same name sibling is allowed.

Returns:

the child found.

Throws:

AmetysRepositoryException - if an error occurs.

UnknownAmetysObjectException - if the object does not exist.

getChildren

public CollectionIterable<AmetysObject> getChildren()
                                             throws AmetysRepositoryException

Description copied from interface: TraversableAmetysObject

Retrieves children of the current object.

Specified by:

getChildren in interface TraversableAmetysObject

Returns:

the children or an empty AmetysObjectIterable.

Throws:

AmetysRepositoryException - if an error occurs.

hasChild

public boolean hasChild(String name)
                 throws AmetysRepositoryException

Description copied from interface: TraversableAmetysObject

Tests if this Object has at least one child with the given name.

Specified by:

hasChild in interface TraversableAmetysObject

Parameters:

name - the name to test. Cannot be null nor empty nor begin with a '/' and it cannot contain '/'.

Returns:

true if the named child exists, false otherwise.

Throws:

AmetysRepositoryException - if an error occurs.

getDataHolder

protected ModifiableDataHolder getDataHolder()

Description copied from class: AbstractAmetysObject

Returns the DataHolder of this AmetysObject.

Specified by:

getDataHolder in class AbstractAmetysObject

Returns:

the DataHolder of this AmetysObject

getMetadataHolder

public ModifiableCompositeMetadata getMetadataHolder()

Description copied from interface: MetadataAwareAmetysObject

Returns the root CompositeMetadata of this AmetysObject.

Specified by:

getMetadataHolder in interface MetadataAwareAmetysObject

Specified by:

getMetadataHolder in interface ModifiableMetadataAwareAmetysObject

Returns:

the root CompositeMetadata of this AmetysObject

getIconCls

public String getIconCls()

Description copied from interface: ExplorerNode

Returns the icon css class for this Node.

Specified by:

getIconCls in interface ExplorerNode

Returns:

the icon css class for this Node for rendering in the tree.

getApplicationId

public String getApplicationId()

Description copied from interface: ExplorerNode

Returns the application id corresponding to this Node.

Specified by:

getApplicationId in interface ExplorerNode

Returns:

the application id corresponding to this Node.

getName

public String getName()
               throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the name of the current object.

Specified by:

getName in interface AmetysObject

Returns:

the name.

Throws:

AmetysRepositoryException - if an error occurs.

getParentPath

public String getParentPath()
                     throws AmetysRepositoryException

Description copied from interface: AmetysObject

Returns the path of the parent object in the Ametys hierarchy.

Specified by:

getParentPath in interface AmetysObject

Returns:

the path of the parent object.

Throws:

AmetysRepositoryException - if an error occurs.

getPath

public String getPath()
               throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the path of the current object.

Specified by:

getPath in interface AmetysObject

Returns:

the path.

Throws:

AmetysRepositoryException - if an error occurs.

getNode

public javax.jcr.Node getNode()

Description copied from interface: JCRAmetysObject

Gives access to the underlying JCR node.

Specified by:

getNode in interface JCRAmetysObject

Returns:

the JCR node backing this AmetysObject.

getId

public String getId()

Description copied from interface: AmetysObject

Retrieves the unique identifier of this AmetysObject.
It must be unique in the whole repository and must never be null.
It must conform to the URI syntax:
<protocol>://<protocol-specific-part>

Specified by:

getId in interface AmetysObject

Returns:

the unique identifier of this AmetysObject

hasChildResources

public boolean hasChildResources()
                          throws AmetysRepositoryException

Description copied from interface: ResourceCollection

Returns true if this explorer node contains resources.

Specified by:

hasChildResources in interface ResourceCollection

Returns:

true if this explorer node contains resources.

Throws:

AmetysRepositoryException - if an error occurs.

hasChildExplorerNodes

public boolean hasChildExplorerNodes()
                              throws AmetysRepositoryException

Description copied from interface: ExplorerNode

Returns true if this explorer node contains child explorer nodes.

Specified by:

hasChildExplorerNodes in interface ExplorerNode

Returns:

true if this explorer node contains child explorer nodes.

Throws:

AmetysRepositoryException - if an error occurs.

rename

public void rename(String newName)
            throws AmetysRepositoryException

Description copied from interface: ModifiableAmetysObject

Rename the AmetysObject

Specified by:

rename in interface ModifiableAmetysObject

Parameters:

newName - the new name of the ametys object

Throws:

AmetysRepositoryException - if an error occurs.

remove

public void remove()
            throws AmetysRepositoryException,
RepositoryIntegrityViolationException

Description copied from interface: RemovableAmetysObject

Removes this AmetysObject from the Ametys tree.

Specified by:

remove in interface RemovableAmetysObject

Throws:

AmetysRepositoryException - if an error occurs.

RepositoryIntegrityViolationException - if this AmetysObject is referenced by another objects.

getParent

public <A extends AmetysObject> A getParent()
                                     throws AmetysRepositoryException

Description copied from interface: AmetysObject

Returns the parent object in the Ametys hierarchy.

Specified by:

getParent in interface AmetysObject

Type Parameters:

A - the type of the parent AmetysObject.

Returns:

the parent object or null if current object is the root.

Throws:

AmetysRepositoryException - if an error occurs.

saveChanges

public void saveChanges()
                 throws AmetysRepositoryException

Description copied from interface: ModifiableAmetysObject

Persists pending changes.
If the underlying Node is new, the Session is globally saved.

Specified by:

saveChanges in interface ModifiableAmetysObject

Throws:

AmetysRepositoryException - if an error occurs.

revertChanges

public void revertChanges()
                   throws AmetysRepositoryException

Description copied from interface: ModifiableAmetysObject

Discard pending changes and revert to the currently persisted version.

Specified by:

revertChanges in interface ModifiableAmetysObject

Throws:

AmetysRepositoryException - if an error occurs.

needsSave

public boolean needsSave()
                  throws AmetysRepositoryException

Description copied from interface: ModifiableAmetysObject

Returns true if there is pending changes.

Specified by:

needsSave in interface ModifiableAmetysObject

Returns:

true if there is pending changes.

Throws:

AmetysRepositoryException - if an error occurs.

getResourcePath

public String getResourcePath()
                       throws AmetysRepositoryException

Description copied from interface: ResourceCollection

Returns the path of this resource collection in its hierarchy (which is a subset of the whole repository).
If this collection is the root collection, "" is returned.

Specified by:

getResourcePath in interface ResourceCollection

Returns:

the path of this collection in its hierarchy.

Throws:

AmetysRepositoryException - if an error occurs.

getExplorerPath

public String getExplorerPath()

Description copied from interface: ExplorerNode

Returns the path of this explorer node in the explorer hierarchy (which is a subset of the whole repository).
If this collection is the root explorer node, "" is returned.

Specified by:

getExplorerPath in interface ExplorerNode

Returns:

the path of this node in its hierarchy.

getUser

public String getUser()
               throws AmetysRepositoryException

Get the user to connect to CMIS repository

Returns:

the user login

Throws:

AmetysRepositoryException - if an error occurred

getPassword

public String getPassword()
                   throws AmetysRepositoryException

Get the password to connect to CMIS repository

Returns:

the user password

Throws:

AmetysRepositoryException - if an error occurred

getRepositoryUrl

public String getRepositoryUrl()
                        throws AmetysRepositoryException

Get the CMIS repository URL

Returns:

the CMIS repository URL

Throws:

AmetysRepositoryException - if an error occurred

getRepositoryId

public String getRepositoryId()
                       throws AmetysRepositoryException

Get the CMIS repository id

Returns:

the CMIS repository id

Throws:

AmetysRepositoryException - if an error occurred

getMountPoint

public String getMountPoint()
                     throws AmetysRepositoryException

Get the CMIS mount point

Returns:

the mount point

Throws:

AmetysRepositoryException - if an error occurred

setRepositoryUrl

public void setRepositoryUrl(String url)
                      throws AmetysRepositoryException

Set the URL of the CMIS repository

Parameters:

url - the CMIS repository URL

Throws:

AmetysRepositoryException - if an error occurred

setRepositoryId

public void setRepositoryId(String id)
                     throws AmetysRepositoryException

Set the id of the CMIS repository

Parameters:

id - the CMIS repository id

Throws:

AmetysRepositoryException - if an error occurred

setMountPoint

public void setMountPoint(String mountPoint)

Set a mount point for the CMIS Repository

Parameters:

mountPoint - the mount point path

setUser

public void setUser(String user)

Set a user name for the CMIS Repository

Parameters:

user - the login

setPassword

public void setPassword(String password)

Set a password for the CMIS Repository

Parameters:

password - the password

getDescription

public String getDescription()

Description copied from interface: ExplorerNode

Get the description of the application

Specified by:

getDescription in interface ExplorerNode

Returns:

the description

getComposite

public ModifiableComposite getComposite(String compositePath)
                                 throws IllegalArgumentException,
UnknownTypeException,
BadItemTypeException

Description copied from interface: DataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface DataHolder

Specified by:

getComposite in interface ModifiableDataHolder

Overrides:

getComposite in class AbstractAmetysObject

Parameters:

compositePath - path of the composite to retrieve

Returns:

the composite or null if not exists or is empty

Throws:

IllegalArgumentException - if the given composite path is null or empty

UnknownTypeException - if the type composite is not available for this data holder

BadItemTypeException - if the stored value at the given path is not a composite

getComposite

public ModifiableComposite getComposite(String compositePath,
 boolean createNew)
                                 throws IllegalArgumentException,
UnknownTypeException,
BadItemTypeException

Description copied from interface: ModifiableDataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface ModifiableDataHolder

Parameters:

compositePath - path of the composite to retrieve

createNew - true to create the composite if it does not exist, false otherwise

Returns:

the composite or null if createNew is false and value not exists or is empty

Throws:

IllegalArgumentException - if the given composite path is null or empty

UnknownTypeException - if the type composite is not available for this data holder

BadItemTypeException - if the stored value at the given path is not a composite

synchronizeValues

public <T extends SynchronizationResult> T synchronizeValues(Map<String,Object> values)
                                                      throws UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException

Description copied from interface: ModifiableDataHolder

Synchronizes the given values with the current ones

Specified by:

synchronizeValues in interface ModifiableDataHolder

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

values - the values to synchronize

Returns:

the SynchronizationResult

Throws:

UnknownTypeException - if there is no available type compatible with a given value for this data holder's type extension point

NotUniqueTypeException - if there is more than one available types compatibles with the a value for this data holder's type extension point

BadItemTypeException - if type of the a data doesn't match the corresponding given value to set

setValue

public void setValue(String dataPath,
 Object value)
              throws IllegalArgumentException,
UnknownDataException,
UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException

Description copied from interface: ModifiableDataHolder

Sets the value of the data at the given path

Specified by:

setValue in interface ModifiableDataHolder

Parameters:

dataPath - path of the data

value - the value to set. To empty a value, use ModifiableDataHolder.setValue(String, Object, String) with a null value

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownDataException - if the given the data path is composed of an non existing group

UnknownTypeException - if there is no available type compatible with the given value for this data holder's type extension point

NotUniqueTypeException - if there is more than one available types compatibles with the given value for this data holder's type extension point

BadItemTypeException - if type of the data at the given path doesn't match the given value to set

setValue

public void setValue(String dataPath,
 Object value,
 String dataType)
              throws IllegalArgumentException,
UnknownDataException,
UnknownTypeException,
BadItemTypeException

Description copied from interface: ModifiableDataHolder

Sets the value of the data at the given path

Specified by:

setValue in interface ModifiableDataHolder

Parameters:

dataPath - path of the data

value - the value to set. Give null to empty the value.

dataType - type identifier of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownDataException - if the given data path is composed of an non existing group

UnknownTypeException - if the given type is not available for this data holder's type extension point

BadItemTypeException - if the given type doesn't match the given value to set

removeValue

public void removeValue(String dataPath)
                 throws IllegalArgumentException,
UnknownTypeException,
BadItemTypeException

Description copied from interface: ModifiableDataHolder

Removes the stored value of the data at the given path

Specified by:

removeValue in interface ModifiableDataHolder

Parameters:

dataPath - path of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownTypeException - if the the data to remove is in a group and there is no available type compatible with this group

BadItemTypeException - if the value of the parent of the given path is not an item container

getRepositoryData

public ModifiableRepositoryData getRepositoryData()

Description copied from interface: DataHolder

Retrieves the repository data used by this DataHolder

Specified by:

getRepositoryData in interface DataHolder

Specified by:

getRepositoryData in interface ModifiableDataHolder

Overrides:

getRepositoryData in class AbstractAmetysObject

Returns:

the repository data used by this DataHolder

getParentDataHolder

public Optional<? extends ModifiableDataHolder> getParentDataHolder()

Description copied from interface: DataHolder

Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root

Specified by:

getParentDataHolder in interface DataHolder

Specified by:

getParentDataHolder in interface ModifiableDataHolder

Overrides:

getParentDataHolder in class AbstractAmetysObject

Returns:

the parent of the current DataHolder

getRootDataHolder

public ModifiableDataHolder getRootDataHolder()

Description copied from interface: DataHolder

Retrieves the DataHolder that is the root of the current one

Specified by:

getRootDataHolder in interface DataHolder

Specified by:

getRootDataHolder in interface ModifiableDataHolder

Overrides:

getRootDataHolder in class AbstractAmetysObject

Returns:

the root DataHolder