# All Classes and Interfaces

Class
Description
AbiWordParser
Text extractor for AbiWord documents.
AbstractAttributeSet
A base class for attribute sets and templates
AbstractAuthenticator
A place to put common methods of the authenticators
AbstractDocument
The Document is the central entity of LogicalDOC.
AbstractDocumentHistory
A superclass for those histories tightly related to documents
AbstractDocumentProcessor
A base implementation for those tasks that process documents
AbstractFormatConverter
Abstract format converter.
AbstractJob
This represents a unit of work to be scheduled in Quartz
AbstractParser
Abstract implementation of a Parser
AbstractStore
Common methods for all the Store implementations.
AbstractThumbnailBuilder
Main starting point for all thumbnail builders
AccessControlEntry
Represents all the permissions granted to a group against a business object
AccountDisabledException
Raised when the account exists but it is disabled
AccountExpiredException
Raised when the account is expired
AccountInactiveException
Raised when the account is interpreted as inactive because it was not interacting since a lot of days
AccountNotFoundException
Raised when the specified user was not found
AccountTypeNotAllowedException
Raised when trying to enter with an account of a unknown type
AdminAuthenticationProvider
This `AuthenticationProvider` checks if the provided password matches the context property 'adminpswd' in cases when the database is not available or the max concurrent sessions number is reached.
AnonymousLoginFilter
ApiKey
A secret key to use when connecting to the Webservices API
ApiKeyAuthenticator
This authenticator uses the API Key
ApiKeyBlockedException
Raised when the remote client is in the black list
ApiKeyDAO
DAO for `ApiKey` handling.
Aspect
Enumeration of relevant aspects
AspectDisabledException
Raised when an aspect is disabled
Attribute
This class defines the value of an attribute associated to an extensible object.
AttributeOption
Represents an option for a multi-choice attribute
AttributeOptionDAO
DAO for `AttributeOption` handling.
AttributeSet
Represents a set of attributes
AttributeSetDAO
This class is a DAO-service for attribute sets.
AuthenticationChain
This authentication component implements a chain of possible authentication sources that will be invoked sequentially.
AuthenticationException
A generic exception during the authentication process
Authenticator
Implementations of this interface must provide authentication of a user against a defined source.
AuthorizationException
A generic exception for handling unauthorized accesses
Automation
Represents the automation scripting engine
AutomationDateTool
Utility class to handle dates from inside the Automation
AutomationDictionary
Marks a class to be added to the automation dictionary
AutomationException
Error happening during automation execution
AutomationNumberTool
Extension of the standard NumberTool that allows the locale specification as string.
Bookmark
A bookmark over a document
BookmarkDAO
DAO service for bookmarks
CatchAllParser
Parser that tries to convert the document into PDF and then tries to parse it
ChainFiller
A filler that fills using a list of other fillers
ClassTool
Utility functions for manipulating classes and resources and for other programming language aspects
Client
A remote client connected to LogicalDOC
CollectionTool
Utility methods to handle collections
CompressedArchiveConverter
A base class for those converters that operate on compressed archives
ConditionalBasicAuthenticationFilter
An filter for the basic authentication that is enabled or not depending on a boolean configuration parameter.
ConnectionPool
A configurable connection pool that wraps different technologies, you decide the implementation through the implementation setting: hikari or dbcp
Contact
A generic contact represented by a set of personal informations.
ContactDAO
Instances of this class is a DAO-service for Contact business entities.
ContextInitializer
A super class for those initializers that prepare the environment for execution when the Context has been initialized and the database connected.
ContextTool
Utility methods to access the Application context from inside the Automation
CoreContext
Context of the core plugin
CorePlugin
Plugin class for the Core plugin
Dashlet
Represents a sub-window of a dashboard
DashletContent
This servlet is responsible for rendering dashlet's contents.
DashletDAO
Instances of this class is a DAO-service for dashlet objects.
DateBean
This class converts a date into some formats.
DbcpConfiguration
Configuration bean for DBCP
DefaultAuthenticator
This is the basic authentication mechanism, that searches for the user in the LogicalDOC database.
DefaultSchedulerFactory
Scheduler factory to enable/disable the scheduler depending on the runlevel.
Device
Represents a device with wich a user connects to the platform
DeviceDAO
A DAO to handle the devices
DigestProcessor
This task takes care of calculating the documents digest
DOCParser
Parses a MS Word (*.doc, *.dot) file to extract the text contained in the file.
DocTool
Utility methods to handle documents from within Automation
Document
Basic concrete implementation of `AbstractDocument`
DocumentAccessControlEntry
Represents all the permissions granted to a group against a business object
DocumentComparator
Comparators to sort documents with different options
DocumentDAO
This class is a DAO-service for documents.
DocumentEvent
Possible events in the document's history
DocumentFuture
A future used to track asynchronous elaborations on a document.
DocumentHistory
Registers an event on folder or document
DocumentHistoryDAO
DAO for `DocumentHistory` handling.
DocumentInitializer
This listener takes care of initializing the metadata of a document.
DocumentLink
Represents a document link.
DocumentLinkDAO
DAO for `DocumentLink` handling.
DocumentListener
This interface defines hooks called before and after a particular event occurs on the specified document.
DocumentListenerManager
A manager for document listeners.
DocumentManager
Basic Implementation of `DocumentManager`
DocumentNote
A note over a document
DocumentNoteDAO
DAO for `DocumentNote` handling.
DocumentProcessorCallable<T>
A callable to provide for processing a segment of documents
DocumentProcessorStats
Statistics related to a document processing
DocumentStatus
DocumentValidator
This listener takes care of logically validate a document.
DocUtil
Some utility methods for documents.
DummyParser
Parser that doesn't parse anything
DummyScheduler
DuplicateDocumentException
Used to declare a duplicated insert
EMail
A represetnation of an Email message.
EMailAttachment
An attachment of an email message
EMailSender
SMTP E-Mail sender service
EmbeddingStatus
If a document can or cannot be indexed
EpubParser
A specialized parser to extract text from .epub(e-books) format
EpubThumbnailBuilder
This builder generates the thumbnail for a .epub(e-book) document.
EventCollector
A collector of events that can distribute them to a set of listeners
EventListener
A listener for the event emitted by the collector
ExtendedAccessControlEntry
Class for grouping common permissions for `DocumentAccessControlEntry` and `FolderAccessControlEntry`
Extensible
Interface to be implemented by those `PersistentObject`s that have extensible attribtues
ExtensibleObject
An extensible object is able to store an indeterminate number of attributes.
Feature
Enumeration of relevant feature codes
FeatureDisabledException
Raised when trying to use a disabled feature
Fillable
An abstract extension of `ExtensibleObject` that adds the necessary to support autofill
Filler
A Filler implements its own logic to auto-fill the metadata of an `ExtensibleObject`
FillerDAO
This interface is a DAO-service for `Filler`s
FilteredAnalyzer
This analyzer is a wrapper to be used to handle an ordered list of filters.
Folder
This class represents the key concept of security of documents.
FolderAccessControlEntry
Represents all the permissions granted to a group against a business object
FolderComparator
Comparators to sort folders with different options
FolderCriterion
FolderDAO
Instances of this class is a DAO-service for folder objects.
FolderEvent
Possible events in the folder's history
FolderHistory
History entry due to an event on a folder.
FolderHistoryDAO
DAO for `FolderHistory`s handling.
FolderInitializer
This listener takes care of initializing the metadata of a folder.
FolderListener
This interface defines hooks called before and after a particular event occurs on the specified folder.
FolderListenerManager
A manager for folder listeners.
FolderSearch
Search specialization for Folder searches.
FolderSearchOptions
Search options specialization for the folder search.
FolderTool
Utility methods to handle folders from within the Automation
FolderValidator
This listener takes care of logically validate a folder.
ForbiddenCodeException
Exception raised when suspicious code has been detected
ForbiddenImpersonationException
Raised when someone tries to impersonate another user without permission
FormatConversionManager
Manager class used to handle format converters.
FormatConverter
Implementations of this interface are specialized classes that perform conversion from a source format to a target format.
FSStore
This class is an implementation of the Store interface to persist documents in the filesystem.
FulltextSearch
Search specialization for the Full text search.
FulltextSearchOptions
Search options specialization for the Full text search.
Generic
Instances of this class represents generic informations in the database.
GenericDAO
Instances of this class is a DAO-service for Generic business entities.
Geolocation
A class to concentrate the Geolocation operations and at the same time a factory to create beans that carry the geolocation of an IP address.
GhostscriptConverter
Converter to convert PDF into image
GhostUtil
Utility method for using GhostScript
Group
This class represents groups.
GroupDAO
GroupType
HibernateApiKeyDAO
Hibernate implementation of `ApiKeyDAO`
HibernateAttributeOptionDAO
Hibernate implementation of `AttributeOptionDAO`
HibernateAttributeSetDAO
Hibernate implementation of `TemplateDAO`
HibernateBookmarkDAO
Hibernate implementation of `BookmarkDAO`
HibernateContactDAO
Hibernate implementation of `ContactDAO`
HibernateDashletDAO
Hibernate implementation of `DashletDAO`
HibernateDeviceDAO
An Hibernate based implementation of `DeviceDAO`
HibernateDocumentDAO
Hibernate implementation of `DocumentDAO`
HibernateDocumentHistoryDAO
Hibernate implementation of `HistoryDAO`
HibernateDocumentLinkDAO
Hibernate implementation of `DocumentLinkDAO`
HibernateDocumentNoteDAO
Hibernate implementation of `DocumentNoteDAO`
HibernateFillerDAO
Hibernate implementation of `FillerDAO`
HibernateFolderDAO
Hibernate implementation of `FolderDAO`
HibernateFolderHistoryDAO
Hibernate implementation of `FolderHistoryDAO`
HibernateGenericDAO
Hibernate implementation of `GenericDAO`
HibernateGroupDAO
Hibernate implementation of `GroupDAO`
HibernateHistoryDAO<T>
Parent of all DAOs that handle histories
HibernateMenuDAO
Hibernate implementation of `MenuDAO`
HibernateMessageTemplateDAO
Hibernate implementation of `MessageTemplateDAO`
HibernatePasswordHistoryDAO
Hibernate implementation of `PasswordHistoryDAO`
HibernatePersistentObjectDAO<T>
Hibernate implementation of `PersistentObjectDAO`
HibernateRatingDAO
Hibernate implementation of `RatingDAO`
HibernateSearchDAO
Hibernate implementation of `SearchDAO`
HibernateSequenceDAO
Hibernate implementation of `SequenceDAO`.
HibernateSessionDAO
HibernateSystemMessageDAO
Hibernate implementation of `SystemMessageDAO`
HibernateTemplateDAO
Hibernate implementation of `TemplateDAO`
HibernateTenantDAO
HibernateTicketDAO
Hibernate implementation of `TicketDAO`
HibernateUserDAO
Hibernate implementation of `UserDAO`
HibernateUserHistoryDAO
HibernateVersionDAO
Hibernate implementation of `VersionDAO`
History
Superclass for history entries
Hit
Search result
HitField
Models the field names that can be stored in the index
Hits
Iterator on the collection of hits, plus some statistical informations about the query.
HTMLParser
Text extractor for HyperText Markup Language (HTML).
HttpTool
Utility methods to call URLs
I18NTool
Utility class to handle translations from inside Automation
IconSelector
Utility class to select an icon based on a file extension
Ifnotnull
Ifnull
ImageConverter
Converter to convert image files in PDF
ImageThumbnailBuilder
Takes care of images thumbnail builder
ImageUtil
Utility methods for handling images
ImageZone
A zone specification inside an image.
IndexerStats
Statistics of an indexing
IndexerTask
This task enlists all non-indexed documents and performs the indexing
IndexException
An error happened during indexing
IndexingStatus
Inf a document is indexed or cannotbe indexed
IndexOptimizer
This task optimizes all indexes
Initializer
An Initializer performs the checks on a generic `ExtensibleObject`
InMemoryZipImport
This is an import utilities that imports documents stored in a zip archive.
InvalidSessionException
Raised when a session is not valid
IPBlockedException
Raised when the remote client is in the black list
JobManager
Facade on Quartz scheduler
KOfficeParser
Text extractor for KOffice 1.6 documents.
Language
Instances of this class represent a language supported by the LogicalDOC DMS
LanguageManager
A manager for all supported languages.
LanguageProcessor
Processor that takes care to store the language field of an incoming hit into a thread local variable.
LanguageProcessorFactory
Basic factory needed to instantiate the LanguageProcessor
LastModifiedInterceptor
An `Interceptor` that takes care about updating the last modified date of a persistence object
LDAuthenticationDetails
Our customization of an `AuthenticationDetails` used to extract a third authentication parameter for the 2FA.
LDAuthenticationDetailsSource
Our customization of an `AuthenticationDetailsSource` used to extract a third authentication parameter for the 2FA.
LDAuthenticationFailureHandler
This handler gets the j_failureurl request parameter and use it's value to redirect the user after a successful login.
LDAuthenticationProvider
This Authentication provider users the `AuthenticationChain` to authenticate the users.
LDAuthenticationSuccessHandler
This handler gets the j_successurl request parameter and use it's value to redirect the user after a successful login.
LDAuthenticationToken
A LogicalDOC aware authentication token
LDDeferredSecurityContext
LDSecurityContextRepository
This makes use of sessions but also uses our request-sid binding.
LockManager
Central class to manage locks
LoginThrottle
Utility methods to prevent brute force attacks
LogTool
Simple utility class to give access to the system's log from within the Automation
MailTool
Utility functions to handle emails and send messages from within the Automation
MailUtil
Utility methods for handling emails
MarkdownConverter
Converter to convert Markdown files to PDF or HTML
MarkdownParser
Text extractor for the Markdown language.
Menu
This class represents the key concept of security.
MenuDAO
Instances of this class is a DAO-service for menu objects.
MergeUtil
An utility to merge files
Message
This is the parent class for email and system message.
MessageTemplate
A template for messaging purposes.
MessageTemplateDAO
This is a DAO service for MessageTemplate.
Microsoft365TokenProvider
A TokenProvider used to access the Exchange Online (Microsoft 365)
MockFiller
A Filler that does nothing
MockStore
This is basically a `FSStore` but with a flag that if active makes the store method to return an exception
MonitoredCallable<V>
A callable that is identified by a unique name and whose running statyus is monitorable
Mp3ThumbnailBuilder
Takes care of mp3 thumbnail builder
NamedParameterStatement
This class wraps around a `PreparedStatement` and allows the programmer to set parameters by name instead of by index.
NamedThreadFactory
This thread factory acts like `Executors.defaultThreadFactory()` but gives a name prefix to the new thread.
NoConversionConverter
A converter that simply copies the source to the destination
NotAvailableConverter
A converter that always convert into a static PDF that says 'not available'
NoteAccessControlEntry
Class for permissions of `DocumentNote`
NotifyingThread<T>
A Thread that notifies it's listeners about the end of the elaboration and also measures the execution time.
NotifyingThread.ThreadCompleteListener<T>
Interface to be implemented by the listeners
OpenOfficeParser
Text extractor for OpenOffice/OpenDocument documents.
OutsideWorkingTimeException
Raised when the user is trying to enter outside the working time
P7MConverter
Converter to convert image files in PDF
ParseParameters
Some parameters to parse documents
Parser
A Parser is capable of parsing a content in order to extract the texts and other metadata within it.
ParserFactory
This is a factory, returning a parser instance for the given file.
ParsingException
When an error happens during the parsing
ParsingTimeoutException
A parsing error due to timeout
PasswordAlreadyUsedException
Raised when you try to change password that was already used
PasswordExpiredException
Raised when the password has expired
PasswordHistory
This class represent an old password of a user
PasswordHistoryDAO
This class is a DAO-service for PasswordHistory-objects.
PasswordWeakException
Raised when you try to change or use a password that is too weak
PathCalculator
This task calculate the path attributes of the folders(only those folders without path will be processed.
PDFImageExtractor
This utility class allows the extraction of raster images from a PDF document
PDFParser
Text extractor for Portable Document Format (PDF).
PdfThumbnailBuilder
This builder generates the thumbnail for a Pdf document.
Permission
Models a permission, that is the ability to do something
READ: permission to read WRITE: permission to modify ADD: permission to add child elements SECURITY: permission to change security rules IMMUTABILE: permission to mark a document as immutable DELETE: permission to delete RENAME: permission to rename IMPORT: permission to import EXPORT: permission to export DOWNLOAD: permission to download SIGN: permission to digitally sign ARCHIVE: permission to archive WORKFLOW: permission to handle workflow CALENDAR: permission to handle calendar events SUBSCRIPTION: permission to handle events subscription PRINT: permission to print PASSWORD: permission to put a password MOVE: permission to move EMAIL: permission to send emails AUTOMATION: permission to handle the automation STORE: permission to handle the store READINGREQ: permission to send reading requests PREVIEW: permission to preview a document CUSTOMID: permission to edit the Custom ID REVISION: permission to edit the Revision
PermissionException
Raised when a permission is not allowed
PersistenceException
Raised when a problem happens in the data layer.
PersistentObject
This abstract class defines the minimum requirements of persistent objects.
PersistentObjectDAO<T>
Interface for DAOs that operate on persistent objects
PluginDbInit
Database initialization manager
PPTParser
Parser for Office 2003 presentations
PstConverter
Converts a PST file in it's listing
PSTWorker
An utility class to work with .pst files.
RarConverter
Converts a Rar file in it's listing
RarParser
Class for parsing rar files.
Rating
A rating over a document
RatingDAO
DAO service for ratings
Recipient
A generic recipient of a message or email
RegexTool
Various Regex-based APIs to make it easy to manipulate regular expressions from Automation.
ResultSetWalker
A walker that operates over a `ResultSet` bound to the current JDBC connection
RTFParser
A parser for the Rich Text Format
RunLevel
Represents an operative status of the whole application.
SavedSearch
A search saved in the database
Search
This class executes a search against the full-text indexes
Search.HitMapper
SearchDAO
This class is a DAO-service for persistent `SavedSearch` objects.
SearchEngine
Model of a search engine with search and I/O capabilities.
SearchException
An error happened during search
SearchOptions
Search options
SearchTool
Utility methods to do searches from within Automation
Secure<T>
An object that implements this interface, supports an Access Control List to define security policies.
SecurityTool
Utility methods to handle some security related operations from within the Automation
Sequence
A sequence in the database
SequenceDAO
Utility DAO that can manage sequences persisted in the DB
Session
A single user session with it's unique identifier and the reference to the user
SessionDAO
DAO for `Session`s handling.
SessionFilter
This filter looks for a sid parameter in the request or X-API-KEY header and auto-authenticate the user.
SessionListener
Events about sessions
SessionManager
Repository of all current user sessions.
SessionStatus
SevenZipConverter
Converts a 7z file in it's listing
SevenZipParser
Class for parsing 7z files.
SnowballFilterFactory
Retrieves a token stream elaborated by Snowaball Filter
SqlRowSetWrapper
Wrapper for the default SqlRowSet able to hanle modern Jdbc drivers
StandardSearchEngine
Standard implementation that implements a local search engine
StatsCollector
Collects statistical informations to the stats site
StopWords
Class for retrieving the words from the stopwords files
Store
The Store manages the repository where document files are maintained and all general resources are stored.
StoreResource
Represents a resource inside a `Store`
StoreResource.Builder
A builder for `StoreResource`s
StringTool
Utility methods to handle strings
SystemInfo
General informations about the system
SystemLoadListener
Concrete implementations have to react to changes in the system load.
SystemLoadMonitor
This class monitors the system load and notifies the listeners accordingly
SystemMessage
SystemMessages are messages which an user only can send to other system users.
SystemMessageDAO
This is a DAO service for SystemMessages.
SystemTool
Utility functions for interacting with the Operative System from within the Automation
Tag
Represents a tag of a specific document
TagCloud
This class is a TagCloud
TagSearch
Search specialization for the Tag search.
TagSearchOptions
Search options specialization for the Tag text search.
TagsProcessor
This task generate all data needed by the tag cloud panel and the tags drop-down lists.
TarConverter
Converts a Tar file in it's listing
TarParser
Class for parsing tar files.
Task
A task is a long running process that is fired regularly
TaskException
An error happened during task esexcution
TaskListener
Implementations of this listener are notified when changes occurs in the Task state
TaskManager
A manager that collects all operations about tasks.
TaskScheduling
Scheduling configuration for a Task
TaskTrigger
This trigger wraps both a SimpleTrigger and a CronTrigger
Template
A template collects a set of attributesets ant is itself an extensible object.
TemplateDAO
This class is a DAO-service for document templates.
Tenant
This class represents a Tenant, that is a branch of the organization or an organizational unit or whatever other class of organization.
TenantDAO
ThreadPoolNotAvailableException
An error happened accessing a thread pool
ThreadPools
A factory for thread pools.
ThumbnailBuilder
Implementations of this interface are specialized classes that produce thumbnails for a specific type of document.
ThumbnailManager
Manager class used to handle document thumbnails
Ticket
Represents ticket, most of the time this is used to model download tickets.
TicketDAO
DAO for `Ticket`s handling.
TicketListener
This interface defines hooks called before and after a particular event occurs on the specified ticket.
TokenProvider
For connecting to the mail store via IMAP or SMTP using OAuth 2.0 authentication, one shall first obtain an access token.
TokenProviderManager
A manager for the `TokenProvider`s.
TooManyDocumentsException
Exception raised when you try to add more documents than allowed in the same folder
TransactionalObject
Implementations of this interface are objects that may participate into a transaction
TXTParser
Class for parsing text (*.txt) files.
UnconfirmedLegalsException
Raised when the user did not confirm one or more legals
UnexistingResourceException
Raised when access to an unexisting resource is required
User
This class represents a user.
UserDAO
This class is a DAO-service for User-objects.
UserEvent
Possible events in the user's history
UserGroup
Simple bean to map a relationship between a user and it's groups
UserHistory
History entry due to an event on a user.
UserHistoryDAO
DAO for `UserHistory` handling.
UserListener
This interface defines hooks called before and after a particular event occurs on the specified user.
UsernameBlockedException
Raised when the remote client is in the black list
UserSource
UserTool
Utility methods to handle some user related operations from within the Automation
UserType
UserUtil
Various utilities about users.
ValidationError
A simple bean to carry an error descrition
ValidationException
Raised when the content being stored are not logically valid.
Validator
A Validator performs the checks on a generic `ExtensibleObject`
Version
This class represents versions.
VersionDAO
This class is a DAO-service for versions.
VideoThumbnailBuilder
Takes care of generating thumbnails for videos
WorkingTime
Represents a time interval in the working time of the user
WrongPasswordException
Raised when given password is not correct
XLSParser
Parser for Office 2003 worksheets
XMLConverter
Converter to convert XML files
XMLParser
Text extractor for XML documents.
ZABWParser
Text extractor for AbiWord compressed documents.
ZipConverter
Converts a Zip file in it's listing
ZipExport
Exports a folder hierarchy and all documents in it as a zip file.
ZipImport
This is an import utilities that imports documents stored in a zip archive.
ZipParser
Class for parsing zip files.