it.sistematica.isharedoc.service.dms
Interface DocumentManager

All Known Implementing Classes:
DocumentManagerImpl

public interface DocumentManager

The Interface DocumentManager.


Nested Class Summary
static class DocumentManager.CheckSignatureResult
          The Class CheckSignatureResult.
 
Field Summary
static java.util.Comparator<FileClassAttribute> FILECLASS_ATTRIBUTE_COMPARATOR
          The Constant FILECLASS_ATTRIBUTE_COMPARATOR.
static java.lang.String HINT_APPLY_DEST_PERMS
          The Constant HINT_APPLY_DEST_PERMS.
static java.lang.String HINT_REMOVE_PHYSICAL
          The Constant HINT_REMOVE_PHYSICAL.
static java.lang.String HINT_REMOVE_SYS_ATTRIBUTES
          The Constant HINT_REMOVE_SYS_ATTRIBUTES.
 
Method Summary
 DocumentContent addVersionDocument(Document document, java.lang.String name, java.lang.String comments, java.lang.String contentType, java.io.InputStream stream, long size)
          Adds the version document.
 void archiveFolder(Folder folder, java.util.Date archiveDate)
          Archive folder.
 boolean canAdmin(CloudFile cloudFile)
          Can admin.
 boolean canAdmin(File file)
          Can admin.
 void cancelCheckout(Document document)
          Cancel checkout.
 boolean canRead(CloudFile cloudFile)
          Can read.
 boolean canRead(File file)
          Can read.
 boolean canWrite(CloudFile cloudFile)
          Can write.
 boolean canWrite(File file)
          Can write.
 DocumentContent checkin(Document doc, java.lang.String comments)
          Checkin.
 DocumentContent checkin(Document document, java.lang.String name, java.io.InputStream stream, long size, java.lang.String contentType, java.lang.String comments)
          Checkin.
 DocumentContent checkout(Document document)
          Checkout.
 DocumentContent checkout(Document document, java.lang.String name, java.io.InputStream stream, long size, java.lang.String contentType)
          Checkout.
 DocumentContent checkout(Document document, java.lang.String name, java.io.InputStream stream, long size, java.lang.String contentType, java.util.concurrent.TimeUnit expireTimeUnit, long expireDuration)
          Checkout.
 DocumentContent checkout(Document document, java.util.concurrent.TimeUnit expireTimeUnit, long expireDuration)
          Checkout.
 DocumentManager.CheckSignatureResult checkSignature(java.io.InputStream is, java.lang.String attachmentName)
          Check signature.
 void checkTree(File file, boolean traceInfo, boolean repairDuplicatedFolder, boolean repairDuplicatedDocument)
          Check tree.
 void clearAcl(File file)
          Clear acl.
 void clearFileRuleEventQueue()
          Clear file rule event queue.
 void clearHints()
          Clear hints.
 File clone(File fileToClone, File destination, java.lang.String newName, boolean cloneContent, boolean applyDestinationPermission)
          Clone.
 java.io.InputStream convertTif2Pdf(java.io.File tif)
          Convert tif2 pdf.
 void copy(java.io.File sourceFile, File destinationFile)
          Copy.
 DocumentContent createDocument(java.lang.String name, java.lang.String comments, java.lang.String contentType, File parent, ObjectTemplate objectTemplate, ConfidentialityLevel confidentialityLevel, java.io.InputStream stream, long size)
          Creates the document.
 Drive createDrive(java.lang.String name, java.lang.String description, boolean hidden, it.neverworks.security.User owner)
          Creates the drive.
 Folder createFolder(File parent, java.lang.String name)
          Creates the folder.
 Folder createFolder(File parent, java.lang.String name, ObjectTemplate ot)
          Creates the folder.
 java.io.InputStream createItemInstanceWatermark(ItemInstance itemInstance, CloudDocumentVersion documentContent)
          Creates the item instance watermark.
 File createLink(File source, File destination, java.lang.String newName)
          Creates the link.
 File createLink(File source, File destination, java.lang.String newName, java.lang.String note)
          Creates the link.
 RemoteDocument createRemoteFile(CloudFile source, File destination, java.lang.String newName)
          Creates the remote file.
 void delete(File file)
          Delete.
 void delete(java.lang.String fileId)
          Delete.
 void deleteLogicalTree(File file)
          Delete logical tree.
 boolean deleteVersion(DocumentContent content)
          Delete version.
 void destroy(File file)
          Destroy.
 ConfidentialityLevel findConfidentialityLevelId(java.lang.Long confidentialityLevelId)
          Find confidentiality level id.
 ObjectTemplate findObjectTemplateId(java.lang.Long objectTemplateId)
          Find object template id.
 Organization findOrganizationId(java.lang.Long organizationId)
          Find organization id.
 it.neverworks.security.User findUserId(java.lang.String userId)
          Find user id.
 DocumentContent forceCheckin(Document doc)
          Force checkin.
 DocumentManagerImpl.FileAclItem getAcl(CloudFile cloudFile)
          Gets the acl.
 DocumentManagerImpl.FileAclItem getAcl(CloudFile cloudFile, boolean rebuildCache, java.util.List<java.lang.String> trace)
          Gets the acl.
 DocumentManagerImpl.FileAclItem getAcl(File file)
          Gets the acl.
 DocumentManagerImpl.FileAclItem getAcl(File file, boolean rebuildCache, java.util.List<java.lang.String> trace)
          Gets the acl.
 java.util.List<ObjectTemplate> getAuthorizedObjectTemplates()
          Gets the authorized object templates.
 java.util.List<Document> getDocuments(File folder)
          Gets the documents.
 java.lang.Boolean getDriveCanContainsDocuments()
          Gets the drive can contains documents.
 File getFileByFileClassAttribute(java.lang.String attributeName, java.lang.String attributeValue)
          Gets the file by file class attribute.
 FileSet getFileSet(File file, java.lang.String name)
          Gets the file set.
 ItemInstance getFileSetInstance(File file, java.lang.String name)
          Gets the file set instance.
 java.util.List<Folder> getFolders(Folder parent)
          Gets the folders.
 java.util.List<Folder> getTopFolders(Drive drive)
          Gets the top folders.
 Topic getTopicByName(java.lang.String topicName, java.lang.String parentSeparator)
          Gets the topic by name.
 java.lang.Boolean getTopicCanContainsDocuments()
          Gets the topic can contains documents.
 void importFolder(java.lang.String idImport, java.lang.String parentIdImport, java.lang.String uoCreazione, java.lang.String titolazione, java.lang.String oggetto, java.util.Date dataCreazione, java.util.Set<java.lang.String> lettori, java.util.Set<java.lang.String> autori, java.util.Map<java.lang.String,java.lang.Object> variables)
          Import folder.
 void importFolderAttachments(ObjectTemplate objectTemplate, java.lang.String idImport, java.util.Collection<java.io.File> attachments, java.lang.String attachmentDescription)
          Import folder attachments.
 void importFolderMessageInstances(java.lang.String idImport, java.lang.String messageInstancesList)
          Import folder message instances.
 void importFolderRelations(java.lang.String idImport, java.lang.String relations)
          Import folder relations.
 java.lang.Boolean isLocked(CloudFile cloudFile)
          Checks if is locked.
 boolean linkExists(File original, File destination)
          Link exists.
 File load(java.lang.Long id)
          Load.
 Folder loadFolder(java.lang.Long id)
          Load folder.
 DocumentSignatureInfo manageDocumentSignatureInfo(Document document)
          Manage document signature info.
 DocumentSignatureInfo manageDocumentSignatureInfo(Document document, java.util.Date timeStampRef)
          Manage document signature info.
 void move(File file, File destinationFile)
          Move.
 void move(File file, File destinationFile, boolean applyDestinationPermission, boolean removeSystemAttributes)
          Move.
 FilePermission permissionAdd(File file, AccessModeItem access, java.lang.Boolean replaceAll, java.lang.Boolean leaveTrack)
          Permission add.
 FilePermission permissionAdd(File file, Organization organization, AccessModeItem access, java.lang.Boolean includeAscending, java.lang.Boolean replaceAll, java.lang.Boolean leaveTrack)
          Permission add.
 FilePermission permissionAdd(FilePermission permission, java.lang.Boolean applyRecursively, java.lang.Boolean replaceAll, java.lang.Boolean leaveTrack)
          Permission add.
 FilePermission permissionAdd(File file, java.lang.String principalId, AccessModeItem access, java.lang.Boolean replaceAll, java.lang.Boolean leaveTrack)
          Permission add.
 FilePermission permissionAdd(File file, Team team, AccessModeItem access, java.lang.Boolean replaceAll, java.lang.Boolean leaveTrack)
          Permission add.
 FilePermission permissionAdd(File file, it.neverworks.security.User user, AccessModeItem access, java.lang.Boolean replaceAll, java.lang.Boolean leaveTrack)
          Permission add.
 boolean permissionExists(FilePermission permission)
          Permission exists.
 void permissionRemove(File file, java.lang.Boolean leaveTrack)
          Permission remove.
 void permissionRemove(File file, Organization organization, java.lang.Boolean leaveTrack)
          Permission remove.
 void permissionRemove(FilePermission permission, java.lang.Boolean applyRecursively, java.lang.Boolean leaveTrack)
          Permission remove.
 void permissionRemove(File file, java.lang.String principalId, java.lang.Boolean leaveTrack)
          Permission remove.
 void permissionRemove(File file, Team team, java.lang.Boolean leaveTrack)
          Permission remove.
 void permissionRemove(File file, it.neverworks.security.User user, java.lang.Boolean leaveTrack)
          Permission remove.
 void permissionRemoveAll(File file, java.lang.Boolean leaveTrack)
          Permission remove all.
 void permissionsApplyRecursive(File file, boolean mergePermissions, java.lang.Boolean leaveTrack)
          Permissions apply recursive.
 void permissionsCopyFromFile(File from, File to, boolean mergePermissions, java.lang.Boolean leaveTrack)
          Permissions copy from file.
 void ping()
          Ping.
 void processFileRuleEvent(FileRuleEvent event)
          Process file rule event.
 void pushHints(java.util.Properties properties)
          Push hints.
 void reorderMessageBoxFiles(MessageBox messageBox)
          Reorder message box files.
 void repair(File file)
          Repair.
 void save(File file)
          Save.
 void save(File file, boolean applyDestinationPermission)
          Save.
 boolean saveAttribute(File file, java.lang.String fileClassName, java.lang.String attributeName, java.lang.String value)
          Save attribute.
 boolean saveFileClass(File file, java.lang.String fileClassName)
          Save file class.
 void saveHome(IsharedocProfile profile)
          Save home.
 java.util.List<File> searchFiles(java.lang.String queryString, int maxResults)
          Search files.
 void setCheckoutApp(Document.CheckoutApp app)
          Sets the checkout app.
 void TEMP_archiveFolderRecursiveByIdImport(java.lang.String idImport, java.util.Date archiveDate)
          TEM p_archive folder recursive by id import.
 void trash(File file)
          Trash.
 void unarchiveFolder(Folder folder)
          Unarchive folder.
 

