Package org.exoplatform.caldav.client

Class CalDavEndpoint

java.lang.Object
org.exoplatform.caldav.client.CalDavEndpoint
public final class CalDavEndpoint extends Object
Where a CalDAV conversation is allowed to go: the scheme and authority of one administrator-declared server, plus the account's base collection path on it. This class is the client's registry-only containment made structural — its only constructor is package-private, so the single place an endpoint can be minted is HttpCalDavClient.endpoint(Long, String), which resolves the target exclusively from the server registry (and its legacy deployment-property fallback). No caller outside this package can hand the client a URL of its own choosing, which is the same containment style as the relay resolving targets only from registry rows.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAuthProviderName()
    Name of the credentials provider the registration is configured with — enough, with getExoLogin(), to rebuild a credentials context for every request without reading the registry again.
    String
    getBasePath()
    The server-absolute path of the account base — hrefs the server answers (BlueMind roots its own at /dav/) are resolved against this endpoint's authority, never against a caller-supplied one.
    URI
    getBaseUri()
    The account's base URI on the declared server — where discovery starts.
    String
    getExoLogin()
    The eXo login this endpoint was minted for.
    Long
    getServerId()
    The registry row this endpoint was resolved from.
    String
    toString()
    Names the endpoint without ever naming credentials — safe in logs.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Method Details

    • getServerId

      public Long getServerId()
      The registry row this endpoint was resolved from.
      Returns:
      the row id, or null when the legacy property resolved the URL

    • getBaseUri

      public URI getBaseUri()
      The account's base URI on the declared server — where discovery starts.
      Returns:
      the absolute base URI

    • getBasePath

      public String getBasePath()
      The server-absolute path of the account base — hrefs the server answers (BlueMind roots its own at /dav/) are resolved against this endpoint's authority, never against a caller-supplied one.
      Returns:
      the raw base path, always starting with a slash

    • getAuthProviderName

      public String getAuthProviderName()
      Name of the credentials provider the registration is configured with — enough, with getExoLogin(), to rebuild a credentials context for every request without reading the registry again.
      Returns:
      the provider name, or null when this endpoint was minted from a DAV account name rather than for an eXo user

    • getExoLogin

      public String getExoLogin()
      The eXo login this endpoint was minted for. Deliberately the login and not the DAV account: it is what a credentials context identifies a user by, and what a provider resolves its own view of that user from.
      Returns:
      the eXo login, or null when this endpoint was minted from a DAV account name

    • toString

      public String toString()
      Names the endpoint without ever naming credentials — safe in logs.
      Overrides:
      toString in class Object
      Returns:
      the endpoint described by server id and base URI