Class Update

All Implemented Interfaces:
org.nuxeo.connect.update.task.Command
Direct Known Subclasses:
UpdateAndDeploy

public class Update extends AbstractCommand
Since:
5.5
Author:
Bogdan Stefanescu
  • Field Details

    • ID

      public static final String ID
      See Also:
    • file

      protected File file
      The source file. It can be a file or a directory.
    • todir

      protected File todir
      The target file. It can be a directory since 5.5
    • removeOnExit

      protected boolean removeOnExit
    • allowDowngrade

      protected boolean allowDowngrade
    • upgradeOnly

      protected boolean upgradeOnly
  • Constructor Details

    • Update

      protected Update(String id)
    • Update

      public Update()
  • Method Details

    • initialize

      public void initialize(Element element) throws org.nuxeo.connect.update.PackageException
      Specified by:
      initialize in interface org.nuxeo.connect.update.task.Command
      Overrides:
      initialize in class AbstractCommand
      Throws:
      org.nuxeo.connect.update.PackageException
    • readFrom

      public void readFrom(Element element) throws org.nuxeo.connect.update.PackageException
      Description copied from class: AbstractCommand
      Must be implemented to initialize the command arguments from an XML fragment.
      Specified by:
      readFrom in class AbstractCommand
      Throws:
      org.nuxeo.connect.update.PackageException
    • writeTo

      public void writeTo(org.nuxeo.connect.update.xml.XmlWriter writer)
    • doValidate

      protected void doValidate(org.nuxeo.connect.update.task.Task task, org.nuxeo.connect.update.ValidationStatus status) throws org.nuxeo.connect.update.PackageException
      Description copied from class: AbstractCommand
      Override to implement validation.
      Specified by:
      doValidate in class AbstractCommand
      Parameters:
      task - The task being validated
      status - Use ValidationStatus.addError(String) or ValidationStatus.addWarning(String) to provide validation error/warning messages
      Throws:
      org.nuxeo.connect.update.PackageException
    • doRun

      protected org.nuxeo.connect.update.task.Command doRun(org.nuxeo.connect.update.task.Task task, Map<String,String> prefs) throws org.nuxeo.connect.update.PackageException
      Description copied from class: AbstractCommand
      Override to implement command actions
      Specified by:
      doRun in class AbstractCommand
      Returns:
      Rollback command
      Throws:
      org.nuxeo.connect.update.PackageException
    • updateDirectory

      protected CompositeCommand updateDirectory(org.nuxeo.connect.update.task.Task task, File dir, UpdateManager mgr) throws org.nuxeo.connect.update.PackageException
      Throws:
      org.nuxeo.connect.update.PackageException
    • updateFile

      protected Rollback updateFile(org.nuxeo.connect.update.task.Task task, File fileToUpdate, UpdateManager mgr) throws org.nuxeo.connect.update.PackageException
      Throws:
      org.nuxeo.connect.update.PackageException
    • getDeployCommand

      protected org.nuxeo.connect.update.task.Command getDeployCommand(UpdateManager updateManager, org.nuxeo.connect.update.task.Command rollbackCommand)
      Method to be overridden by subclasses to provide a deploy command for hot reload
      Since:
      5.6
    • getFile

      public File getFile()
      Since:
      9.3