Field Detail

HINT_APPLY_DEST_PERMS

static final java.lang.String HINT_APPLY_DEST_PERMS
The Constant HINT_APPLY_DEST_PERMS.

See Also:
Constant Field Values

HINT_REMOVE_SYS_ATTRIBUTES

static final java.lang.String HINT_REMOVE_SYS_ATTRIBUTES
The Constant HINT_REMOVE_SYS_ATTRIBUTES.

See Also:
Constant Field Values

HINT_REMOVE_PHYSICAL

static final java.lang.String HINT_REMOVE_PHYSICAL
The Constant HINT_REMOVE_PHYSICAL.

See Also:
Constant Field Values

FILECLASS_ATTRIBUTE_COMPARATOR

static final java.util.Comparator<FileClassAttribute> FILECLASS_ATTRIBUTE_COMPARATOR
The Constant FILECLASS_ATTRIBUTE_COMPARATOR.

Method Detail

pushHints

void pushHints(java.util.Properties properties)
Push hints.

Parameters:
properties - the properties

clearHints

void clearHints()
Clear hints.


setCheckoutApp

void setCheckoutApp(Document.CheckoutApp app)
Sets the checkout app.

Parameters:
app - the new checkout app

getDriveCanContainsDocuments

java.lang.Boolean getDriveCanContainsDocuments()
Gets the drive can contains documents.

Returns:
the drive can contains documents

getTopicCanContainsDocuments

java.lang.Boolean getTopicCanContainsDocuments()
Gets the topic can contains documents.

Returns:
the topic can contains documents

ping

void ping()
Ping.


checkTree

void checkTree(File file,
               boolean traceInfo,
               boolean repairDuplicatedFolder,
               boolean repairDuplicatedDocument)
Check tree.

Parameters:
file - the file
traceInfo - the trace info
repairDuplicatedFolder - the repair duplicated folder
repairDuplicatedDocument - the repair duplicated document

load

File load(java.lang.Long id)
Load.

Parameters:
id - the id
Returns:
the file

loadFolder

Folder loadFolder(java.lang.Long id)
Load folder.

Parameters:
id - the id
Returns:
the folder

saveHome

void saveHome(IsharedocProfile profile)
Save home.

Parameters:
profile - the profile

save

void save(File file)
Save.

Parameters:
file - the file

save

void save(File file,
          boolean applyDestinationPermission)
Save.

Parameters:
file - the file
applyDestinationPermission - the apply destination permission

move

void move(File file,
          File destinationFile)
Move.

Parameters:
file - the file
destinationFile - the destination file

move

void move(File file,
          File destinationFile,
          boolean applyDestinationPermission,
          boolean removeSystemAttributes)
