Uploaded image for project: 'James Server'
  1. James Server
  2. JAMES-3189

Document Javadoc for all 144 Guice Modules

    XMLWordPrintableJSON

    Details

    • Type: Task
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Documentation
    • Labels:
      None

      Description

      From the mailing list:

       

      This documentation effort would be a great move toward James as a toolkit to write your own email server. We of course had it in mind during Guice adoption, but not yet had feedback on the topic.
      Although quite tedious, I propose as a first step that I simply ask questions about each of the 144 Guice Modules in the system. I will take notes in the form of Javadoc in order to keep the information together with the code. Just knowing what they are intended for will be a good start. Once each of them is documented, I think it should be easier to analyze what to do with it. 
      

      These are the Modules:

      • BlobStoreAPIModule
      • BlobExportMechanismModule
      • LinshareBlobExportMechanismModule
      • LocalFileBlobExportMechanismModule
      • BlobMemoryModule
      • ObjectStorageBlobStoreModule
      • ObjectStorageDependenciesModule
      • MyExtensionModule
      • CassandraDLPConfigurationStoreModule
      • CassandraDomainListModule
      • CassandraJmapModule
      • CassandraMailRepositoryModule
      • CassandraRecipientRewriteTableModule
      • CassandraSieveRepositoryModule
      • CassandraUsersRepositoryModule
      • CassandraEventStoreModule
      • CassandraBlobStoreModule
      • CassandraCacheSessionModule
      • CassandraDeadLetterModule
      • CassandraDeletedMessageVaultModule
      • CassandraMailboxModule
      • CassandraQuotaMailingModule
      • CassandraQuotaModule
      • CassandraSessionModule
      • ElasticSearchClientModule
      • ElasticSearchMailboxModule
      • ElasticSearchQuotaSearcherModule
      • TikaMailboxModule
      • CassandraMetricsModule
      • CassandraRoutesModule
      • InconsistencySolvingRoutesModule
      • SolveMailboxInconsistenciesModules
      • SolveMessageInconsistenciesModules
      • TestDockerElasticSearchModule
      • TestDockerESMetricReporterModule
      • TestTikaModule
      • LdapUsersRepositoryModule
      • BlobStoreChoosingModule
      • RabbitMQEventBusModule
      • DistributedTaskManagerModule
      • TaskSerializationModule
      • TestAwsS3BlobStoreModule
      • TestRabbitMQModule
      • TestSwiftBlobStoreModule
      • ActiveMQQueueModule
      • ProtocolHandlerModule
      • DefaultProcessorsConfigurationProviderModule
      • DNSServiceModule
      • DropWizardMetricsModule
      • HostnameModule
      • LoggingMetricsModule
      • MailStoreRepositoryModule
      • RawPostDequeueDecoratorModule
      • TaskManagerModule
      • CleanupTaskModule
      • ClockModule
      • CommonServicesModule
      • IsStartedProbeModule
      • MailetProcessingModule
      • MimeMessageModule
      • PeriodicalHealthChecksModule
      • StartablesModule
      • StartUpChecksModule
      • ElasticSearchMetricReporterModule
      • IMAPServerModule
      • JMAPCommonModule
      • JMAPModule
      • MethodsModule
      • JMAPDraftServerModule
      • TestJMAPServerModule
      • SearchModule
      • JMXServerModule
      • LMTPServerModule
      • DefaultEventModule
      • FastRetryBackoffModule
      • MemoryDeadLetterModule
      • PreDeletionHookModule
      • MailboxModule
      • SpamAssassinListenerModule
      • CamelMailetContainerModule
      • DKIMMailetModule
      • ManageSieveServerModule
      • SieveModule
      • NettyServerModule
      • POP3ServerModule
      • RabbitMQModule
      • SieveFileRepositoryModule
      • SieveJPARepositoryModules
      • JSPFModule
      • SMTPServerModule
      • MyExtensionModule
      • ExtensionModule
      • HealthCheckRoutesModule
      • NoJwtModule
      • TaskRoutesModule
      • WebAdminServerModule
      • DataRoutesModules
      • DLPRoutesModule
      • SieveRoutesModule
      • JmapTasksModule
      • InconsistencyQuotasSolvingRoutesModule
      • MailboxesBackupModule
      • MailboxesExportRoutesModule
      • MailboxesRoutesModule
      • MailboxRoutesModule
      • MessagesRoutesModule
      • ReIndexingModule
      • MailQueueRoutesModule
      • MailRepositoriesRoutesModule
      • SwaggerRoutesModule
      • SpamAssassinModule
      • JPADataModule
      • JPADomainListModule
      • JPAEntityManagerModule
      • JPAMailRepositoryModule
      • JPARecipientRewriteTableModule
      • JPAUsersRepositoryModule
      • TestJPAConfigurationModule
      • TestJPAConfigurationModuleWithSqlValidation
      • NoDatabaseAuthentication
      • WithDatabaseAuthentication
      • JPAMailboxModule
      • JpaQuotaModule
      • JPAQuotaSearchModule
      • LuceneSearchMailboxModule
      • TestJPAConfigurationModule
      • DeletedMessageVaultModule
      • DeletedMessageVaultRetentionModule
      • DeletedMessageVaultRoutesModule
      • TestDeleteMessageVaultPreDeletionHookModule
      • MemoryDataJmapModule
      • MemoryDataModule
      • MemoryEventStoreModule
      • MemoryMailboxModule
      • MemoryQuotaModule
      • MemoryQuotaSearchModule
      • MemoryMailQueueModule
      • FakeSearchMailboxModule
      • LifeCycleModule
      • MultiLifeCycleTestCase
      • UnauthorizedModule
      • WebadminIntegrationTestModule
      • SpamAssassinModule
      • TestingSessionModule

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                dleangen David Leangen
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated: