Package org.ametys.plugins.workspaces.documents.jcr

Class File

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

org.ametys.plugins.repository.jcr.SimpleAmetysObject<FileFactory>

org.ametys.plugins.repository.jcr.SimpleModelAwareAmetysObject<FileFactory>

org.ametys.plugins.repository.jcr.DefaultAmetysObject<FileFactory>

org.ametys.plugins.repository.jcr.DefaultLockableAmetysObject<FileFactory>

org.ametys.plugins.explorer.resources.jcr.JCRResource<FileFactory>

org.ametys.plugins.workspaces.documents.jcr.File

All Implemented Interfaces:

CommentableAmetysObject<Comment>, ModifiableResource, Resource, ACLAmetysObject, AmetysObject, CopiableAmetysObject, ModelAwareAmetysObject, ModifiableModelAwareAmetysObject, DataHolder, ModelAwareDataHolder, ModifiableDataHolder, ModifiableModelAwareDataHolder, DublinCoreAwareAmetysObject, ModifiableDublinCoreAwareAmetysObject, JCRAmetysObject, ModelAwareJCRAmetysObject, LockableAmetysObject, LockAwareAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableACLAmetysObject, ModifiableAmetysObject, RemovableAmetysObject, TagAwareAmetysObject, TaggableAmetysObject, TrashableAmetysObject, DataAndVersionAwareAmetysObject, ModifiableDataAwareVersionableAmetysObject, VersionableAmetysObject, VersionAwareAmetysObject, SiteAwareAmetysObject

public class File
extends JCRResource<FileFactory>
implements CommentableAmetysObject<Comment>, SiteAwareAmetysObject

Implementation of Resource used for document module of workspaces and can handle comments, backed by a JCR node.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	File.PublicLinkToken	Token class representing a composite object with id, creation date, and file id.

Nested classes/interfaces inherited from interface org.ametys.plugins.repository.trash.TrashableAmetysObject

TrashableAmetysObject.MergeComputationMode

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TOKEN_CREATION_DATE_PROPERTY	Creation date property for a token
static final String	TOKEN_FILE_ID_PROPERTY	File id property for a token
static final String	TOKEN_ID	Token id
static final String	TOKEN_ID_PROPERTY	Token id property
static final String	TOKEN_NODE	Token node
static final String	TOKENS_NODE	Tokens node

Fields inherited from class org.ametys.plugins.explorer.resources.jcr.JCRResource

CONTRIBUTOR_NODE_NAME, CREATION_DATE, CREATOR_NODE_NAME

Fields inherited from class org.ametys.plugins.repository.jcr.DefaultAmetysObject

__VERSION_COMPARATOR, PROTECTED_PROPERTIES

Fields inherited from interface org.ametys.plugins.repository.data.holder.ModelAwareDataHolder

ALTERNATIVE_SUFFIX, STATUS_SUFFIX

Fields inherited from interface org.ametys.web.repository.SiteAwareAmetysObject

METADATA_SITE

Constructor Summary

Constructors

Constructor	Description
File(javax.jcr.Node node, String parentPath, FileFactory factory)	Creates an File.

Method Summary

Modifier and Type	Method	Description
Comment	createComment()	Creates a comment
Comment	createComment(String commentId, ZonedDateTime creationDate)	Creates a comment with the given id and creation date This method allow to create a comment from existing data (ex: data import from archive) The id is not generated here, the source is trusted.
File.PublicLinkToken	createToken()	Creates a new token with the current date as the creation date.
Comment	getComment(String commentId)	Get a comment
List<Comment>	getComments(boolean includeNotValidatedComments, boolean includeValidatedComments)	Get the list of available comments (validated, not validated, both or none :))
String	getDescription()	Get the file description
Site	getSite()	Returns this object's site.
String	getSiteName()	Returns this object's site name.
File.PublicLinkToken	getToken()	Retrieves the file token.
boolean	isAutomaticallyGeneratedDescription()	true if the description was automatically generated, false otherwise.
void	setDescription(String description)	Set the file description
void	setIsAutoGeneratedDescription(boolean isAutoGeneratedDescription)	Set to true if the description was automatically generated, false otherwise.
void	setTokens(List<File.PublicLinkToken> tokens)	Stores the list of tokens.

Methods inherited from class org.ametys.plugins.explorer.resources.jcr.JCRResource

