Package org.exoplatform.onlyoffice

Class Config.Builder

java.lang.Object
org.exoplatform.onlyoffice.Config.Builder
Enclosing class:
Config
public static class Config.Builder extends Object
The Class Builder.

  • Field Details

    • docId

      protected final String docId
      The document ID in storage.

    • workspace

      protected final String workspace
      The workspace of the storage.

    • path

      protected final String path
      The path.

    • documentType

      protected final String documentType
      The document type.

    • documentserverUrl

      protected final String documentserverUrl
      The documentserver url.

    • platformRestUrl

      protected String platformRestUrl
      The platform REST URL base.

    • editorUrl

      protected String editorUrl
      The editor page at platform URL.

    • documentserverSecret

      protected String documentserverSecret
      The document server secret key.

    • lastModifier

      protected String lastModifier
      The last modifier.

    • lastModified

      protected String lastModified
      The lastModified.

    • displayPath

      protected String displayPath
      The display path.

    • downloadUrl

      protected String downloadUrl
      The download url for viewer mode.

    • comment

      protected String comment
      The comment.

    • drive

      protected String drive
      The drive.

    • renameAllowed

      protected Boolean renameAllowed
      The rename allowed indicator.

    • isActivity

      protected Boolean isActivity
      The indicator to show if the document has a file activity.

    • explorerUri

      protected URI explorerUri
      The ECMS explorer page URL.

    • fileType

      protected String fileType
      The document.

    • key

      protected String key
      The document.

    • title

      protected String title
      The document.

    • url

      protected String url
      The document.

    • owner

      protected String owner
      The folder.

    • uploaded

      protected String uploaded
      The folder.

    • folder

      protected String folder
      The folder.

    • callbackUrl

      protected String callbackUrl
      The editor.

    • lang

      protected String lang
      The editor.

    • mode

      protected String mode
      The editor.

    • userId

      protected String userId
      The user.

    • name

      protected String name
      The user.

    • allowEdition

      protected boolean allowEdition

  • Constructor Details

    • Builder

      protected Builder(String documentserverUrl, String documentType, String workspace, String path, String docId)
      Instantiates a new builder.
      Parameters:
      documentserverUrl - the document server URL
      documentType - the document type
      workspace - the workspace
      path - the path
      docId - the doc id

  • Method Details

    • generateUrls

      public Config.Builder generateUrls(String platformRestUrl)
      Generate file and callback URLs using given Platform base URL. This will erase these URLs explicitly set previously.
      Parameters:
      platformRestUrl - the platform URL
      Returns:
      the builder

    • editorUrl

      public Config.Builder editorUrl(String editorUrl)
      Editor page URL.
      Parameters:
      editorUrl - the editor url
      Returns:
      the builder

    • explorerUri

      public Config.Builder explorerUri(URI uri)
      URI of ECMS explorer page with a document.
      Parameters:
      uri - the URI of the page
      Returns:
      the builder

    • explorerUri

      public Config.Builder explorerUri(String url)

    • title

      public Config.Builder title(String title)
      Title.
      Parameters:
      title - the title
      Returns:
      the builder

    • key

      public Config.Builder key(String key)
      Key.
      Parameters:
      key - the key
      Returns:
      the builder

    • fileType

      public Config.Builder fileType(String fileType)
      File type.
      Parameters:
      fileType - the file type
      Returns:
      the builder

    • url

      public Config.Builder url(String url)
      Url.
      Parameters:
      url - the url
      Returns:
      the builder

    • owner

      public Config.Builder owner(String owner)
      Owner.
      Parameters:
      owner - the owner
      Returns:
      the builder

    • uploaded

      public Config.Builder uploaded(Calendar uploadedTime)
      Uploaded.
      Parameters:
      uploadedTime - the created time
      Returns:
      the builder

    • uploaded

      public Config.Builder uploaded(String date)

    • displayPath

      public Config.Builder displayPath(String displayPath)
      Display path.
      Parameters:
      displayPath - the created displayPath
      Returns:
      the builder

    • comment

      public Config.Builder comment(String comment)
      Comment.
      Parameters:
      comment - the created comment
      Returns:
      the builder

    • drive

      public Config.Builder drive(String drive)
      Drive.
      Parameters:
      drive - the created drive
      Returns:
      the builder

    • renameAllowed

      public Config.Builder renameAllowed(Boolean renameAllowed)
      Rename allowed.
      Parameters:
      renameAllowed - the renameAllowed
      Returns:
      the builder

    • isActivity

      public Config.Builder isActivity(Boolean isActivity)
      IsActivity.
      Parameters:
      isActivity - the has isActivity
      Returns:
      the builder

    • folder

      public Config.Builder folder(String folder)
      Folder.
      Parameters:
      folder - the folder
      Returns:
      the builder

    • callbackUrl

      public Config.Builder callbackUrl(String callbackUrl)
      Callback url.
      Parameters:
      callbackUrl - the callback url
      Returns:
      the builder

    • lang

      public Config.Builder lang(String lang)
      Lang.
      Parameters:
      lang - the lang
      Returns:
      the builder

    • mode

      public Config.Builder mode(String mode)
      Mode.
      Parameters:
      mode - the mode
      Returns:
      the builder

    • userId

      public Config.Builder userId(String userId)
      User id.
      Parameters:
      userId - the user id
      Returns:
      the builder

    • userName

      public Config.Builder userName(String name)
      User name.
      Parameters:
      name - the name
      Returns:
      the builder

    • secret

      public Config.Builder secret(String documentServerSecret)
      Secret.
      Parameters:
      documentServerSecret - the document server secret
      Returns:
      the builder

    • lastModifier

      public Config.Builder lastModifier(String lastModifier)
      Sets last modifier.
      Parameters:
      lastModifier - the last Modifier
      Returns:
      the builder

    • lastModified

      public Config.Builder lastModified(String lastModified)
      Sets last modified.
      Parameters:
      lastModified - the last modified
      Returns:
      the builder

    • downloadUrl

      public Config.Builder downloadUrl(String downloadUrl)
      Download url.
      Parameters:
      downloadUrl - the download url
      Returns:
      the builder

    • setAllowEdition

      public Config.Builder setAllowEdition(boolean allowEdition)
      Allow edition
      Parameters:
      allowEdition - the allowEdition
      Returns:
      the builder

    • build

      public Config build()
      Builds the.
      Returns:
      the config