Move.

Parameters:
file - the file
destinationFile - the destination file
applyDestinationPermission - the apply destination permission
removeSystemAttributes - the remove system attributes

copy

void copy(java.io.File sourceFile,
          File destinationFile)
Copy.

Parameters:
sourceFile - the source file
destinationFile - the destination file

trash

void trash(File file)
Trash.

Parameters:
file - the file

delete

void delete(File file)
Delete.

Parameters:
file - the file

delete

void delete(java.lang.String fileId)
Delete.

Parameters:
fileId - the file id

deleteLogicalTree

void deleteLogicalTree(File file)
Delete logical tree.

Parameters:
file - the file

destroy

void destroy(File file)
Destroy.

Parameters:
file - the file

clone

File clone(File fileToClone,
           File destination,
           java.lang.String newName,
           boolean cloneContent,
           boolean applyDestinationPermission)
Clone.

Parameters:
fileToClone - the file to clone
destination - the destination
newName - the new name
cloneContent - the clone content
applyDestinationPermission - the apply destination permission
Returns:
the file

repair

void repair(File file)
Repair.

Parameters:
file - the file

reorderMessageBoxFiles

void reorderMessageBoxFiles(MessageBox messageBox)
Reorder message box files.

Parameters:
messageBox - the message box

saveFileClass

boolean saveFileClass(File file,
                      java.lang.String fileClassName)
Save file class.

Parameters:
file - the file
fileClassName - the file class name
Returns:
true, if successful

saveAttribute

boolean saveAttribute(File file,
                      java.lang.String fileClassName,
                      java.lang.String attributeName,
                      java.lang.String value)
Save attribute.

Parameters:
file - the file
fileClassName - the file class name
attributeName - the attribute name
value - the value
Returns:
true, if successful

createDrive

Drive createDrive(java.lang.String name,
                  java.lang.String description,
                  boolean hidden,
                  it.neverworks.security.User owner)
Creates the drive.

Parameters:
name - the name
description - the description
hidden - the hidden
owner - the owner
Returns:
the drive

createFolder

Folder createFolder(File parent,
                    java.lang.String name)
Creates the folder.

Parameters:
parent - the parent
name - the name
Returns:
the folder

createFolder

Folder createFolder(File parent,
                    java.lang.String name,
                    ObjectTemplate ot)
Creates the folder.

Parameters:
parent - the parent
name - the name
ot - the ot
Returns:
the folder

createLink

File createLink(File source,
                File destination,
                java.lang.String newName)
