Serialized Form
-
Package ch.colabproject.colab.api.controller
-
Class ch.colabproject.colab.api.controller.EntityGatheringBagForPropagation extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
cardTypeDao
CardTypeDao cardTypeDao
To resolve nested channels -
deleted
Set<IndexEntry> deleted
set of entities which have been deleted during the transaction -
message
PrecomputedWsMessages message
store the prepared messages -
precomputed
boolean precomputed
Is the message has been precomputed ? -
projectDao
ProjectDao projectDao
To resolve nested channels -
requestManager
RequestManager requestManager
TO sudo -
teamDao
TeamMemberDao teamDao
To resolve nested channels -
txManager
WebsocketTxManager txManager
To sync with JTA transaction(s) -
updated
Set<WithWebsocketChannels> updated
set of updated entities to be propagated -
userDao
UserDao userDao
To resolve nested channels -
websocketManager
WebsocketManager websocketManager
To send message to clients
-
-
Class ch.colabproject.colab.api.controller.SubscriptionRequest extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
channelId
Long channelId
Id of the channel. Id of a project or user. -
channelType
SubscriptionRequest.ChannelType channelType
Type of channel : User | Project -
colabSessionId
Long colabSessionId
HTTP session id which want to (un)subscribe -
type
SubscriptionRequest.SubscriptionType type
Type of request -
wsSessionId
String wsSessionId
Websocket session id which want to (un)subscribe
-
-
Class ch.colabproject.colab.api.controller.WebsocketTxManager extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
bean
EntityGatheringBagForPropagation bean
The bag
-
-
-
Package ch.colabproject.colab.api.controller.document
-
Class ch.colabproject.colab.api.controller.document.YjsException extends RuntimeException implements Serializable
- serialVersionUID:
- 1L
-
-
Package ch.colabproject.colab.api.controller.monitoring
-
Class ch.colabproject.colab.api.controller.monitoring.LoggerLevelPayload extends Object implements Serializable
- serialVersionUID:
- 1L
-
-
Package ch.colabproject.colab.api.exceptions
-
Class ch.colabproject.colab.api.exceptions.ColabMergeException extends Exception implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
receiver
ColabEntity receiver
The entity to take new values from -
supplier
ColabEntity supplier
The entity to update
-
-
Class ch.colabproject.colab.api.exceptions.ColabRollbackException extends RuntimeException implements Serializable
- serialVersionUID:
- 1L
-
-
Package ch.colabproject.colab.api.microchanges.live
-
Class ch.colabproject.colab.api.microchanges.live.LiveManager extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
blockManager
BlockManager blockManager
Block specific logic management -
debounces
Map<Long,Future<Void>> debounces
delayed process call -
hzInstance
com.hazelcast.core.HazelcastInstance hzInstance
Hazelcast instance. -
requestManager
RequestManager requestManager
The request manager -
transactionManager
EntityGatheringBagForPropagation transactionManager
To register changes as updated object
-
-
Class ch.colabproject.colab.api.microchanges.live.LiveUpdates extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
content
String content
root content -
pendingChanges
List<Change> pendingChanges
List of pending changes -
revision
String revision
initial revision of content -
targetClass
String targetClass
JsonDiscriminator to fetch the class this change targets -
targetId
Long targetId
Id of the object this change targets
-
-
-
Package ch.colabproject.colab.api.microchanges.live.monitoring
-
Class ch.colabproject.colab.api.microchanges.live.monitoring.BlockMonitoring extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
blockId
@NotNull Long blockId
Id of the block being live-edited -
status
@NotNull BlockMonitoring.BlockStatus status
Status of the live edition -
title
@NotNull String title
Human readable description
-
-
-
Package ch.colabproject.colab.api.microchanges.model
-
Class ch.colabproject.colab.api.microchanges.model.Change extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
atClass
@NotNull String atClass
JsonDiscriminator to fetch the class this change targets -
atId
@NotNull Long atId
Id of the object this change targets -
basedOn
@NotNull Set<String> basedOn
Revision this change is based on. -
blockId
@NotNull Long blockId
Id of the project this change belongs to -
liveSession
@NotNull String liveSession
aka websocket sessionId -
microchanges
@NotNull List<MicroChange> microchanges
List of micro microchanges which compose this change -
revision
@NotNull String revision
new revision
-
-
Class ch.colabproject.colab.api.microchanges.model.MicroChange extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
l
Integer l
Length. Only relevant for deletions -
o
@NotNull Integer o
Offset -
t
@NotNull MicroChange.Type t
Type -
v
String v
Value. Only relevant for adds
-
-
-
Package ch.colabproject.colab.api.microchanges.tools
-
Class ch.colabproject.colab.api.microchanges.tools.CancelDebounce extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
blockId
Long blockId
If of the block
-
-
Class ch.colabproject.colab.api.microchanges.tools.Debouncer extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
blockId
Long blockId
if of the block to process
-
-
-
Package ch.colabproject.colab.api.model
-
Class ch.colabproject.colab.api.model.DuplicationParam extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
makeOnlyCardTypeReferences
boolean makeOnlyCardTypeReferences
make card type references instead of duplication -
resetProgressionData
boolean resetProgressionData
Do we reset the progression data : completion level, card content status, frozen -
withActivityFlow
boolean withActivityFlow
Do we duplicate the activity flows -
withCardsStructure
boolean withCardsStructure
Do we duplicate the cards and card content structure -
withCardTypes
boolean withCardTypes
Do we duplicate card types -
withDeliverables
boolean withDeliverables
Do we duplicate the deliverables in the card contents -
withResources
boolean withResources
Do we duplicate the resources -
withRoles
boolean withRoles
Do we duplicate the roles -
withStickyNotes
boolean withStickyNotes
Do we duplicate the sticky notes -
withTeamMembers
boolean withTeamMembers
Do we duplicate the team members
-
-
-
Package ch.colabproject.colab.api.model.card
-
Class ch.colabproject.colab.api.model.card.AbstractCardType extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
deletionStatus
DeletionStatus deletionStatus
Is it in a bin or ready to be definitely deleted. Null means active. -
deprecated
boolean deprecated
Is this type deprecated? A deprecated type should not be used by new projects. -
directAbstractResources
List<AbstractResource> directAbstractResources
The list of abstract resources directly linked to this card definition -
id
Long id
CardType ID -
implementingCards
List<Card> implementingCards
The list of all cards implementing this card definition -
initialPublished
boolean initialPublished
published state on load -
project
Project project
The project it belongs to. If project is null, it means the type is a global type -
projectId
Long projectId
The id of the project (serialization sugar) -
published
boolean published
Is this type available to other projects? -
trackingData
Tracking trackingData
creation + modification + erasure tracking data
-
-
Class ch.colabproject.colab.api.model.card.Card extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
activityFlowLinksAsNext
List<ActivityFlowLink> activityFlowLinksAsNext
The list of activity flow links of which the card is the next one -
activityFlowLinksAsPrevious
List<ActivityFlowLink> activityFlowLinksAsPrevious
The list of activity flow links of which the card is the previous one -
assignments
List<Assignment> assignments
Assignments -
cardType
AbstractCardType cardType
The card type defining what is it for -
cardTypeId
Long cardTypeId
The id of the card type (serialization sugar) -
color
@Size(max=255) String color
The color of the card -
contentVariants
List<CardContent> contentVariants
The list of content variants.There can be several variants of content
-
deletionStatus
DeletionStatus deletionStatus
Is it in a bin or ready to be definitely deleted. Null means active. -
directAbstractResources
List<AbstractResource> directAbstractResources
The list of abstract resources directly linked to this card -
height
@NotNull Integer height
The height of the card within its parent -
id
Long id
Card ID -
parent
CardContent parent
The parent card contentA card can either be the root card of a project or be within a card content
-
parentId
Long parentId
The id of the parent card content (serialization sugar) -
rootCardProject
Project rootCardProject
The project this card is root of. may be null -
rootCardProjectId
Long rootCardProjectId
The id of the project for root cards (serialization sugar) -
stickyNoteLinksAsDest
List<StickyNoteLink> stickyNoteLinksAsDest
The list of sticky note links of which the card is the destination -
stickyNoteLinksAsSrc
List<StickyNoteLink> stickyNoteLinksAsSrc
The list of sticky note links of which the card is the source -
title
@Size(max=255) String title
Card title -
trackingData
Tracking trackingData
creation + modification + erasure tracking data -
width
@NotNull Integer width
The width of the card within its parent -
x
@NotNull Integer x
The x coordinate of the card within its parent -
y
@NotNull Integer y
The y coordinate of the card within its parent
-
-
Class ch.colabproject.colab.api.model.card.CardContent extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
card
@NotNull Card card
The card to which this content belongs -
cardId
Long cardId
The card ID (serialization sugar) -
completionLevel
@javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(100L),@javax.validation.constraints.NotNull int completionLevel
Completion level -
completionMode
CardContentCompletionMode completionMode
Completion mode : how the completion level is filled -
deletionStatus
DeletionStatus deletionStatus
Is it in a bin or ready to be definitely deleted. Null means active. -
deliverables
List<Document> deliverables
The deliverables of this card content -
directAbstractResources
List<AbstractResource> directAbstractResources
The list of abstract resources directly linked to this card content -
frozen
@javax.validation.constraints.NotNull boolean frozen
A frozen content is read-only -
id
Long id
Card content ID -
lexicalConversion
ConversionStatus lexicalConversion
Conversion status : has the deliverable content been converted -
status
CardContentStatus status
Status -
stickyNoteLinksAsSrc
List<StickyNoteLink> stickyNoteLinksAsSrc
The list of sticky note links of which the card content is the source -
subCards
List<Card> subCards
The cards contained in there -
title
@Size(max=255) String title
Title -
trackingData
Tracking trackingData
creation + modification + erasure tracking data
-
-
Class ch.colabproject.colab.api.model.card.CardType extends AbstractCardType implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
purpose
@NotNull TextDataBlock purpose
The purpose -
purposeId
Long purposeId
The id of the purpose -
tags
@NotNull Set<String> tags
Tags -
title
@Size(max=255) String title
The title
-
-
Class ch.colabproject.colab.api.model.card.CardTypeRef extends AbstractCardType implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
target
@NotNull AbstractCardType target
The abstract card type this reference aims at -
targetId
Long targetId
The id of the abstract card type this reference aims at (serialization sugar)
-
-
-
Package ch.colabproject.colab.api.model.common
-
Class ch.colabproject.colab.api.model.common.Illustration extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
iconBkgdColor
@Size(max=64) @NotNull String iconBkgdColor
The background color to set behind the icon -
iconKey
@Size(max=128) @NotNull String iconKey
The key of the icon within the library of icons -
iconLibrary
@NotNull IconLibrary iconLibrary
Which library of icons contains the key
-
-
Class ch.colabproject.colab.api.model.common.Tracking extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
createdBy
@Size(max=255) String createdBy
Created by "username" -
creationTime
OffsetDateTime creationTime
Creation timestamp -
erasedBy
@Size(max=255) String erasedBy
Erased by "username" (who sent it to bin) -
erasureTime
OffsetDateTime erasureTime
Erasure timestamp (when it was moved to bin) -
modificationTime
OffsetDateTime modificationTime
Modification timestamp -
modifiedBy
@Size(max=255) String modifiedBy
Modified by "username"
-
-
-
Package ch.colabproject.colab.api.model.document
-
Class ch.colabproject.colab.api.model.document.AbstractResource extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
abstractCardType
AbstractCardType abstractCardType
The card type / card type reference to which the abstract resource is linked -
abstractCardTypeId
Long abstractCardTypeId
The card type id / card type reference id (serialization sugar) -
card
Card card
The card to which the abstract resource is linked -
cardContent
CardContent cardContent
The card content to which the abstract resource is linked -
cardContentId
Long cardContentId
The card content id (serialization sugar) -
cardId
Long cardId
The card id (serialization sugar) -
category
@Size(max=255) String category
The category to classify the resource -
deletionStatus
DeletionStatus deletionStatus
Is it in a bin or ready to be definitely deleted. Null means active. -
id
Long id
Abstract resource ID -
stickyNoteLinksAsSrc
List<StickyNoteLink> stickyNoteLinksAsSrc
The list of sticky note links of which the resource is the source -
trackingData
Tracking trackingData
creation + modification + erasure tracking data
-
-
Class ch.colabproject.colab.api.model.document.Document extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
deletionStatus
DeletionStatus deletionStatus
Is it in a bin or ready to be definitely deleted. Null means active. -
id
Long id
Document ID -
index
int index
The index to define the place of the document -
owningCardContent
CardContent owningCardContent
The card content for which this document is a deliverable -
owningCardContentId
Long owningCardContentId
The id of the card content for which this document is a deliverable -
owningResource
Resource owningResource
The resource this document is part of -
owningResourceId
Long owningResourceId
The id of the resource this document is part of -
stickyNoteLinksAsSrc
List<StickyNoteLink> stickyNoteLinksAsSrc
The list of sticky note links of which the document is the source -
trackingData
Tracking trackingData
creation + modification + erasure tracking data
-
-
Class ch.colabproject.colab.api.model.document.DocumentFile extends Document implements Serializable
- serialVersionUID:
- 1L
-
Class ch.colabproject.colab.api.model.document.ExternalLink extends Document implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
url
@Size(max=255) String url
The link to access the document
-
-
Class ch.colabproject.colab.api.model.document.Resource extends AbstractResource implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
deprecated
@javax.validation.constraints.NotNull boolean deprecated
Indicates the resource should not be used anymore -
documents
List<Document> documents
The content of the resource -
lexicalConversion
ConversionStatus lexicalConversion
Conversion status : has the deliverable content been converted -
published
@javax.validation.constraints.NotNull boolean published
Is it at the disposal of the inheritors -
requestingForGlory
@javax.validation.constraints.NotNull boolean requestingForGlory
Ask upper level(s) to integrate the resource -
teaser
@NotNull TextDataBlock teaser
The abstract / teaser -
teaserId
Long teaserId
The id of the abstract / teaser -
title
@Size(max=255) String title
The title
-
-
Class ch.colabproject.colab.api.model.document.ResourceRef extends AbstractResource implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
refused
@javax.validation.constraints.NotNull boolean refused
Manually discard the resource = say that the target resource must not be displayed as an active resource at this reference level. -
residual
@javax.validation.constraints.NotNull boolean residual
Automatically discard the resource = say that the target resource must not be displayed as an active resource at this reference level.It can be because it is not published anymore or the reference is a rest of a former ancestor. The resource can be manually "revived".
The reference is not destroyed so that a rollback without loss of data is possible.
-
target
@NotNull AbstractResource target
The abstract resource this reference aims at -
targetId
Long targetId
The abstract resource id (serialization sugar)
-
-
Class ch.colabproject.colab.api.model.document.TextDataBlock extends Document implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
explainingStickyNoteLink
StickyNoteLink explainingStickyNoteLink
The sticky note link it is the explanation of -
healthy
@javax.validation.constraints.NotNull boolean healthy
is the current live block healthy? To heal an un-healthy block, pending changes must be deleted. -
mimeType
@Size(max=255) String mimeType
The mime type of the information -
purposingCardType
CardType purposingCardType
The card type it is the purpose of -
revision
@NotBlank @Size(max=255) String revision
Current revision hash -
teasingResource
Resource teasingResource
The resource it is the teaser of -
textData
String textData
The information contained
-
-
-
Package ch.colabproject.colab.api.model.link
-
Class ch.colabproject.colab.api.model.link.ActivityFlowLink extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
deletionStatus
DeletionStatus deletionStatus
Is it in a bin or ready to be definitely deleted. Null means active. -
id
Long id
Link ID -
nextCard
@NotNull Card nextCard
The card to handle after -
nextCardId
Long nextCardId
The ID of the card to handle after (serialization sugar) -
previousCard
@NotNull Card previousCard
The card to handle before -
previousCardId
Long previousCardId
The ID of the card to handle before (serialization sugar) -
trackingData
Tracking trackingData
creation + modification + erasure tracking data
-
-
Class ch.colabproject.colab.api.model.link.StickyNoteLink extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
deletionStatus
DeletionStatus deletionStatus
Is it in a bin or ready to be definitely deleted. Null means active. -
destinationCard
@NotNull Card destinationCard
The card where the information is useful -
destinationCardId
Long destinationCardId
The ID of the destination card (serialization sugar) -
explanation
@NotNull TextDataBlock explanation
The long description -
explanationId
Long explanationId
The id of the long description (serialization sugar) -
id
Long id
Link ID -
srcCard
Card srcCard
The card, source of the sticky note -
srcCardContent
CardContent srcCardContent
The card content, source of the sticky note -
srcCardContentId
Long srcCardContentId
The ID of the source card content (serialization sugar) -
srcCardId
Long srcCardId
The ID of the source card (serialization sugar) -
srcDocument
Document srcDocument
The document, source of the sticky note -
srcDocumentId
Long srcDocumentId
The ID of the source document (serialization sugar) -
srcResourceOrRef
AbstractResource srcResourceOrRef
The resource / resource reference, source of the sticky note -
srcResourceOrRefId
Long srcResourceOrRefId
The ID of the source resource / resource reference (serialization sugar) -
teaser
@Size(max=255) String teaser
The short description -
trackingData
Tracking trackingData
creation + modification + erasure tracking data
-
-
-
Package ch.colabproject.colab.api.model.monitoring
-
Class ch.colabproject.colab.api.model.monitoring.CronJobLog extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
id
Long id
Unique id -
jobName
@NotNull CronJobLogName jobName
Name of cronJob -
lastRunTime
OffsetDateTime lastRunTime
persisted cronJob time
-
-
-
Package ch.colabproject.colab.api.model.project
-
Class ch.colabproject.colab.api.model.project.CopyParam extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
deletionStatus
DeletionStatus deletionStatus
Is it in a bin or ready to be definitely deleted. Null means active. -
id
Long id
Copy parameter id -
project
@NotNull Project project
The project -
projectId
Long projectId
The project ID (serialization sugar) -
trackingData
Tracking trackingData
creation + modification + erasure tracking data -
withDeliverables
boolean withDeliverables
Must the deliverables also be copied -
withResources
boolean withResources
Must the resources also be copied -
withRoles
boolean withRoles
Must the roles also be copied
-
-
Class ch.colabproject.colab.api.model.project.InstanceMaker extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
deletionStatus
DeletionStatus deletionStatus
Is it in a bin or ready to be definitely deleted. Null means active. -
displayName
@Size(max=255) String displayName
Optional display name. Such a name will hide user.commonName. -
id
Long id
Instance maker ID -
project
@NotNull Project project
The model -
projectId
Long projectId
The model ID (serialization sugar) -
trackingData
Tracking trackingData
creation + modification + erasure tracking data -
user
User user
The user -
userId
Long userId
The user ID (serialization sugar)
-
-
Class ch.colabproject.colab.api.model.project.Project extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
deletionStatus
DeletionStatus deletionStatus
Is it in a bin or ready to be definitely deleted. Null means active. -
description
@Size(max=255) String description
The description -
elementsToBeDefined
List<AbstractCardType> elementsToBeDefined
List of elements to be defined within the cards -
globalProject
boolean globalProject
Global means accessible to everyone -
id
Long id
Project ID -
illustration
Illustration illustration
The icon to illustrate the project -
initialGlobal
boolean initialGlobal
global state on load -
instanceMakers
List<InstanceMaker> instanceMakers
List of instanceMakers -
name
@Size(max=255) String name
The name -
roles
List<TeamRole> roles
Roles -
rootCard
Card rootCard
The root card of the project containing all other cards -
teamMembers
List<TeamMember> teamMembers
List of team members -
trackingData
Tracking trackingData
creation + modification + erasure tracking data -
type
@NotNull ProjectType type
The kind : project or model
-
-
-
Package ch.colabproject.colab.api.model.team
-
Class ch.colabproject.colab.api.model.team.TeamMember extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
assignments
List<Assignment> assignments
List of assignments relative to this member -
deletionStatus
DeletionStatus deletionStatus
Is it in a bin or ready to be definitely deleted. Null means active. -
displayName
@Size(max=255) String displayName
Optional display name. Such a name will hide user.commonName. -
id
Long id
Member ID -
position
@NotNull HierarchicalPosition position
Hierarchical position of the member -
project
@NotNull Project project
The project -
projectId
Long projectId
The project ID (serialization sugar) -
roleIds
@NotNull List<Long> roleIds
Id of the roles. For deserialization only -
roles
List<TeamRole> roles
The roles -
trackingData
Tracking trackingData
creation + modification + erasure tracking data -
user
User user
The user -
userId
Long userId
The user ID (serialization sugar)
-
-
Class ch.colabproject.colab.api.model.team.TeamRole extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
assignments
List<Assignment> assignments
List of assignments relative to this role -
deletionStatus
DeletionStatus deletionStatus
Is it in a bin or ready to be definitely deleted. Null means active. -
id
Long id
TeamRole ID. -
members
List<TeamMember> members
List of members who are part of this role -
name
@Size(max=255) @NotBlank String name
Name of the role. Can not be null or blank -
project
@NotNull Project project
The project -
projectId
Long projectId
The project ID (serialization sugar) -
trackingData
Tracking trackingData
creation + modification + erasure tracking data
-
-
-
Package ch.colabproject.colab.api.model.team.acl
-
Class ch.colabproject.colab.api.model.team.acl.Assignment extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
card
@NotNull Card card
the card this assignment is related to -
deletionStatus
DeletionStatus deletionStatus
Is it in a bin or ready to be definitely deleted. Null means active. -
id
Long id
Project ID -
involvementLevel
InvolvementLevel involvementLevel
Involvement level = RACI level -
member
TeamMember member
The member this assignment is for -
role
TeamRole role
The role this assignment is for -
trackingData
Tracking trackingData
creation + modification + erasure tracking data
-
-
-
Package ch.colabproject.colab.api.model.token
-
Class ch.colabproject.colab.api.model.token.InvitationToken extends Token implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
recipient
@Size(max=255) String recipient
email address to send the invitation to -
sender
@Size(max=255) String sender
Invitation sender -
teamMember
@NotNull TeamMember teamMember
The member of the project
-
-
Class ch.colabproject.colab.api.model.token.ModelSharingToken extends Token implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
instanceMaker
@NotNull InstanceMaker instanceMaker
The pending instance maker -
recipient
@Size(max=255) String recipient
The email address to send the sharing to -
sender
@Size(max=255) String sender
The sender name
-
-
Class ch.colabproject.colab.api.model.token.ResetLocalAccountPasswordToken extends Token implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
localAccount
@NotNull LocalAccount localAccount
The local account the token is linked to
-
-
Class ch.colabproject.colab.api.model.token.SharingLinkToken extends Token implements Serializable
- serialVersionUID:
- 1L
-
Class ch.colabproject.colab.api.model.token.Token extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
authenticationRequired
@NotNull Boolean authenticationRequired
Indicate whether a token must be consumed by an unauthenticated user -
deletionStatus
DeletionStatus deletionStatus
Is it in a bin or ready to be definitely deleted. Null means active. -
expirationDate
OffsetDateTime expirationDate
token expiration date. TODO: schedule deletion of outdated tokens -
hashedToken
@javax.validation.constraints.NotNull byte[] hashedToken
token hashed with the hashMethod -
hashMethod
@NotNull HashMethod hashMethod
Hash method used to hash the plainText token -
id
Long id
Project ID. -
trackingData
Tracking trackingData
creation + modification + erasure tracking data
-
-
Class ch.colabproject.colab.api.model.token.VerifyLocalAccountToken extends Token implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
localAccount
@NotNull LocalAccount localAccount
The local account the token shall validate
-
-
-
Package ch.colabproject.colab.api.model.user
-
Class ch.colabproject.colab.api.model.user.Account extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
deletionStatus
DeletionStatus deletionStatus
Is it in a bin or ready to be definitely deleted. Null means active. -
httpSessions
List<HttpSession> httpSessions
List of httpSession this account is using -
id
Long id
Account unique ID IDs are unique within all account class hierarchy -
trackingData
Tracking trackingData
creation + modification + erasure tracking data -
user
User user
An account belongs to an user -
userId
Long userId
serialization sugar
-
-
Class ch.colabproject.colab.api.model.user.AuthInfo extends Object implements Serializable
- serialVersionUID:
- 1L
-
Class ch.colabproject.colab.api.model.user.AuthMethod extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
mandatoryMethod
@NotNull HashMethod mandatoryMethod
Hash method used to authenticate -
newSalt
String newSalt
Salt used to prefix the password before hashing it with optional method -
optionalMethod
HashMethod optionalMethod
optional method. Use to migrate to a new method or to change the salt -
salt
@NotNull String salt
Salt used to prefix the password before hashing it with mandatory method
-
-
Class ch.colabproject.colab.api.model.user.HttpSession extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
account
Account account
A HttpSession belongs to an account -
accountId
Long accountId
id of the account used for authentication -
id
Long id
Not so secret id -
lastSeen
OffsetDateTime lastSeen
Last activity date -
rawSessionSecret
@Size(max=255) String rawSessionSecret
raw secret, never persisted, never serialized to client. This is just a temporary field to store the raw value to put in SET-COOKIE -
sessionSecret
@javax.validation.constraints.NotEmpty byte[] sessionSecret
Session secret id. This value is hashed and is persisted in db.DO NOT SERIALIZE IN JSON EVER
-
userAgent
@Size(max=255) String userAgent
User Agent who create the session
-
-
Class ch.colabproject.colab.api.model.user.LocalAccount extends Account implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
clientSalt
@Size(max=255) @NotNull String clientSalt
Salt the client shall use to before hashing its password. Salt is hex-encoded byte array -
currentClientHashMethod
@NotNull HashMethod currentClientHashMethod
Hash method the client shall use to hashedPassword the clientSalt+plain_password -
currentDbHashMethod
@NotNull HashMethod currentDbHashMethod
Hash method to use to hashedPassword the salt+password -
dbSalt
@javax.validation.constraints.NotNull byte[] dbSalt
Salt to used before hashing the password -
email
@Size(max=255) @Email @NotNull String email
username-like email address -
hashedPassword
@javax.validation.constraints.NotNull byte[] hashedPassword
salt+password hash. Hashed with currentDbHashMethod and dbSalt. -
newClientSalt
@Size(max=255) String newClientSalt
New salt the client shall use to prefix its password before hashing it.In case this is not null, client shall send two hashes. First one is the plain_password prefixed with clientSalt and hashed with currentClientHashMethod (to authenticate), second is its password prefixed with this new salt and hashed with nextClientHashMethod if set, current otherwise. successful authentication (to rotate salt and/or method)
-
nextClientHashMethod
HashMethod nextClientHashMethod
New hash method the client shall use to hash its clientSalt+plain_password.In case this is not null, client shall send two hashes. First one is its plain_password prefixed clientSalt and hashed with currentClientHashMethod (to authenticate), second is its password prefixed with the new_salt (if set)or the current salt and hashed with this method
-
nextDbHashMethod
HashMethod nextDbHashMethod
New hash method to use to hash the salt+password. If not null, rotate hash method on next successful authentication -
verified
@NotNull Boolean verified
Has the email address been verified with a VerificationToken ?
-
-
Class ch.colabproject.colab.api.model.user.SignUpInfo extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
affiliation
String affiliation
affiliation -
email
@NotNull String email
user email -
firstname
String firstname
firstname -
hash
@NotNull String hash
hashMethod(salt+password) result -
hashMethod
@NotNull HashMethod hashMethod
Hash method used to generate hash -
lastname
String lastname
lastname -
salt
@NotNull String salt
salt used to prefix plain password -
username
@NotNull String username
username
-
-
Class ch.colabproject.colab.api.model.user.User extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
accounts
List<Account> accounts
List of accounts the user can authenticate with -
activityDate
OffsetDateTime activityDate
Last activity date -
affiliation
@Size(max=255) String affiliation
User affiliation -
agreedTime
OffsetDateTime agreedTime
persisted terms of use and data policy agreement time -
commonname
@Size(max=255) String commonname
short name to be displayed -
deletionStatus
DeletionStatus deletionStatus
Is it in a bin or ready to be definitely deleted. Null means active. -
firstname
@Size(max=255) String firstname
Firstname -
id
Long id
User unique id -
isAdmin
boolean isAdmin
is the user administrator ? -
lastname
@Size(max=255) String lastname
Lastname -
lastSeenAt
OffsetDateTime lastSeenAt
persisted last-activity date -
trackingData
Tracking trackingData
creation + modification + erasure tracking data -
username
@Pattern(regexp="[a-zA-Z0-9_\\-\\.]+") @Size(max=255) @NotNull String username
System-wide unique name. Alphanumeric only
-
-
-
Package ch.colabproject.colab.api.persistence.jcr
-
Class ch.colabproject.colab.api.persistence.jcr.JcrSession extends Object implements Serializable
- serialVersionUID:
- 1L
-
Class ch.colabproject.colab.api.persistence.jcr.JcrSessionManager extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
jcrRepository
JcrRepository jcrRepository
Access to the repository -
sessions
Map<Long,JcrSession> sessions
Opened session mapped by project id
-
-
-
Package ch.colabproject.colab.api.presence.model
-
Class ch.colabproject.colab.api.presence.model.TouchUserPresence extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
cardContentId
Long cardContentId
if of the variant -
cardId
Long cardId
If of the card, may be null -
context
String context
some informative data -
documentId
Long documentId
If of a document -
projectId
@NotNull Long projectId
Id of the project -
selectionEnd
Long selectionEnd
selection end index -
selectionStart
Long selectionStart
selection start index -
wsSessionId
@NotNull String wsSessionId
Websocket session id
-
-
Class ch.colabproject.colab.api.presence.model.UserPresence extends TouchUserPresence implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
date
@NotNull OffsetDateTime date
activity date -
teamMemberId
Long teamMemberId
Id of the team member, if null, it means it's a admin
-
-
-
Package ch.colabproject.colab.api.rest.card.bean
-
Class ch.colabproject.colab.api.rest.card.bean.CardTypeCreationData extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
projectId
Long projectId
The id of the project it belongs to -
purpose
TextDataBlock purpose
The purpose -
tags
Set<String> tags
The tags -
title
String title
The title
-
-
-
Package ch.colabproject.colab.api.rest.document.bean
-
Class ch.colabproject.colab.api.rest.document.bean.ResourceCreationData extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
abstractCardTypeId
Long abstractCardTypeId
The abstract card type id -
cardContentId
Long cardContentId
The card content id -
cardId
Long cardId
The card id -
category
String category
The category of the resource -
documents
List<Document> documents
The document -
published
boolean published
Is it at the disposal of the inheritors -
teaser
TextDataBlock teaser
The teaser of the resource -
title
String title
The title of the resource
-
-
Class ch.colabproject.colab.api.rest.document.bean.ResourceExternalReference extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
project
@NotNull Project project
The project which reference the resource -
usage
@NotNull ResourceExternalReference.Usage usage
project usage of the resource
-
-
Class ch.colabproject.colab.api.rest.document.bean.UrlMetadata extends Object implements Serializable
- serialVersionUID:
- 1L
-
-
Package ch.colabproject.colab.api.rest.link.bean
-
Class ch.colabproject.colab.api.rest.link.bean.StickyNoteLinkCreationData extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
destinationCardId
Long destinationCardId
The ID of the destination card -
explanation
TextDataBlock explanation
The id of the long description -
srcCardContentId
Long srcCardContentId
The ID of the source card content -
srcCardId
Long srcCardId
The id of the source card -
srcDocumentId
Long srcDocumentId
The ID of the source document -
srcResourceOrRefId
Long srcResourceOrRefId
The ID of the source resource / resource reference -
teaser
String teaser
The short description
-
-
-
Package ch.colabproject.colab.api.rest.project.bean
-
Class ch.colabproject.colab.api.rest.project.bean.ProjectCreationData extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
baseProjectId
Long baseProjectId
The project used as a base to create a new project -
description
String description
The description of the project -
duplicationParam
DuplicationParam duplicationParam
Duplication parameters to fine tune what is taken from baseProjectId -
guestsEmail
List<String> guestsEmail
The email address of the people we want to invite -
illustration
Illustration illustration
The icon to illustrate the project -
name
String name
The name of the project -
type
ProjectType type
The kind : project or model
-
-
Class ch.colabproject.colab.api.rest.project.bean.ProjectStructure extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
cardContents
@NotNull Set<CardContent> cardContents
CardContents which belong to the project -
cards
@NotNull Set<Card> cards
Cards which belong to the project -
rootCardId
@NotNull Long rootCardId
Id of the root card
-
-
-
Package ch.colabproject.colab.api.rest.utils
-
Class ch.colabproject.colab.api.rest.utils.SerializationStringWrapper extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
value
String value
the string value
-
-
-
Package ch.colabproject.colab.api.security
-
Class ch.colabproject.colab.api.security.AuthenticationFailure extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
counter
Long counter
Number of failed attempt in a row -
timestamp
OffsetDateTime timestamp
Date of most recent failed attempt
-
-
-
Package ch.colabproject.colab.api.setup
-
Class ch.colabproject.colab.api.setup.ApplicationLifecycle extends javax.servlet.http.HttpServlet implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
applicationLifecycleManager
ApplicationLifecycleManager applicationLifecycleManager
User related methods -
cdiBridgeSingleton
CdiBridgeSingleton cdiBridgeSingleton
CDI bridge -
hzInstance
com.hazelcast.core.HazelcastInstance hzInstance
Hazelcast instance
-
-
-
Package ch.colabproject.colab.api.ws.channel
-
Class ch.colabproject.colab.api.ws.channel.ChannelOverview extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
channel
@NotNull WebsocketChannel channel
Deprecated.The channel -
count
@NotNull Integer count
Deprecated.Number of subscriptions
-
-
-
Package ch.colabproject.colab.api.ws.channel.model
-
Class ch.colabproject.colab.api.ws.channel.model.BlockChannel extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
blockId
Long blockId
id of the block this channel is about.
-
-
Class ch.colabproject.colab.api.ws.channel.model.BroadcastChannel extends Object implements Serializable
- serialVersionUID:
- 1L
-
Class ch.colabproject.colab.api.ws.channel.model.ProjectContentChannel extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
projectId
Long projectId
id of the project this channel is about.
-
-
Class ch.colabproject.colab.api.ws.channel.model.UserChannel extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
userId
Long userId
ID of the channel owner
-
-
-
Package ch.colabproject.colab.api.ws.message
-
Class ch.colabproject.colab.api.ws.message.IndexEntry extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
channelsBuilder
ChannelsBuilders.ChannelsBuilder channelsBuilder
Get the channels this entity shall be sent through. -
id
@NotNull Long id
Object id -
payload
@NotNull Object payload
Some extra data -
type
@NotNull String type
object @class
-
-
Class ch.colabproject.colab.api.ws.message.PrecomputedWsMessages extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
messages
Map<WebsocketChannel,List<String>> messages
Each channel has a list of json-encoded messages
-
-
Class ch.colabproject.colab.api.ws.message.WsChannelUpdate extends WsMessage implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
channel
@NotNull WebsocketChannel channel
The channel this message is about -
diff
@NotNull Integer diff
number of new (un)subscriptions
-
-
Class ch.colabproject.colab.api.ws.message.WsMessage extends Object implements Serializable
-
Class ch.colabproject.colab.api.ws.message.WsPing extends WsMessage implements Serializable
- serialVersionUID:
- 1L
-
Class ch.colabproject.colab.api.ws.message.WsPong extends WsMessage implements Serializable
- serialVersionUID:
- 1L
-
Class ch.colabproject.colab.api.ws.message.WsSessionIdentifier extends WsMessage implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
sessionId
@NotNull String sessionId
Unique session ID
-
-
Class ch.colabproject.colab.api.ws.message.WsSignOutMessage extends WsMessage implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
session
@NotNull HttpSession session
Http session
-
-
Class ch.colabproject.colab.api.ws.message.WsUpdateMessage extends WsMessage implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
deleted
@NotNull Set<IndexEntry> deleted
Set of destroyed objects -
updated
@NotNull Set<WithWebsocketChannels> updated
Set of new or updated objects
-
-
-
Package ch.colabproject.colab.api.ws.utils
-
Class ch.colabproject.colab.api.ws.utils.CallableGetChannel extends Object implements Serializable
- serialVersionUID:
- 1L
-
-
Package ch.colabproject.colab.generator.model.exceptions
-
Class ch.colabproject.colab.generator.model.exceptions.HttpErrorMessage extends HttpException implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
messageCode
HttpErrorMessage.MessageCode messageCode
Error message -
messageI18nKey
MessageI18nKey messageI18nKey
The key of the translation to display
-
-
Class ch.colabproject.colab.generator.model.exceptions.HttpException extends RuntimeException implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
httpStatus
javax.ws.rs.core.Response.Status httpStatus
HTTP status
-
-
-
Package ch.colabproject.colab.generator.model.interfaces
-
Package ch.colabproject.colab.generator.plugin.rest
-
Class ch.colabproject.colab.generator.plugin.rest.ClientException extends HttpException implements Serializable
- serialVersionUID:
- 1L
-
Class ch.colabproject.colab.generator.plugin.rest.ServerException extends HttpException implements Serializable
- serialVersionUID:
- 1L
-