All Classes

Class	Description
AbstractCardType	Abstract Card type
AbstractExceptionMapper	Intercept exception and send them back to client
AbstractResource	A resource is a document provided to help the users to fulfill their goals.
Account	Accounts are used by users to authenticate.
AccountDao	Account persistence
ActivityFlowLink	Link to show that a card must be handled before another one.
ActivityFlowLinkDao	Activity flow link persistence
ActivityFlowLinkManager	Activity flow link specific logic
ActivityFlowLinkRestEndpoint	REST activity flow link controller
AdminResource	Depict REST classes or methods which are available to administrator only
ApplicationConfig	Simple REST WebService application.
ApplicationLifecycle
ApplicationLifecycleManager	Some business method required by ApplicationLifecycleManager.
Assignment	Define the assignment a team member or a team role have to cards
AssignmentDao	Assignment persistence
AssignmentManager	Some logic to manage assignments of team members on cards
AuthenticationFailure	To store number of authentication failure
AuthenticationFilter	Intercept all request to the API and check user has required permission.
AuthenticationRequired	Depict REST classes or methods which are available to authenticated user only.
AuthInfo	Contains information sent by the user to authenticate with a password
AuthMethod	This method request the client to send a password using the mandatoryMethod.
BlockChannel	A channel to propagate content of a given block.
BlockManager	Block specific logic
BlockMonitoring	Admin tool to monitor live block changes
BlockMonitoring.BlockStatus	Status of the block
BroadcastChannel	The channel to be used to transmit data to all online users.
CacheControlFilter	Make sure Cache-Control header is set:
CallableGetChannel	Serializable callable to be submitted to all instances of the cluster.
CancelDebounce	Cancel any Debouncer
Card	Card
CardContent	Card content
CardContentCompletionMode	Defines how the completion level is handled
CardContentDao	Card content persistence
CardContentManager	Card content specific logic
CardContentRestEndpoint	REST card content controller
CardContentStatus	Status of the card
CardDao	Card persistence
CardManager	Card, card type and card content specific logic
CardRestEndpoint	REST card controller
CardType	Card type, defining what is it for
CardTypeCreationData	Bean with everything needed to create a card type
CardTypeDao	Card type persistence
CardTypeManager	Card type and reference specific logic
CardTypeOrRefConditions	Card type and reference access control conditions
CardTypeOrRefConditions.IsCardTypeOrRefReadable	Has the current user access to the card type or reference ?
CardTypeRef	Reference to another existing abstract card type.
CardTypeRestEndpoint	REST card type controller
CdiBridgeSingleton	Single which give access to the CDI world.
Change	A change is an atomic set of microchanges.
ChangeRestEndpoint	REST micro changes controller
ChannelOverview	Deprecated. not used any longer
ChannelsBuilders	Compute the channels needed to propagate alteration changes.
ChannelsBuilders.AboutAccountChannelsBuilder	To build all channels needed to propagate an account alteration
ChannelsBuilders.AboutCardTypeChannelsBuilder	To build all channels needed for a card type belonging to a project
ChannelsBuilders.AboutProjectOverviewChannelsBuilder	To build all channels needed to propagate a project overview alteration
ChannelsBuilders.AboutUserChannelsBuilder	To build all channels needed to propagate a user alteration
ChannelsBuilders.BlockChannelBuilder	To build a block channel
ChannelsBuilders.ChannelsBuilder	To determine the channels to use
ChannelsBuilders.EmptyChannelBuilder	When there is no channel
ChannelsBuilders.ForAdminChannelsBuilder	To build a channel for each admin
ChannelsBuilders.ProjectContentChannelBuilder	To build a project content channel
ClassDoc	Represent javadoc of a class, with fields and methods javadocs.
ClientException	4xx error
ColabClient	The ColabClient REST client
ColabConfig	Bean to serialize account-related configuration.
ColabConfiguration	Some configuration parameters
ColabEntity	Simple interface which depicts persisted object that may be exchanged with clients
ColabMergeException	Thrown when a merge is not possible
ColabRollbackException	To rollback the transaction
Conditions	Utility class to build conditions
Conditions.And	AND condition
Conditions.Condition	Abstract condition.
Conditions.DoCurrentUserWorkOnSameProjectThanUser	Do current and given user work on a common project ?
Conditions.HasCardReadRight	Has the current user access to a card ?
Conditions.HasCardWriteRight	Has the current user write access to a card ?
Conditions.IsCurrentUserInternalToProject	The current user must be, at least, internal to given project team
Conditions.IsCurrentUserMemberOfProject	The current user must be member of the given project team
Conditions.IsCurrentUserTeamMateOfUser	Are current and given users teammate ?
Conditions.IsCurrentUserThisUser	Is the current user the given one ?
Conditions.Not	NOT
Conditions.Or	OR condition
ConfigRestEndpoint	REST MonitoringRestEndpoint to monitor the system
ConfigurationManager	Give access to configuration variables
ConsentNotRequired	Depict REST classes or methods which are available when user consent is not required.
ConversionStatus	When an entity needs a conversion, it can be in one of these statues.
CookieFilter	Intercept all request to the API.
CopyParam	Parameters to copy a project.
CopyParamDao	Copy parameter persistence
CronJobLog	Store cronjob related information
CronJobLogDao	Cronjob logs persistence
CronJobLogManager	Logic to manage cron job logging
CronJobLogName	A cron job log can have one of these names
CronJobLogRestEndpoint	REST CronJobLog controller
CronTab	Do periodic tasks
DataSourceDefinitionProvider	Provides data source definition
DateSerDe	Date Serializer and Deserializer.
Debouncer	Callable Change processing Request.
DeletionManager	Handles the specific logic of the deletion process for any ColabEntity
DeletionStatus	Enumeration of the different states of deletion.
Document	Any document.
DocumentDao	Document persistence
DocumentFile	Document referencing a file stored internally
DocumentFileRestEndPoint	EndPoint to managed hosted files
DocumentManager	Document specific logic
DocumentRestEndpoint	REST document controller
DuplicationManager	Duplication of colab entities.
DuplicationParam	All we need to fine tune a duplication
EjbExceptionMapper	Intercept exception and send them back to client with correct HTTP status.
EmailableToken	A token that can be sent by email
EntityGatheringBagForPropagation	Transaction sidekick used to collect updated and deleted entities.
EntityHelper	Helper to normalize common operations on WithId objects
EntityListener	JPA Entity listener defined in orm.xml
ErrorHandler	Error handler
ExpirationPolicy	Expiration policies available for a token.
ExternalDataManager	To deal with external data
ExternalDataRestEndpoint
ExternalLink	Document referenced by a link to an external system
ExtractJavaDoc	Inform JavaDocExtractor to process the annotated class
FileHelper
FileManager	Handles DocumentFiles instances both DB and JCR persistence
FormField<T>	Represents a form field
Generator
GeneratorPlugin	Maven plugin to generate REST client.
Grid	Utility class to help resolving cell positioning
Grid.Coord	Simple class to depict a single coord
GridCell	Basic grid cell interface
GridCellWithId	Effective grid cell must provide and id
GridPosition	Simple grid cell implementation
HashMethod	Hash method supported by the coLAB platform
Helper	Some global helper methods
HelpMojo	Display help information on html-report-maven-plugin. Call mvn html-report:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
HelpMojo	Display help information on client-generator-plugin. Call mvn client-generator:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
HierarchicalPosition	Describe the hierarchical position of a team member
HtmlReport	TODO:publish to maven central
HttpErrorMessage	Throw an error message.
HttpErrorMessage.MessageCode	List of message type
HttpException	run-time exception which may be sent back to client.
HttpSession	store session related information
HttpSessionDao	Http session persistence
IconLibrary	Icon libraries supported by the coLAB platform
Illustration	To store data of the illustration of some item.
IndexEntry	No need to send full object details, @class + id is way sufficient
IndexGeneratorHelper<T extends WithIndex>	Deal with assigning index in a collection.
IndexWithEmptySlotManager<T extends WithIndex & WithId>	Deal with changing index in a collection.
InstanceMaker	An instance maker is a user that can use a project model to initiate a new project
InstanceMakerDao	Instance maker persistence
InstanceMakerManager	Logic to manage model sharing
InstanceMakerRestEndpoint	REST InstanceMaker controller
InternalExceptionMapper	Intercept exception and send them back to client with correct HTTP status
InternalHashMethod	Hash method internally supported by the coLAB platform.
InvitationMessageBuilder	To build the body of the message to send for an invitation token.
InvitationToken	A token to invite someone to be a team member of a project.
InvolvementLevel	RACI matrix in a RAS form
JavaDocExtractor	Annotations Processor to extract Javadoc of REST endpoints and JPA entities.
JcrManager	Manages the persistence of files with JackRabbit Oak
JcrRepository	Access to the JCR repository
JcrSession
JcrSessionManager
JcrSynchronizer	To synchronize JCR session with JTA transaction
JpaCustomizer	Customize JPA session.
JsonbProvider	convenient way to customize the JSON-B mapper
JsonClassName	Annotation overrides default class name to use as the @class discriminant
JsonDecoder	Convert JSON-encoded Websocket message received from clients
JsonEncoder	Serialize object as JSON using JSONb
JsonWsMessageListDecoder	Convert JSON-encoded Websocket message received from clients
LevelDescriptor	Describe the current level of a logger
LexicalDataOwnershipKind	The different kinds of lexical data ownership.
LiquibaseProducer	LiquiBase Producer.
LiveManager	Micro Changes Management.
LiveResult
LiveUpdates	Set of pending changes.
LocalAccount	Password based authentication.
Logger	Print message with a Maven Log.
LoggerLevelPayload	Serializable description of a logger level.
Message
MessageBuilder	To build Message instances.
MessageI18nKey	All known i18n key messages transmitted from server to client
MicroChange	A microchange.
MicroChange.Type	microChange Type
ModelSharingMessageBuilder	To build the body of the message to send for an model sharing token.
ModelSharingToken	A token to share a model to a user
MonitoringManager
MonitoringRestEndpoint	REST MonitoringRestEndpoint to monitor the system
Param	represent a REST method parameter
PolymorphicDeserializer	Custom deserializer which can handle polymorphic objects.
PrecomputedWsMessages	List of all WsMessages that should be sent through websockets.
PresenceManager	To manages user presence
PresenceRestEndpoint	API to manage presence
Project	A project as persisted in database
ProjectConditions	Project access control conditions
ProjectConditions.IsCopyParamReadable	Has the current user access to the copy parameters of a project ?
ProjectConditions.IsProjectReadable	Has the current user access to the project ?
ProjectContentChannel	A channel to propagate content of a given projectId.
ProjectCreationData	Bean with everything needed to create a project
ProjectDao	Project persistence
ProjectManager	Project specific logic
ProjectRestEndpoint	REST Project controller
ProjectStructure	Bean to groups the whole project structure
ProjectType	What kind of project it is.
RelatedPosition	To define the place of a document
RequestFilter	Extract baseUrl and print log statement for all REST requests.
RequestManager	Request sidekick.
ResetLocalAccountPasswordMessageBuilder	To build the body of the message to send to reset the local account password.
ResetLocalAccountPasswordToken	A token to reset the password of a local account
Resource	A resource is a document provided to help the users to fulfill their goals.
Resourceable	Something that can be the owner of a resource.
ResourceCategoryHelper	Resource and resource reference category specific logic
ResourceCreationData	Bean with everything needed to create a resource
ResourceDao	Resource and resource reference persistence
ResourceExternalReference	Summary of project's use of a resource.
ResourceExternalReference.Usage	usage list
ResourceManager	Resource and resource reference specific logic
ResourceRef	A reference to another existing abstract resource.
ResourceReferenceSpreadingHelper	Resource and resource reference spread specific logic
ResourceRestEndpoint	REST resource controller
RestClient	JakartaEE-based rest client.
RestClient.CookieFilter	Cookie filter make sure the session cookie is set.
RestEndpoint	Represent a rest controller.
RestMethod	Represent a rest method
SecurityManager	To check access rights.
SecurityRestEndPoint	REST SecurityRestEndpoint for Terms of Use and Data Policy
Sendmail	Helper to send e-mails.
SerializationStringWrapper	To use when we want to return a simple string as a result of a REST method.
ServerException	Server 5xx error
SessionManager	Bean to manage HTTP sessions
SharingLinkToken	A token to share a project.
SignUpInfo	Contains information sent by a user to create a new local account
StaticContentCacheControlFilter	Set CacheControl No-Cache for static content
StickyNoteLink	Link to make an information accessible within a card.
StickyNoteLinkCreationData	Bean with everything needed to create a sticky note link
StickyNoteLinkDao	Sticky note link persistence
StickyNoteLinkManager	Sticky note link specific logic
StickyNoteLinkManager.SrcType	Possible source types
StickyNoteLinkRestEndpoint	REST sticky note link controller
StickyNoteSourceable	Something that can be the source of a sticky note
SubscriptionRequest	Subscription request to be propagated through the cluster to reach the instance which is responsible for the given wsSessionId
SubscriptionRequest.ChannelType	One-to-one mapping to EffectiveChannels
SubscriptionRequest.SubscriptionType	Subscript or unsubscribe
TeamManager	Some logic to manage project teams
TeamMember	A member is a user which work on a project
TeamMemberDao	Team member persistence
TeamRestEndpoint	REST Teams controller.
TeamRole	A role within the development team.
TeamRoleDao	Team role persistence
TermsOfUseManager	To store the last date when the Terms of Use and Data Policy were updated
TextDataBlock	Container of text data
Token	A token grants access to a specific action.
TokenDao	Token persistence
TokenManager	Process tokens
TokenMessageBuilder	To build the body of the message to send for a token.
TokenRestEndpoint	API to fetch and consume tokens sent by e-mail.
TokenWithURL	Interface to extract the data needed to generate a URL.
TouchUserPresence
Tracking	To store the creation and modification dates as well as the user who initiate the action
TypeScriptHelper	Some methods to convert java things to typescript ones
UrlMetadata
User	Represents a registered user.
UserChannel	The channel to be used to transmit data to a specific user.
UserDao	User persistence
UserManager	Everything related to user management
UserPresence	Used to activity status of a user with the rest of the team
UserRestEndpoint	User controller
ValidationManager	Entity validation management
VerifyLocalAccountMessageBuilder	To build the body of the message to send to verify the local account.
VerifyLocalAccountToken	A token to validate the email address of a local account
VersionDetails	Information about the current running colab version
WebsocketChannel	Channels between clients and servers.
WebsocketEndpoint	Websocket endpoint
WebsocketManager	Some methods to handle websocket connections.
WebsocketMessagePreparer	Some convenient methods to help sending data through websockets.
WebsocketRestEndpoint	API to manage subscription to WebsocketChannel.
WebsocketTxManager	To synchronize websockets with JTA session
WebsocketTxSync	To synchronize websockets with JTA session
WithDeletionStatus	Simple interface which depicts objects having a deletion status
WithId	Simple interface which depict objects having a Long id
WithIndex	An object containing an index
WithJsonDiscriminator	Represent an object which can be serialize to JSON.
WithPermission	Depict an entity which has access controls
WithTrackingData	Simple interface which depicts objects having tracking data
WithWebsocketChannels	Depict an entity which can be propagated through websocket.
WsChannelUpdate	Indicated channel subscription change
WsMessage	Abstract class for all websocket messages
WsPing	Ping message
WsPong	Pong message
WsSessionIdentifier	Message sent to each client as soon as they initialize the websocket connection.
WsSignOutMessage	Websocket message to inform about a logout.
WsUpdateMessage	Websocket update message.
YjsException	Exception when trying to call the colab-yjs server (that is used to store the lexical text editor data)
YjsLexicalCaller	To manage the data in the colab-yjs server (that is used to store the lexical text editor data).