Creates the link.

Parameters:
source - the source
destination - the destination
newName - the new name
Returns:
the file

createRemoteFile

RemoteDocument createRemoteFile(CloudFile source,
                                File destination,
                                java.lang.String newName)
Creates the remote file.

Parameters:
source - the source
destination - the destination
newName - the new name
Returns:
the remote document

createLink

File createLink(File source,
                File destination,
                java.lang.String newName,
                java.lang.String note)
Creates the link.

Parameters:
source - the source
destination - the destination
newName - the new name
note - the note
Returns:
the file

linkExists

boolean linkExists(File original,
                   File destination)
Link exists.

Parameters:
original - the original
destination - the destination
Returns:
true, if successful

createDocument

DocumentContent createDocument(java.lang.String name,
                               java.lang.String comments,
                               java.lang.String contentType,
                               File parent,
                               ObjectTemplate objectTemplate,
                               ConfidentialityLevel confidentialityLevel,
                               java.io.InputStream stream,
                               long size)
Creates the document.

Parameters:
name - the name
comments - the comments
contentType - the content type
parent - the parent
objectTemplate - the object template
confidentialityLevel - the confidentiality level
stream - the stream
size - the size
Returns:
the document content

addVersionDocument

DocumentContent addVersionDocument(Document document,
                                   java.lang.String name,
                                   java.lang.String comments,
                                   java.lang.String contentType,
                                   java.io.InputStream stream,
                                   long size)
Adds the version document.

Parameters:
document - the document
name - the name
comments - the comments
contentType - the content type
stream - the stream
size - the size
Returns:
the document content

checkout

DocumentContent checkout(Document document)
Checkout.

Parameters:
document - the document
Returns:
the document content

checkout

DocumentContent checkout(Document document,
                         java.util.concurrent.TimeUnit expireTimeUnit,
                         long expireDuration)
Checkout.

Parameters:
document - the document
expireTimeUnit - the expire time unit
expireDuration - the expire duration
Returns:
the document content

checkout

DocumentContent checkout(Document document,
                         java.lang.String name,
                         java.io.InputStream stream,
                         long size,
                         java.lang.String contentType)
Checkout.

Parameters:
document - the document
name - the name
stream - the stream
size - the size
contentType - the content type
Returns:
the document content

checkout

DocumentContent checkout(Document document,
                         java.lang.String name,
                         java.io.InputStream stream,
                         long size,
                         java.lang.String contentType,
                         java.util.concurrent.TimeUnit expireTimeUnit,
                         long expireDuration)
Checkout.

Parameters:
document - the document
name - the name
stream - the stream
size - the size
contentType - the content type
expireTimeUnit - the expire time unit
expireDuration - the expire duration
Returns:
the document content

checkin

DocumentContent checkin(Document document,
                        java.lang.String name,
                        java.io.InputStream stream,
                        long size,
                        java.lang.String contentType,
                        java.lang.String comments)
Checkin.

Parameters:
document - the document
name - the name
stream - the stream
size - the size
contentType - the content type
comments - the comments
Returns:
the document content

checkin

DocumentContent checkin(Document doc,
                        java.lang.String comments)
Checkin.

Parameters:
doc - the doc
comments - the comments
Returns:
the document content

forceCheckin

DocumentContent forceCheckin(Document doc)
Force checkin.

Parameters:
doc - the doc
Returns:
the document content

cancelCheckout

void cancelCheckout(Document document)
Cancel checkout.

Parameters:
document - the document

deleteVersion

boolean deleteVersion(DocumentContent content)
Delete version.

Parameters:
content - the content
Returns:
true, if successful

archiveFolder

void archiveFolder(Folder folder,
                   java.util.Date archiveDate)
Archive folder.

Parameters:
folder - the folder
archiveDate - the archive date

unarchiveFolder

void unarchiveFolder(Folder folder)
Unarchive folder.

Parameters:
folder - the folder

TEMP_archiveFolderRecursiveByIdImport

void TEMP_archiveFolderRecursiveByIdImport(java.lang.String idImport,
                                           java.util.Date archiveDate)
