Package org.exoplatform.caldav.plugin

Interface CalendarServerSeed

public interface CalendarServerSeed
A server registration a calendar server product asks the host to write on a first install, beside the host's own default (EXO-90737): the pre-filled row an administrator edits into their own server.

When it is read. While the host's context finishes, on every boot: a contributor whose web application starts after the host's has not finished its own context yet, so a seed holds values only, and no collaborator.

How it is found. CalendarServerSeedRegistry collects every bean implementing this interface, across web applications: a contributor is a Spring @Service, never final. Contributions are read in order (Ordered), and the first one for an id() is the one seeded: a later contribution with the same identifier is ignored, so a product seeds one row however many of its contributions are installed.

What the host keeps for itself. A seed describes the row; it never decides whether the row arrives switched on, nor which agenda provider it is bridged to. The host seeds only an empty registry, puts the address through the check an administrator's address meets and activates the row only when it passes, names the provider, and turns the quirks into the row's tolerance columns. An install that already holds registrations is never seeded again, so a contribution installed later adds no row.

What happens without one. The host seeds its own default only.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    id()
    The seed's stable identifier — the product's, the same as its server flavour's — which decides which of two contributions for one product is seeded.
    default org.exoplatform.caldav.model.MirrorTargetKind
    mirrorTarget()
    Which calendar of the account the row mirrors eXo's events into.
    String
    name()
    The name the row is seeded under.
    default List<org.exoplatform.caldav.model.ServerQuirk>
    quirks()
    The catalogue entries the row arrives excused for, the same ones the product's browser preset ticks.
    String
    serverUrl()
    The address the row is seeded with, usually a placeholder the administrator replaces with their own server's.
    default org.exoplatform.caldav.model.WriteChannel
    writeChannel()
    The channel the row writes eXo's copies through.

  • Method Details

    • id

      String id()
      The seed's stable identifier — the product's, the same as its server flavour's — which decides which of two contributions for one product is seeded.
      Returns:
      the identifier, never blank

    • name

      String name()
      The name the row is seeded under.
      Returns:
      the name, never blank

    • serverUrl

      String serverUrl()
      The address the row is seeded with, usually a placeholder the administrator replaces with their own server's.
      Returns:
      the address, never blank

    • quirks

      default List<org.exoplatform.caldav.model.ServerQuirk> quirks()
      The catalogue entries the row arrives excused for, the same ones the product's browser preset ticks. Only tolerance entries can be seeded; an entry that changes what eXo writes is logged and left out.
      Returns:
      the entries, never null, possibly empty

    • mirrorTarget

      default org.exoplatform.caldav.model.MirrorTargetKind mirrorTarget()
      Which calendar of the account the row mirrors eXo's events into.
      Returns:
      the destination, never null

    • writeChannel

      default org.exoplatform.caldav.model.WriteChannel writeChannel()
      The channel the row writes eXo's copies through.
      Returns:
      the channel, never null