copyTo, copyTo, getAuthorFromRevision, getCreationDate, getCreator, getDCContributor, getDCCoverage, getDCCreator, getDCDate, getDCDescription, getDCFormat, getDCIdentifier, getDCLanguage, getDCPublisher, getDCRelation, getDCRights, getDCSource, getDCSubject, getDCTitle, getDCType, getInputStream, getKeywords, getKeywordsAsString, getLastContributor, getLastModified, getLength, getMimeType, getResourcePath, getTags, moveToTrash, restoreFromNode, restoreFromTrash, setCreationDate, setCreator, setData, setDCContributor, setDCCoverage, setDCCreator, setDCDate, setDCDescription, setDCFormat, setDCIdentifier, setDCLanguage, setDCPublisher, setDCRelation, setDCRights, setDCSource, setDCSubject, setDCTitle, setDCType, setKeywords, setKeywords, setLastContributor, setLastModified, setMimeType, tag, untag

Methods inherited from class org.ametys.plugins.repository.jcr.DefaultLockableAmetysObject

getLockOwner, isLocked, lock, setLockInfoOnCurrentContext, unlock

Methods inherited from class org.ametys.plugins.repository.jcr.DefaultAmetysObject

addAllowedGroups, addAllowedProfilesForAnonymous, addAllowedProfilesForAnyConnectedUser, addAllowedUsers, addDeniedGroups, addDeniedProfilesForAnonymous, addDeniedProfilesForAnyConnectedUser, addDeniedUsers, addLabel, checkpoint, copyNode, disallowInheritance, getAllLabels, getAllRevisions, getBaseNode, getBaseVersion, getLabels, getLabels, getNode, getProfilesForAnonymousAndAnyConnectedUser, getProfilesForGroups, getProfilesForUsers, getRevision, getRevisionTimestamp, getRevisionTimestamp, getUnversionedDataHolder, getVersionHistory, isInheritanceDisallowed, removeAllowedGroups, removeAllowedGroups, removeAllowedProfilesForAnonymous, removeAllowedProfilesForAnyConnectedUser, removeAllowedUsers, removeAllowedUsers, removeDeniedGroups, removeDeniedGroups, removeDeniedProfilesForAnonymous, removeDeniedProfilesForAnyConnectedUser, removeDeniedUsers, removeDeniedUsers, removeLabel, restoreFromLabel, restoreFromRevision, switchToLabel, switchToRevision

Methods inherited from class org.ametys.plugins.repository.jcr.SimpleModelAwareAmetysObject

dataToJSON, dataToJSON, dataToJSONForEdition, dataToMap, dataToSAX, dataToSAX, dataToSAXForEdition, getComposite, getComposite, getDataHolder, getDefinition, getDifferences, getDifferences, getDifferences, getDifferences, getExternalComposite, getExternalComposite, getExternalRepeater, getExternalRepeater, getExternalValue, getLocalComposite, getLocalComposite, getLocalRepeater, getLocalRepeater, getLocalValue, getModel, getModelItemTypeExtensionPoint, getParentDataHolder, getRepeater, getRepeater, getRepositoryData, getRootDataHolder, getStatus, getType, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, getValueWithMultiValuedPathSegments, hasDefinition, hasDifferences, hasDifferences, hasDifferences, hasDifferences, hasExternalValue, hasExternalValueOrEmpty, hasLocalValue, hasLocalValueOrEmpty, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple, removeExternalizableMetadataIfExists, removeExternalValue, removeLocalValue, removeValue, setExternalValue, setLocalValue, setStatus, setValue, setValue, synchronizeValues, synchronizeValues, synchronizeValues, synchronizeValues

Methods inherited from class org.ametys.plugins.repository.jcr.SimpleAmetysObject

_getFactory, _invalidateName, _invalidateParentPath, getId, getMetadataHolder, getName, getParent, getParentPath, getPath, needsSave, remove, rename, revertChanges, saveChanges

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

dataToJSON, dataToSAX, equals, getDataNames, getValue, getValueOrDefault, hashCode, 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, getId, getName, getParent, getParentPath, getPath, hashCode

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

copyTo, copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX, getValue, getValueOrDefault, hasValue, hasValueOrEmpty

Methods inherited from interface org.ametys.plugins.repository.jcr.JCRAmetysObject

getNode

Methods inherited from interface org.ametys.plugins.repository.lock.LockableAmetysObject

lock, setLockInfoOnCurrentContext, unlock

Methods inherited from interface org.ametys.plugins.repository.lock.LockAwareAmetysObject

getLockOwner, isLocked

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

dataToJSON, dataToJSON, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX, getDataNames

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

needsSave, rename, revertChanges, saveChanges

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

getRepositoryData, removeValue, synchronizeValues

Methods inherited from interface org.ametys.plugins.repository.metadata.ModifiableMetadataAwareAmetysObject

getMetadataHolder

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

remove

Field Details

TOKENS_NODE

public static final String TOKENS_NODE

Tokens node

See Also:

• Constant Field Values

TOKEN_NODE

public static final String TOKEN_NODE

Token node

See Also:

• Constant Field Values

TOKEN_ID

public static final String TOKEN_ID

Token id

See Also:

• Constant Field Values

TOKEN_ID_PROPERTY

public static final String TOKEN_ID_PROPERTY

Token id property

See Also:

• Constant Field Values

TOKEN_CREATION_DATE_PROPERTY

public static final String TOKEN_CREATION_DATE_PROPERTY

Creation date property for a token

See Also:

• Constant Field Values

TOKEN_FILE_ID_PROPERTY

public static final String TOKEN_FILE_ID_PROPERTY

File id property for a token

See Also:

• Constant Field Values

Constructor Details

File

public File(javax.jcr.Node node,
 String parentPath,
 FileFactory factory)

Creates an File.

Parameters:

node - the node backing this AmetysObject

parentPath - the parentPath in the Ametys hierarchy

factory - the DefaultAmetysObjectFactory which created the AmetysObject

Method Details

getDescription

public String getDescription()

Get the file description

Returns:

the description

setDescription

public void setDescription(String description)

Set the file description

Parameters:

description - the description to set

isAutomaticallyGeneratedDescription

public boolean isAutomaticallyGeneratedDescription()

true if the description was automatically generated, false otherwise.

Returns:

true if the description was automatically generated, false otherwise.

setIsAutoGeneratedDescription

public void setIsAutoGeneratedDescription(boolean isAutoGeneratedDescription)

Set to true if the description was automatically generated, false otherwise.

Parameters:

isAutoGeneratedDescription - true if the description was automatically generated

createComment

public Comment createComment()

Description copied from interface: CommentableAmetysObject

Creates a comment

Specified by:

createComment in interface CommentableAmetysObject<Comment>

Returns:

The new comment

createComment

public Comment createComment(String commentId,
 ZonedDateTime creationDate)

Description copied from interface: CommentableAmetysObject

Creates a comment with the given id and creation date This method allow to create a comment from existing data (ex: data import from archive) The id is not generated here, the source is trusted. Be careful using this method

Specified by:

createComment in interface CommentableAmetysObject<Comment>

Parameters:

commentId - the comment's id

creationDate - the comment's creation date

Returns:

the new comment

getComment

public Comment getComment(String commentId)
                   throws AmetysRepositoryException

Description copied from interface: CommentableAmetysObject

Get a comment

Specified by:

getComment in interface CommentableAmetysObject<Comment>

Parameters:

commentId - The comment

Returns:

The comment

Throws:

AmetysRepositoryException - if error occurs

getComments

public List<Comment> getComments(boolean includeNotValidatedComments,
 boolean includeValidatedComments)
                          throws AmetysRepositoryException

Description copied from interface: CommentableAmetysObject

Get the list of available comments (validated, not validated, both or none :))

Specified by:

getComments in interface CommentableAmetysObject<Comment>

Parameters:

includeNotValidatedComments - true to get the non validated comments.

includeValidatedComments - true to get the validated comment.

Returns:

A non null list of comments on the ametys object.

Throws:

AmetysRepositoryException - if an error occurred

getToken

public File.PublicLinkToken getToken()

Retrieves the file token. The JCR can handle multiple tokens, but only the first one is returned for now.

Returns:

the file token.

setTokens

public void setTokens(List<File.PublicLinkToken> tokens)

Stores the list of tokens.

Parameters:

tokens - the list of tokens.

createToken

public File.PublicLinkToken createToken()

Creates a new token with the current date as the creation date.

Returns:

the created token.

getSiteName

public String getSiteName()
                   throws AmetysRepositoryException

Description copied from interface: SiteAwareAmetysObject

Returns this object's site name.

Specified by:

getSiteName in interface SiteAwareAmetysObject

Returns:

this object's site name.

Throws:

AmetysRepositoryException - if an error occurs.

getSite

public Site getSite()
             throws AmetysRepositoryException

Description copied from interface: SiteAwareAmetysObject

Returns this object's site.

Specified by:

getSite in interface SiteAwareAmetysObject

Returns:

this object's site

Throws:

AmetysRepositoryException - if an error occurs.