TEM p_archive folder recursive by id import.

Parameters:
idImport - the id import
archiveDate - the archive date

importFolder

void importFolder(java.lang.String idImport,
                  java.lang.String parentIdImport,
                  java.lang.String uoCreazione,
                  java.lang.String titolazione,
                  java.lang.String oggetto,
                  java.util.Date dataCreazione,
                  java.util.Set<java.lang.String> lettori,
                  java.util.Set<java.lang.String> autori,
                  java.util.Map<java.lang.String,java.lang.Object> variables)
                  throws java.lang.Exception
Import folder.

Parameters:
idImport - the id import
parentIdImport - the parent id import
uoCreazione - the uo creazione
titolazione - the titolazione
oggetto - the oggetto
dataCreazione - the data creazione
lettori - the lettori
autori - the autori
variables - the variables
Throws:
java.lang.Exception - the exception

importFolderRelations

void importFolderRelations(java.lang.String idImport,
                           java.lang.String relations)
                           throws java.lang.Exception
Import folder relations.

Parameters:
idImport - the id import
relations - the relations
Throws:
java.lang.Exception - the exception

importFolderMessageInstances

void importFolderMessageInstances(java.lang.String idImport,
                                  java.lang.String messageInstancesList)
                                  throws java.lang.Exception
Import folder message instances.

Parameters:
idImport - the id import
messageInstancesList - the message instances list
Throws:
java.lang.Exception - the exception

importFolderAttachments

void importFolderAttachments(ObjectTemplate objectTemplate,
                             java.lang.String idImport,
                             java.util.Collection<java.io.File> attachments,
                             java.lang.String attachmentDescription)
                             throws java.lang.Exception
Import folder attachments.

Parameters:
objectTemplate - the object template
idImport - the id import
attachments - the attachments
attachmentDescription - the attachment description
Throws:
java.lang.Exception - the exception

getFileByFileClassAttribute

File getFileByFileClassAttribute(java.lang.String attributeName,
                                 java.lang.String attributeValue)
                                 throws java.lang.Exception
Gets the file by file class attribute.

Parameters:
attributeName - the attribute name
attributeValue - the attribute value
Returns:
the file by file class attribute
Throws:
java.lang.Exception - the exception

convertTif2Pdf

java.io.InputStream convertTif2Pdf(java.io.File tif)
                                   throws java.lang.Exception
Convert tif2 pdf.

Parameters:
tif - the tif
Returns:
the input stream
Throws:
java.lang.Exception - the exception

createItemInstanceWatermark

java.io.InputStream createItemInstanceWatermark(ItemInstance itemInstance,
                                                CloudDocumentVersion documentContent)
                                                throws java.lang.Exception
Creates the item instance watermark.

Parameters:
itemInstance - the item instance
documentContent - the document content
Returns:
the input stream
Throws:
java.lang.Exception - the exception

getAuthorizedObjectTemplates

java.util.List<ObjectTemplate> getAuthorizedObjectTemplates()
Gets the authorized object templates.

Returns:
the authorized object templates

permissionExists

boolean permissionExists(FilePermission permission)
Permission exists.

Parameters:
permission - the permission
Returns:
true, if successful

permissionAdd

FilePermission permissionAdd(File file,
                             AccessModeItem access,
                             java.lang.Boolean replaceAll,
                             java.lang.Boolean leaveTrack)
Permission add.

Parameters:
file - the file
access - the access
replaceAll - the replace all
leaveTrack - the leave track
Returns:
the file permission

permissionAdd

FilePermission permissionAdd(File file,
                             java.lang.String principalId,
                             AccessModeItem access,
                             java.lang.Boolean replaceAll,
                             java.lang.Boolean leaveTrack)
Permission add.

Parameters:
file - the file
principalId - the principal id
access - the access
replaceAll - the replace all
leaveTrack - the leave track
Returns:
the file permission

permissionAdd

FilePermission permissionAdd(File file,
                             Organization organization,
                             AccessModeItem access,
                             java.lang.Boolean includeAscending,
                             java.lang.Boolean replaceAll,
                             java.lang.Boolean leaveTrack)
Permission add.

