All Classes and Interfaces
Class
Description
Abstract Card type
Intercept exception and send them back to client
A resource is a document provided to help the users to fulfill their goals.
Accounts are used by users to authenticate.
Account persistence
Link to show that a card must be handled before another one.
Activity flow link persistence
Activity flow link specific logic
REST activity flow link controller
Depict REST classes or methods which are available to administrator only
Simple REST WebService application.
Some business method required by
ApplicationLifecycleManager.Define the assignment a team member or a team role have to cards
Assignment persistence
Some logic to manage assignments of team members on cards
To store number of authentication failure
Intercept all request to the API and check user has required permission.
Depict REST classes or methods which are available to authenticated user only.
Contains information sent by the user to authenticate with a password
This method request the client to send a password using the mandatoryMethod.
A channel to propagate content of a given block.
Block specific logic
Admin tool to monitor live block changes
Status of the block
The channel to be used to transmit data to all online users.
Make sure Cache-Control header is set:
Serializable callable to be submitted to all instances of the cluster.
Cancel any
DebouncerCard
Card content
Defines how the completion level is handled
Card content persistence
Card content specific logic
REST card content controller
Status of the card
Card persistence
Card, card type and card content specific logic
REST card controller
Card type, defining what is it for
Bean with everything needed to create a card type
Card type persistence
Card type and reference specific logic
Card type and reference access control conditions
Has the current user access to the card type or reference ?
Reference to another existing abstract card type.
REST card type controller
Single which give access to the CDI world.
A change is an atomic set of microchanges.
REST micro changes controller
Deprecated.
not used any longer
Compute the channels needed to propagate alteration changes.
To build all channels needed to propagate an account alteration
To build all channels needed for a card type belonging to a project
To build all channels needed to propagate a project overview alteration
To build all channels needed to propagate a user alteration
To build a block channel
To determine the channels to use
When there is no channel
To build a channel for each admin
To build a project content channel
Represent javadoc of a class, with fields and methods javadocs.
4xx error
The ColabClient REST client
Bean to serialize coLAB configuration.
Some configuration parameters
Simple interface which depicts persisted object that may be exchanged with clients
Thrown when a merge is not possible
To rollback the transaction
Utility class to build conditions
AND condition
Abstract condition.
Do current and given user work on a common project ?
Has the current user access to a card ?
Has the current user write access to a card ?
The current user must be, at least, internal to given project team
The current user must be member of the given project team
Are current and given users teammate ?
Is the current user the given one ?
NOT
OR condition
REST MonitoringRestEndpoint to monitor the system
Give access to configuration variables
Depict REST classes or methods which are available when user consent is not required.
When an entity needs a conversion, it can be in one of these statues.
Intercept all request to the API.
Parameters to copy a project.
Copy parameter persistence
Store cronjob related information
Cronjob logs persistence
Logic to manage cron job logging
A cron job log can have one of these names
REST CronJobLog controller
Do periodic tasks
Provides data source definition
Date Serializer and Deserializer.
Callable Change processing Request.
Handles the specific logic of the deletion process for any ColabEntity
Enumeration of the different states of deletion.
Any document.
Document persistence
Document referencing a file stored internally
EndPoint to managed hosted files
Document specific logic
REST document controller
Duplication of colab entities.
All we need to fine tune a duplication
Intercept exception and send them back to client with correct HTTP status.
A token that can be sent by email
Transaction sidekick used to collect updated and deleted entities.
Helper to normalize common operations on WithId objects
JPA Entity listener defined in orm.xml
Error handler
Expiration policies available for a token.
To deal with external data
Document referenced by a link to an external system
Inform JavaDocExtractor to process the annotated class
Handles DocumentFiles instances both DB and JCR persistence
Represents a form field
Maven plugin to generate REST client.
Utility class to help resolving cell positioning
Simple class to depict a single coord
Basic grid cell interface
Effective grid cell must provide and id
Simple grid cell implementation
Hash method supported by the coLAB platform
Some global helper methods
Display help information on html-report-maven-plugin.
Call
Call
mvn html-report:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.Display help information on client-generator-plugin.
Call
Call
mvn client-generator:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.Describe the hierarchical position of a team member
TODO:publish to maven central
Throw an error message.
List of message type
run-time exception which may be sent back to client.
store session related information
Http session persistence
Icon libraries supported by the coLAB platform
To store data of the illustration of some item.
No need to send full object details, @class + id is way sufficient
Deal with assigning index in a collection.
Deal with changing index in a collection.
An instance maker is a user that can use a project model to initiate a new project
Instance maker persistence
Logic to manage model sharing
REST InstanceMaker controller
Intercept exception and send them back to client with correct HTTP status
Hash method internally supported by the coLAB platform.
To build the body of the message to send for an invitation token.
A token to invite someone to be a team member of a project.
RACI matrix in a RAS form
Annotations Processor to extract Javadoc of REST endpoints and JPA entities.
Manages the persistence of files with JackRabbit Oak
Access to the JCR repository
To synchronize JCR session with JTA transaction
Customize JPA session.
convenient way to customize the JSON-B mapper
Annotation overrides default class name to use as the @class discriminant
Convert JSON-encoded Websocket message received from clients
Serialize object as JSON using JSONb
Convert JSON-encoded Websocket message received from clients
Describe the current level of a logger
The different kinds of lexical data ownership.
LiquiBase Producer.
Micro Changes Management.
Set of pending changes.
Password based authentication.
Print message with a Maven Log.
Serializable description of a logger level.
To build
Message instances.All known i18n key messages transmitted from server to client
A microchange.
microChange Type
To build the body of the message to send for an model sharing token.
A token to share a model to a user
REST MonitoringRestEndpoint to monitor the system
represent a REST method parameter
Custom deserializer which can handle polymorphic objects.
List of all WsMessages that should be sent through websockets.
To manages user presence
API to manage presence
A project as persisted in database
Project access control conditions
Has the current user access to the copy parameters of a project ?
Has the current user access to the project ?
A channel to propagate content of a given projectId.
Bean with everything needed to create a project
Project persistence
Project specific logic
REST Project controller
Bean to groups the whole project structure
What kind of project it is.
To define the place of a document
Extract baseUrl and print log statement for all REST requests.
Request sidekick.
To build the body of the message to send to reset the local account password.
A token to reset the password of a local account
A resource is a document provided to help the users to fulfill their goals.
Something that can be the owner of a resource.
Resource and resource reference category specific logic
Bean with everything needed to create a resource
Resource and resource reference persistence
Summary of project's use of a resource.
usage list
Resource and resource reference specific logic
A reference to another existing abstract resource.
Resource and resource reference spread specific logic
REST resource controller
JakartaEE-based rest client.
Cookie filter make sure the session cookie is set.
Represent a rest controller.
Represent a rest method
To check access rights.
REST SecurityRestEndpoint for Terms of Use and Data Policy
Helper to send e-mails.
To use when we want to return a simple string as a result of a REST method.
Server 5xx error
Bean to manage HTTP sessions
A token to share a project.
Contains information sent by a user to create a new local account
Set CacheControl No-Cache for static content
Link to make an information accessible within a card.
Bean with everything needed to create a sticky note link
Sticky note link persistence
Sticky note link specific logic
Possible source types
REST sticky note link controller
Something that can be the source of a sticky note
Subscription request to be propagated through the cluster to reach the instance which is
responsible for the given wsSessionId
One-to-one mapping to EffectiveChannels
Subscript or unsubscribe
Some logic to manage project teams
Team member persistence
REST Teams controller.
A role within the development team.
Team role persistence
To store the last date when the Terms of Use and Data Policy were updated
Container of text data
A token grants access to a specific action.
Token persistence
Process tokens
To build the body of the message to send for a token.
API to fetch and consume tokens sent by e-mail.
Interface to extract the data needed to generate a URL.
To store the creation and modification dates as well as the user who initiate the action
Some methods to convert java things to typescript ones
Represents a registered user.
The channel to be used to transmit data to a specific user.
User persistence
Everything related to user management
Used to activity status of a user with the rest of the team
User controller
Entity validation management
To build the body of the message to send to verify the local account.
A token to validate the email address of a local account
Information about the current running colab version
Channels between clients and servers.
Websocket endpoint
Some methods to handle websocket connections.
Some convenient methods to help sending data through websockets.
API to manage subscription to
WebsocketChannel.To synchronize websockets with JTA session
To synchronize websockets with JTA session
Simple interface which depicts objects having a deletion status
Simple interface which depict objects having a Long id
An object containing an index
Represent an object which can be serialize to JSON.
Depict an entity which has access controls
Simple interface which depicts objects having tracking data
Depict an entity which can be propagated through websocket.
Indicated channel subscription change
Abstract class for all websocket messages
Ping message
Pong message
Message sent to each client as soon as they initialize the websocket connection.
Websocket message to inform about a logout.
Websocket update message.
Exception when trying to call the colab-yjs server (that is used to store the lexical text editor
data)
To manage the data in the colab-yjs server (that is used to store the lexical
text editor data).