Parameters:
file - the file
organization - the organization
access - the access
includeAscending - the include ascending
replaceAll - the replace all
leaveTrack - the leave track
Returns:
the file permission

permissionAdd

FilePermission permissionAdd(File file,
                             it.neverworks.security.User user,
                             AccessModeItem access,
                             java.lang.Boolean replaceAll,
                             java.lang.Boolean leaveTrack)
Permission add.

Parameters:
file - the file
user - the user
access - the access
replaceAll - the replace all
leaveTrack - the leave track
Returns:
the file permission

permissionAdd

FilePermission permissionAdd(File file,
                             Team team,
                             AccessModeItem access,
                             java.lang.Boolean replaceAll,
                             java.lang.Boolean leaveTrack)
Permission add.

Parameters:
file - the file
team - the team
access - the access
replaceAll - the replace all
leaveTrack - the leave track
Returns:
the file permission

permissionAdd

FilePermission permissionAdd(FilePermission permission,
                             java.lang.Boolean applyRecursively,
                             java.lang.Boolean replaceAll,
                             java.lang.Boolean leaveTrack)
Permission add.

Parameters:
permission - the permission
applyRecursively - the apply recursively
replaceAll - the replace all
leaveTrack - the leave track
Returns:
the file permission

permissionRemove

void permissionRemove(File file,
                      java.lang.String principalId,
                      java.lang.Boolean leaveTrack)
Permission remove.

Parameters:
file - the file
principalId - the principal id
leaveTrack - the leave track

permissionRemove

void permissionRemove(File file,
                      java.lang.Boolean leaveTrack)
Permission remove.

Parameters:
file - the file
leaveTrack - the leave track

permissionRemove

void permissionRemove(File file,
                      it.neverworks.security.User user,
                      java.lang.Boolean leaveTrack)
Permission remove.

Parameters:
file - the file
user - the user
leaveTrack - the leave track

permissionRemove

void permissionRemove(File file,
                      Organization organization,
                      java.lang.Boolean leaveTrack)
Permission remove.

Parameters:
file - the file
organization - the organization
leaveTrack - the leave track

permissionRemove

void permissionRemove(File file,
                      Team team,
                      java.lang.Boolean leaveTrack)
Permission remove.

Parameters:
file - the file
team - the team
leaveTrack - the leave track

permissionRemove

void permissionRemove(FilePermission permission,
                      java.lang.Boolean applyRecursively,
                      java.lang.Boolean leaveTrack)
Permission remove.

Parameters:
permission - the permission
applyRecursively - the apply recursively
leaveTrack - the leave track

permissionRemoveAll

void permissionRemoveAll(File file,
                         java.lang.Boolean leaveTrack)
Permission remove all.

Parameters:
file - the file
leaveTrack - the leave track

permissionsApplyRecursive

void permissionsApplyRecursive(File file,
                               boolean mergePermissions,
                               java.lang.Boolean leaveTrack)
Permissions apply recursive.

Parameters:
file - the file
mergePermissions - the merge permissions
leaveTrack - the leave track

permissionsCopyFromFile

void permissionsCopyFromFile(File from,
                             File to,
                             boolean mergePermissions,
                             java.lang.Boolean leaveTrack)
Permissions copy from file.

Parameters:
from - the from
to - the to
mergePermissions - the merge permissions
leaveTrack - the leave track

isLocked

java.lang.Boolean isLocked(CloudFile cloudFile)
Checks if is locked.

Parameters:
cloudFile - the cloud file
Returns:
the boolean

getAcl

DocumentManagerImpl.FileAclItem getAcl(CloudFile cloudFile)
Gets the acl.

Parameters:
cloudFile - the cloud file
Returns:
the acl

getAcl

DocumentManagerImpl.FileAclItem getAcl(CloudFile cloudFile,
                                       boolean rebuildCache,
                                       java.util.List<java.lang.String> trace)
Gets the acl.

Parameters:
cloudFile - the cloud file
rebuildCache - the rebuild cache
trace - the trace
Returns:
the acl

canRead

boolean canRead(CloudFile cloudFile)
Can read.

Parameters:
cloudFile - the cloud file
Returns:
true, if successful

canWrite

boolean canWrite(CloudFile cloudFile)
Can write.

Parameters:
cloudFile - the cloud file
Returns:
true, if successful

canAdmin

boolean canAdmin(CloudFile cloudFile)
Can admin.

Parameters:
cloudFile - the cloud file
Returns:
true, if successful

getAcl

DocumentManagerImpl.FileAclItem getAcl(File file)
Gets the acl.

Parameters:
file - the file
Returns:
the acl

getAcl

DocumentManagerImpl.FileAclItem getAcl(File file,
                                       boolean rebuildCache,
                                       java.util.List<java.lang.String> trace)
Gets the acl.

Parameters:
file - the file
rebuildCache - the rebuild cache
trace - the trace
Returns:
the acl

clearAcl

void clearAcl(File file)
Clear acl.

Parameters:
file - the file

canRead

boolean canRead(File file)
Can read.

Parameters:
file - the file
Returns:
true, if successful

canWrite

boolean canWrite(File file)
Can write.

Parameters:
file - the file
Returns:
true, if successful

canAdmin

boolean canAdmin(File file)
Can admin.

Parameters:
file - the file
Returns:
true, if successful

getFolders

java.util.List<Folder> getFolders(Folder parent)
Gets the folders.

Parameters:
parent - the parent
Returns:
the folders

getTopFolders

java.util.List<Folder> getTopFolders(Drive drive)
Gets the top folders.

Parameters:
drive - the drive
Returns:
the top folders

getDocuments

java.util.List<Document> getDocuments(File folder)
Gets the documents.

Parameters:
folder - the folder
Returns:
the documents

getTopicByName

Topic getTopicByName(java.lang.String topicName,
                     java.lang.String parentSeparator)
Gets the topic by name.

Parameters:
topicName - the topic name
parentSeparator - the parent separator
Returns:
the topic by name

searchFiles

java.util.List<File> searchFiles(java.lang.String queryString,
                                 int maxResults)
Search files.

Parameters:
queryString - the query string
maxResults - the max results
Returns:
the list

findUserId

it.neverworks.security.User findUserId(java.lang.String userId)
Find user id.

Parameters:
userId - the user id
Returns:
the user

findOrganizationId

Organization findOrganizationId(java.lang.Long organizationId)
Find organization id.

Parameters:
organizationId - the organization id
Returns:
the organization

findConfidentialityLevelId

ConfidentialityLevel findConfidentialityLevelId(java.lang.Long confidentialityLevelId)
Find confidentiality level id.

Parameters:
confidentialityLevelId - the confidentiality level id
Returns:
the confidentiality level

findObjectTemplateId

ObjectTemplate findObjectTemplateId(java.lang.Long objectTemplateId)
Find object template id.

Parameters:
objectTemplateId - the object template id
Returns:
the object template

getFileSet

FileSet getFileSet(File file,
                   java.lang.String name)
Gets the file set.

Parameters:
file - the file
name - the name
Returns:
the file set

getFileSetInstance

ItemInstance getFileSetInstance(File file,
                                java.lang.String name)
Gets the file set instance.

Parameters:
file - the file
name - the name
Returns:
the file set instance

manageDocumentSignatureInfo

DocumentSignatureInfo manageDocumentSignatureInfo(Document document)
Manage document signature info.

Parameters:
document - the document
Returns:
the document signature info

manageDocumentSignatureInfo

DocumentSignatureInfo manageDocumentSignatureInfo(Document document,
                                                  java.util.Date timeStampRef)
Manage document signature info.

Parameters:
document - the document
timeStampRef - the time stamp ref
Returns:
the document signature info

checkSignature

DocumentManager.CheckSignatureResult checkSignature(java.io.InputStream is,
                                                    java.lang.String attachmentName)
Check signature.

Parameters:
is - the is
attachmentName - the attachment name
Returns:
the check signature result

processFileRuleEvent

void processFileRuleEvent(FileRuleEvent event)
Process file rule event.

Parameters:
event - the event

clearFileRuleEventQueue

void clearFileRuleEventQueue()
Clear file rule event queue.