Skip navigation links
A B C D E F G H I L M P R S T U V W Y 

A

AppService - Interface in com.mulesoft.runtime.upgrade.tool.service.api
A service for operations related to the upgrade tool app.
AssemblyEntry - Class in com.mulesoft.runtime.upgrade.tool.domain
File Descriptor Entity.
AssemblyEntry(String, long, String) - Constructor for class com.mulesoft.runtime.upgrade.tool.domain.AssemblyEntry
 
AssemblyEntry() - Constructor for class com.mulesoft.runtime.upgrade.tool.domain.AssemblyEntry
 

B

BackupDescriptor - Class in com.mulesoft.runtime.upgrade.tool.domain
This class provides information about the backup generated after executing the tool.
BackupDescriptor() - Constructor for class com.mulesoft.runtime.upgrade.tool.domain.BackupDescriptor
 
BackupDescriptor(Instant, String, String) - Constructor for class com.mulesoft.runtime.upgrade.tool.domain.BackupDescriptor
 
BackupDescriptor.Builder - Class in com.mulesoft.runtime.upgrade.tool.domain
 
backupGenerationTimestamp(Instant) - Method in class com.mulesoft.runtime.upgrade.tool.domain.BackupDescriptor.Builder
 
BackupService - Interface in com.mulesoft.runtime.upgrade.tool.service.api
A service for backup related operations.
build() - Method in class com.mulesoft.runtime.upgrade.tool.domain.BackupDescriptor.Builder
 
build() - Method in class com.mulesoft.runtime.upgrade.tool.domain.MuleDistribution.Builder
 
build() - Method in class com.mulesoft.runtime.upgrade.tool.domain.RollbackOptions.Builder
 
build() - Method in class com.mulesoft.runtime.upgrade.tool.domain.UpgradeOptions.Builder
 
builder() - Static method in class com.mulesoft.runtime.upgrade.tool.domain.BackupDescriptor
 
Builder() - Constructor for class com.mulesoft.runtime.upgrade.tool.domain.BackupDescriptor.Builder
 
builder() - Static method in class com.mulesoft.runtime.upgrade.tool.domain.MuleDistribution
 
Builder() - Constructor for class com.mulesoft.runtime.upgrade.tool.domain.MuleDistribution.Builder
 
builder() - Static method in class com.mulesoft.runtime.upgrade.tool.domain.RollbackOptions
 
Builder() - Constructor for class com.mulesoft.runtime.upgrade.tool.domain.RollbackOptions.Builder
 
builder() - Static method in class com.mulesoft.runtime.upgrade.tool.domain.UpgradeOptions
 
Builder() - Constructor for class com.mulesoft.runtime.upgrade.tool.domain.UpgradeOptions.Builder
 

C

call() - Method in class com.mulesoft.runtime.upgrade.tool.command.RollbackCommand
 
call() - Method in class com.mulesoft.runtime.upgrade.tool.command.StatusCommand
 
call() - Method in class com.mulesoft.runtime.upgrade.tool.command.UpgradeCommand
 
checkBackupExistence(Path) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.PreconditionsValidatorService
Checks existence of any BackUp.
checkBackupExistence(Path) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultPreconditionsValidatorService
Checks existence of any BackUp.
checkClusterModeIsActive(Path) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.MuleDistroService
Checks if current mule distro is working on cluster mode.
checkClusterModeIsActive(Path) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultMuleDistroService
Checks if current mule distro is working on cluster mode.
checkConsoleExistence() - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultUserInteractionService
 
checkEnoughUsableSpace(Path, Path, List<Path>) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.FileSystemService
Validates whether there is potentially enough writable space on the file system for the upgrade.
checkEnoughUsableSpace(Path, Path, List<Path>) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultFileSystemService
Validates whether there is potentially enough writable space on the file system for the upgrade.
checkIsADirectory(Path) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.FileSystemService
Checks whether a given path corresponds to a directory.
checkIsADirectory(Path) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultFileSystemService
Checks whether a given path corresponds to a directory.
checkReadingAccess(Path, List<Path>) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.FileSystemService
Checks whether the JVM has reading access to all file trees determined by the given relative paths when resolved against the given parent path.
checkReadingAccess(Path, List<Path>) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultFileSystemService
Checks whether the JVM has reading access to all file trees determined by the given relative paths when resolved against the given parent path.
checkRollbackPreconditions(Path) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.PreconditionsValidatorService
Checks that all preconditions for performing the rollback are met.
checkRollbackPreconditions(Path) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultPreconditionsValidatorService
Checks rollback pre-conditions for status command.
checkRollbackReadiness(Path) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.PreconditionsValidator
Checks that all preconditions for performing the rollback are met.
checkRollbackReadiness(Path) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultPreconditionsValidator
Checks that all preconditions for performing the rollback are met.
checkStopped(Path) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.MuleStatusService
Checks whether a Mule Runtime distribution is stopped.
checkStopped(Path) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultMuleStatusService
Checks whether a Mule Runtime distribution is stopped.
checkUpgradePreconditions(MuleDistribution, MuleDistribution, boolean) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.PreconditionsValidatorService
Checks that all preconditions for performing the upgrade are met.
checkUpgradePreconditions(MuleDistribution, MuleDistribution, boolean) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultPreconditionsValidatorService
Checks that all preconditions for performing the upgrade are met.
checkUpgradeReadiness(MuleDistribution, MuleDistribution, boolean) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.PreconditionsValidator
Checks that all preconditions for performing the upgrade are met.
checkUpgradeReadiness(MuleDistribution, MuleDistribution, boolean) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultPreconditionsValidator
Checks that all preconditions for performing the upgrade are met.
checkUpgradeStatusOffline(MuleDistribution) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.PreconditionsValidatorService
Checks upgrade pre-conditions for status command.
checkUpgradeStatusOffline(MuleDistribution) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultPreconditionsValidatorService
Checks upgrade pre-conditions for status command.
checkWritingAccess(Path, List<Path>) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.FileSystemService
Check whether the JVM has writing access to all file trees determined by the given relative paths when resolved against the given parent path.
checkWritingAccess(Path, List<Path>) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultFileSystemService
Checks whether the JVM has writing access to all file trees determined by the given relative paths when resolved against the given parent path.
com.mulesoft.runtime.upgrade.tool - package com.mulesoft.runtime.upgrade.tool
 
com.mulesoft.runtime.upgrade.tool.command - package com.mulesoft.runtime.upgrade.tool.command
 
com.mulesoft.runtime.upgrade.tool.domain - package com.mulesoft.runtime.upgrade.tool.domain
 
com.mulesoft.runtime.upgrade.tool.domain.enums - package com.mulesoft.runtime.upgrade.tool.domain.enums
 
com.mulesoft.runtime.upgrade.tool.service - package com.mulesoft.runtime.upgrade.tool.service
 
com.mulesoft.runtime.upgrade.tool.service.api - package com.mulesoft.runtime.upgrade.tool.service.api
 
com.mulesoft.runtime.upgrade.tool.service.utils - package com.mulesoft.runtime.upgrade.tool.service.utils
 
com.mulesoft.runtime.upgrade.tool.utils - package com.mulesoft.runtime.upgrade.tool.utils
 
compareMuleDistros(Path, Path) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.DescriptorService
This method creates file descriptor of the current mule version and then compares with the newest file descriptor version.
compareMuleDistros(Path, Path) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultDescriptorService
This method creates file descriptor of the current mule version and then compares with the newest file descriptor version.
compareTo(SemVer) - Method in class com.mulesoft.runtime.upgrade.tool.domain.SemVer
 
confirmAction(String, String, boolean) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.UserInteractionService
Requests yes/no confirmation for an action given its description.
confirmAction(String, String, boolean) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultUserInteractionService
Requests yes/no confirmation for an action given its description.
copyBackFiles(Path) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultRollbackService
 
copyFiles(Path, Path, List<Path>) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.FileSystemService
Recursively copy all the files and directories determined by the given relative paths from the given source directory to the given destination directory.
copyFiles(Path, Path, List<Path>) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultFileSystemService
Recursively copy all the files and directories determined by the given relative paths from the given source directory to the given destination directory.
create(MuleDistribution, List<Path>) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.BackupService
Creates a backup copy of the given file paths within the Mule distribution directory that will be undergoing the upgrade.
create(MuleDistribution, List<Path>) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultBackupService
This function creates the backup descriptor.

D

DEFAULT_NEW_MULE_DISTRO_PATH - Static variable in class com.mulesoft.runtime.upgrade.tool.service.DefaultUpgradeService
Upgrade tool jar is assumed to be located at /mule-home/tools directory
DEFAULT_NO_SUFFIX_PROMPT - Static variable in class com.mulesoft.runtime.upgrade.tool.service.DefaultUserInteractionService
 
DEFAULT_YES_SUFFIX_PROMPT - Static variable in class com.mulesoft.runtime.upgrade.tool.service.DefaultUserInteractionService
 
DefaultAppService - Class in com.mulesoft.runtime.upgrade.tool.service
A service for operations related to the upgrade tool app.
DefaultAppService() - Constructor for class com.mulesoft.runtime.upgrade.tool.service.DefaultAppService
 
DefaultBackupService - Class in com.mulesoft.runtime.upgrade.tool.service
A service for backup related operations.
DefaultBackupService() - Constructor for class com.mulesoft.runtime.upgrade.tool.service.DefaultBackupService
 
DefaultDescriptorService - Class in com.mulesoft.runtime.upgrade.tool.service
This service manages file descriptor's functionalities.
DefaultDescriptorService() - Constructor for class com.mulesoft.runtime.upgrade.tool.service.DefaultDescriptorService
 
DefaultDistroPatchService - Class in com.mulesoft.runtime.upgrade.tool.service
A service for Mule distribution patches handling.
DefaultDistroPatchService() - Constructor for class com.mulesoft.runtime.upgrade.tool.service.DefaultDistroPatchService
 
DefaultFileSystemService - Class in com.mulesoft.runtime.upgrade.tool.service
A service for file system operations required for the upgrade or backup.
DefaultFileSystemService() - Constructor for class com.mulesoft.runtime.upgrade.tool.service.DefaultFileSystemService
 
DefaultMuleDistroService - Class in com.mulesoft.runtime.upgrade.tool.service
A service for MuleDistribution operations.
DefaultMuleDistroService() - Constructor for class com.mulesoft.runtime.upgrade.tool.service.DefaultMuleDistroService
 
DefaultMuleStatusService - Class in com.mulesoft.runtime.upgrade.tool.service
A service for Mule Runtime process-related operations.
DefaultMuleStatusService() - Constructor for class com.mulesoft.runtime.upgrade.tool.service.DefaultMuleStatusService
 
DefaultPreconditionsValidator - Class in com.mulesoft.runtime.upgrade.tool.service
A preconditions validator for the tool's main processes.
DefaultPreconditionsValidator() - Constructor for class com.mulesoft.runtime.upgrade.tool.service.DefaultPreconditionsValidator
 
DefaultPreconditionsValidatorService - Class in com.mulesoft.runtime.upgrade.tool.service
A preconditions validator for the tool's main processes.
DefaultPreconditionsValidatorService() - Constructor for class com.mulesoft.runtime.upgrade.tool.service.DefaultPreconditionsValidatorService
 
DefaultRollbackService - Class in com.mulesoft.runtime.upgrade.tool.service
Service to rollback a Mule Runtime distribution upgrade from a backup.
DefaultRollbackService() - Constructor for class com.mulesoft.runtime.upgrade.tool.service.DefaultRollbackService
 
DefaultStatusService - Class in com.mulesoft.runtime.upgrade.tool.service
A service for status command.
DefaultStatusService() - Constructor for class com.mulesoft.runtime.upgrade.tool.service.DefaultStatusService
 
DefaultUpgradeConfigService - Class in com.mulesoft.runtime.upgrade.tool.service
Service for loading upgrade tool configuration.
DefaultUpgradeConfigService() - Constructor for class com.mulesoft.runtime.upgrade.tool.service.DefaultUpgradeConfigService
 
DefaultUpgradeService - Class in com.mulesoft.runtime.upgrade.tool.service
Service to upgrade a Mule Runtime distribution.
DefaultUpgradeService() - Constructor for class com.mulesoft.runtime.upgrade.tool.service.DefaultUpgradeService
 
DefaultUserInteractionService - Class in com.mulesoft.runtime.upgrade.tool.service
Service for interacting with the end user.
DefaultUserInteractionService() - Constructor for class com.mulesoft.runtime.upgrade.tool.service.DefaultUserInteractionService
 
DefaultYamlService - Class in com.mulesoft.runtime.upgrade.tool.service
Service for marshalling and unmarshalling of values in YAML format.
DefaultYamlService() - Constructor for class com.mulesoft.runtime.upgrade.tool.service.DefaultYamlService
 
DescriptorService - Interface in com.mulesoft.runtime.upgrade.tool.service.api
This service manages file descriptor's functionalities.
detectMuleVersion(Path) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.MuleDistroService
Detects Mule Runtime Distribution version.
detectMuleVersion(Path) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultMuleDistroService
Detects Mule Runtime Distribution version.
DistroPatchService - Interface in com.mulesoft.runtime.upgrade.tool.service.api
A services for Mule distribution patches handling.

E

equals(Object) - Method in class com.mulesoft.runtime.upgrade.tool.domain.AssemblyEntry
 
equals(Object) - Method in class com.mulesoft.runtime.upgrade.tool.domain.SemVer
 
executeQueryStatusCommand(String[]) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultMuleStatusService
 
ExecutionExceptionHandler - Class in com.mulesoft.runtime.upgrade.tool.command
This class handles any exception which happened during the execution of the tool.
ExecutionExceptionHandler() - Constructor for class com.mulesoft.runtime.upgrade.tool.command.ExecutionExceptionHandler
 
ExitCodeExceptionMapper - Class in com.mulesoft.runtime.upgrade.tool.command
Implementation of CommandLine.IExitCodeExceptionMapper to meet the mapping exit code business rules of the runtime upgrade tool commands.
ExitCodeExceptionMapper() - Constructor for class com.mulesoft.runtime.upgrade.tool.command.ExitCodeExceptionMapper
 

F

FileSystemService - Interface in com.mulesoft.runtime.upgrade.tool.service.api
A service for file system operations required for the upgrade.
force(boolean) - Method in class com.mulesoft.runtime.upgrade.tool.domain.RollbackOptions.Builder
 
force(boolean) - Method in class com.mulesoft.runtime.upgrade.tool.domain.UpgradeOptions.Builder
 
formatAppliedPatches(List<File>) - Static method in class com.mulesoft.runtime.upgrade.tool.utils.PrettyPrintingFormatter
 
formatBackupDescriptor(BackupDescriptor) - Static method in class com.mulesoft.runtime.upgrade.tool.utils.PrettyPrintingFormatter
 
formatStatusCommandMessage(List<String>) - Static method in class com.mulesoft.runtime.upgrade.tool.utils.PrettyPrintingFormatter
 

G

getAllDefinedPaths() - Static method in class com.mulesoft.runtime.upgrade.tool.service.utils.PathDefinitionUtils
Get the list of all defined paths that are involved in the upgrade process.
getAllPaths() - Static method in enum com.mulesoft.runtime.upgrade.tool.domain.enums.PathsToBeAdditionallyBackedUp
Gets the list of all Path defined by all the values of this enumeration.
getAllPaths() - Static method in enum com.mulesoft.runtime.upgrade.tool.domain.enums.PathsToBeReplaced
Gets the list of all Path defined by all the values of this enumeration.
getAllPaths() - Static method in enum com.mulesoft.runtime.upgrade.tool.domain.enums.PathToBeExcluded
Gets the list of all Path defined by all the values of this enumeration.
getAppliedPatches(Path) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.DistroPatchService
Retrieves all the file paths of the applied patches of a given Mule Runtime Distribution if any.
getAppliedPatches(Path) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultDistroPatchService
Retrieves all the file paths of the applied patches of a given Mule Runtime Distribution if any.
getBackupDescriptorFileName() - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.UpgradeConfigService
Gets the name for the backup descriptor file.
getBackupDescriptorFileName() - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultUpgradeConfigService
 
getBackupFolderName() - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.UpgradeConfigService
Gets the name for the backup folder from the configuration.
getBackupFolderName() - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultUpgradeConfigService
 
getBackupGenerationTimestamp() - Method in class com.mulesoft.runtime.upgrade.tool.domain.BackupDescriptor
 
getClock() - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultBackupService
 
getConsentForOverwritingBackup(boolean) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.PreconditionsValidatorService
Asks consent for overwriting the current BackUp.
getConsentForOverwritingBackup(boolean) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultPreconditionsValidatorService
Asks consent for overwriting the current BackUp.
getEnvVariable(String) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultMuleStatusService
 
getExitCode(Throwable) - Method in class com.mulesoft.runtime.upgrade.tool.command.ExitCodeExceptionMapper
 
getExitCode() - Method in class com.mulesoft.runtime.upgrade.tool.MuleRuntimeUpgradeToolApplication
 
getLocation() - Method in class com.mulesoft.runtime.upgrade.tool.domain.MuleDistribution
 
getMajor() - Method in class com.mulesoft.runtime.upgrade.tool.domain.SemVer
 
getMinor() - Method in class com.mulesoft.runtime.upgrade.tool.domain.SemVer
 
getMuleBinaryPath() - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultMuleStatusService
 
getMuleRuntimeDistributionVersion() - Method in class com.mulesoft.runtime.upgrade.tool.domain.BackupDescriptor
 
getName() - Method in class com.mulesoft.runtime.upgrade.tool.domain.AssemblyEntry
 
getName() - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.AppService
Retrieves the current mule runtime upgrade tool app name.
getName() - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultAppService
 
getNewMuleDistroPath(Path) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultUpgradeService
 
getPatch() - Method in class com.mulesoft.runtime.upgrade.tool.domain.SemVer
 
getPath() - Method in enum com.mulesoft.runtime.upgrade.tool.domain.enums.PathsToBeAdditionallyBackedUp
 
getPath() - Method in enum com.mulesoft.runtime.upgrade.tool.domain.enums.PathsToBeReplaced
 
getPath() - Method in enum com.mulesoft.runtime.upgrade.tool.domain.enums.PathToBeExcluded
 
getSha256() - Method in class com.mulesoft.runtime.upgrade.tool.domain.AssemblyEntry
 
getSizeInBytes() - Method in class com.mulesoft.runtime.upgrade.tool.domain.AssemblyEntry
 
getSuffix() - Method in class com.mulesoft.runtime.upgrade.tool.domain.SemVer
 
getUpgradeToolVersion() - Method in class com.mulesoft.runtime.upgrade.tool.domain.BackupDescriptor
 
getVersion() - Method in class com.mulesoft.runtime.upgrade.tool.command.UpgradeToolVersionProvider
 
getVersion() - Method in class com.mulesoft.runtime.upgrade.tool.domain.MuleDistribution
 
getVersion() - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.AppService
Retrieves the current mule runtime upgrade tool app version.
getVersion() - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultAppService
 

H

handleExecutionException(Exception, CommandLine, CommandLine.ParseResult) - Method in class com.mulesoft.runtime.upgrade.tool.command.ExecutionExceptionHandler
 
handleParseException(CommandLine.ParameterException, String[]) - Method in class com.mulesoft.runtime.upgrade.tool.command.ParameterExceptionHandler
 
hashCode() - Method in class com.mulesoft.runtime.upgrade.tool.domain.SemVer
 

I

initMuleDistro(Path) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.MuleDistroService
Initializes a MuleDistribution object after validating that the given file path corresponds to a Mule Runtime distribution.
initMuleDistro(Path) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultMuleDistroService
Initializes a MuleDistribution object after validating that the given file path corresponds to a Mule Runtime distribution.
isClusterModeActive(File, String) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultMuleDistroService
 
isForce() - Method in class com.mulesoft.runtime.upgrade.tool.domain.RollbackOptions
 
isForce() - Method in class com.mulesoft.runtime.upgrade.tool.domain.UpgradeOptions
 
isWindowsOs() - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.FileSystemService
Checks whether the underlying OS is Windows.
isWindowsOs() - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultFileSystemService
Checks whether the underlying OS is Windows.

L

location(Path) - Method in class com.mulesoft.runtime.upgrade.tool.domain.MuleDistribution.Builder
 
looksLikeADistro(Path) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.MuleDistroService
Introspects the given directory to determine if it looks like a Mule Runtime distribution.
looksLikeADistro(Path) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultMuleDistroService
Introspects the given directory to determine if it looks like a Mule Runtime distribution.

M

main(String[]) - Static method in class com.mulesoft.runtime.upgrade.tool.MuleRuntimeUpgradeToolApplication
 
MULE_CORE_JAR_DIRECTORY_PATH - Static variable in class com.mulesoft.runtime.upgrade.tool.service.DefaultMuleDistroService
 
MuleDistribution - Class in com.mulesoft.runtime.upgrade.tool.domain
This class provides the location and the version of the current mule distribution.
MuleDistribution(Path, String) - Constructor for class com.mulesoft.runtime.upgrade.tool.domain.MuleDistribution
 
MuleDistribution.Builder - Class in com.mulesoft.runtime.upgrade.tool.domain
 
MuleDistroService - Interface in com.mulesoft.runtime.upgrade.tool.service.api
A service for MuleDistribution operations.
muleRuntimeDistributionVersion(String) - Method in class com.mulesoft.runtime.upgrade.tool.domain.BackupDescriptor.Builder
 
MuleRuntimeUpgradeToolApplication - Class in com.mulesoft.runtime.upgrade.tool
Main class of the tool.
MuleRuntimeUpgradeToolApplication() - Constructor for class com.mulesoft.runtime.upgrade.tool.MuleRuntimeUpgradeToolApplication
 
MuleStatusService - Interface in com.mulesoft.runtime.upgrade.tool.service.api
A service for Mule Runtime process-related operations.

P

ParameterExceptionHandler - Class in com.mulesoft.runtime.upgrade.tool.command
This class handles any exception which happened during parsing of parameters at the moment the tool was executed.
ParameterExceptionHandler() - Constructor for class com.mulesoft.runtime.upgrade.tool.command.ParameterExceptionHandler
 
PATCHES_DIR - Static variable in class com.mulesoft.runtime.upgrade.tool.service.DefaultDistroPatchService
 
PathDefinitionUtils - Class in com.mulesoft.runtime.upgrade.tool.service.utils
Utils class for easing the treatment of enums where paths involved in the upgrade process are defined.
PathDefinitionUtils() - Constructor for class com.mulesoft.runtime.upgrade.tool.service.utils.PathDefinitionUtils
 
PathsToBeAdditionallyBackedUp - Enum in com.mulesoft.runtime.upgrade.tool.domain.enums
Defines all the paths of files that should be additionally backed up because are somehow impacted by the upgrade process.
PathsToBeReplaced - Enum in com.mulesoft.runtime.upgrade.tool.domain.enums
Defines all the paths of files that should be replaced as part of the upgrade process.
PathToBeExcluded - Enum in com.mulesoft.runtime.upgrade.tool.domain.enums
Defines all the paths of files that should be excluded of the back up and upgrade process.
preconditionRollbackStatus(Path) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultStatusService
 
PreconditionsValidator - Interface in com.mulesoft.runtime.upgrade.tool.service.api
A preconditions validator for the tool main processes.
PreconditionsValidatorService - Interface in com.mulesoft.runtime.upgrade.tool.service.api
A preconditions validator for the tool main processes.
preconditionUpgradeStatus(Path) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultStatusService
 
PrettyPrintingFormatter - Class in com.mulesoft.runtime.upgrade.tool.utils
Class for creating pretty String representation of domain objects like the backup descriptor or applied patches list that could be used for formatted printing in a writer.
printBackUpDescriptor(Optional<BackupDescriptor>) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.BackupService
Prints a BackUp Descriptor with a pretty format .
printBackUpDescriptor(Optional<BackupDescriptor>) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultBackupService
Prints a BackUp Descriptor with a pretty format .

R

readBackupDescriptor(Path) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.BackupService
Retrieves the backup creation metadata stored in the YAML file within the backup directory location if any has been previously generated as part of an upgrade process.
readBackupDescriptor(Path) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultBackupService
This function reads the backup descriptor.
readValue(File, Class<T>) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.YamlService
Deserializes a YAML value to a Java one from a given file.
readValue(File, Class<T>) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultYamlService
Deserializes a YAML value to a Java one from a given file.
REQUIRED_DISK_SPACE_SLACK_MULTIPLIER - Static variable in class com.mulesoft.runtime.upgrade.tool.service.DefaultFileSystemService
 
rollback(Path, RollbackOptions) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.RollbackService
Rolls back a Mule Runtime distribution upgrade from a backup if any exists.
rollback(Path, RollbackOptions) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultRollbackService
Rolls back a Mule Runtime distribution upgrade from a backup if any exists.
RollbackCommand - Class in com.mulesoft.runtime.upgrade.tool.command
This class implements the rollback command received by command line.
RollbackCommand() - Constructor for class com.mulesoft.runtime.upgrade.tool.command.RollbackCommand
 
RollbackOptions - Class in com.mulesoft.runtime.upgrade.tool.domain
A class that encapsulates all config options for the rollback process.
RollbackOptions() - Constructor for class com.mulesoft.runtime.upgrade.tool.domain.RollbackOptions
 
RollbackOptions(boolean) - Constructor for class com.mulesoft.runtime.upgrade.tool.domain.RollbackOptions
 
RollbackOptions.Builder - Class in com.mulesoft.runtime.upgrade.tool.domain
 
RollbackPreconditions - Enum in com.mulesoft.runtime.upgrade.tool.domain.enums
Enumeration of all preconditions needed for performing a rollback.
RollbackService - Interface in com.mulesoft.runtime.upgrade.tool.service.api
Service to rollback a Mule Runtime distribution upgrade from a backup.
run(String...) - Method in class com.mulesoft.runtime.upgrade.tool.MuleRuntimeUpgradeToolApplication
 

S

SemVer - Class in com.mulesoft.runtime.upgrade.tool.domain
A non SemVer compliant spec class, tailored to the requirements of this business domain.
setBackupDescriptorFileName(String) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultUpgradeConfigService
 
setBackupFolderWithinUpgradingMule(String) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultUpgradeConfigService
 
setClock(Clock) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultBackupService
 
setIn(InputStream) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultUserInteractionService
 
setName(String) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultAppService
 
setNewMuleDistro(Path) - Method in class com.mulesoft.runtime.upgrade.tool.command.UpgradeCommand
 
setOldMuleDistro(Path) - Method in class com.mulesoft.runtime.upgrade.tool.command.RollbackCommand
 
setOldMuleDistro(Path) - Method in class com.mulesoft.runtime.upgrade.tool.command.StatusCommand
 
setOldMuleDistro(Path) - Method in class com.mulesoft.runtime.upgrade.tool.command.UpgradeCommand
 
setOut(PrintStream) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultUserInteractionService
 
setVersion(String) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultAppService
 
StatusCommand - Class in com.mulesoft.runtime.upgrade.tool.command
This class implements the status command received by command line.
StatusCommand() - Constructor for class com.mulesoft.runtime.upgrade.tool.command.StatusCommand
 
statusCommandExecute(Path) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.StatusService
Runs different processes for showing to the user some relevant information about Mule distribution and possible actions for executing with the tool.
statusCommandExecute(Path) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultStatusService
Runs different processes for showing to the user some relevant information about Mule distribution and possible actions for executing with the tool.
StatusService - Interface in com.mulesoft.runtime.upgrade.tool.service.api
A service for status command.

T

TopCommand - Class in com.mulesoft.runtime.upgrade.tool.command
 
TopCommand() - Constructor for class com.mulesoft.runtime.upgrade.tool.command.TopCommand
 
toString() - Method in class com.mulesoft.runtime.upgrade.tool.domain.SemVer
 

U

upgrade(Path, Path, UpgradeOptions) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.UpgradeService
Upgrades a Mule Runtime distribution based on a new given one.
upgrade(Path, Path, UpgradeOptions) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultUpgradeService
Upgrades a Mule Runtime distribution based on a new given one.
UpgradeCommand - Class in com.mulesoft.runtime.upgrade.tool.command
This class implements the upgrade command received by command line.
UpgradeCommand() - Constructor for class com.mulesoft.runtime.upgrade.tool.command.UpgradeCommand
 
UpgradeConfigService - Interface in com.mulesoft.runtime.upgrade.tool.service.api
Service for loading upgrade tool configuration.
UpgradeOptions - Class in com.mulesoft.runtime.upgrade.tool.domain
A class that encapsulates all config options for the upgrade process.
UpgradeOptions() - Constructor for class com.mulesoft.runtime.upgrade.tool.domain.UpgradeOptions
 
UpgradeOptions(boolean) - Constructor for class com.mulesoft.runtime.upgrade.tool.domain.UpgradeOptions
 
UpgradeOptions.Builder - Class in com.mulesoft.runtime.upgrade.tool.domain
 
UpgradePreconditions - Enum in com.mulesoft.runtime.upgrade.tool.domain.enums
Enumeration of all preconditions needed for performing an upgrade.
UpgradeService - Interface in com.mulesoft.runtime.upgrade.tool.service.api
Service to upgrade a Mule Runtime distribution.
upgradeToolVersion(String) - Method in class com.mulesoft.runtime.upgrade.tool.domain.BackupDescriptor.Builder
 
UpgradeToolVersionProvider - Class in com.mulesoft.runtime.upgrade.tool.command
This class gets to know the version of upgrade tool.
UpgradeToolVersionProvider() - Constructor for class com.mulesoft.runtime.upgrade.tool.command.UpgradeToolVersionProvider
 
USER_REJECTED_TO_PROCEED_WITH_THE_ROLLBACK_PROCESS_MESSAGE - Static variable in class com.mulesoft.runtime.upgrade.tool.service.DefaultRollbackService
 
USER_REJECTED_TO_PROCEED_WITH_THE_UPGRADE_PROCESS_MESSAGE - Static variable in class com.mulesoft.runtime.upgrade.tool.service.DefaultUpgradeService
 
UserInteractionService - Interface in com.mulesoft.runtime.upgrade.tool.service.api
Service for interacting with the end user.

V

valueOf(String) - Static method in enum com.mulesoft.runtime.upgrade.tool.domain.enums.PathsToBeAdditionallyBackedUp
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mulesoft.runtime.upgrade.tool.domain.enums.PathsToBeReplaced
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mulesoft.runtime.upgrade.tool.domain.enums.PathToBeExcluded
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mulesoft.runtime.upgrade.tool.domain.enums.RollbackPreconditions
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mulesoft.runtime.upgrade.tool.domain.enums.UpgradePreconditions
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in class com.mulesoft.runtime.upgrade.tool.domain.SemVer
Gets a SemVer value after performing a naive and lightway parsing of the given string.
values() - Static method in enum com.mulesoft.runtime.upgrade.tool.domain.enums.PathsToBeAdditionallyBackedUp
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mulesoft.runtime.upgrade.tool.domain.enums.PathsToBeReplaced
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mulesoft.runtime.upgrade.tool.domain.enums.PathToBeExcluded
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mulesoft.runtime.upgrade.tool.domain.enums.RollbackPreconditions
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mulesoft.runtime.upgrade.tool.domain.enums.UpgradePreconditions
Returns an array containing the constants of this enum type, in the order they are declared.
version(String) - Method in class com.mulesoft.runtime.upgrade.tool.domain.MuleDistribution.Builder
 

W

writeValueToFile(File, Object) - Method in interface com.mulesoft.runtime.upgrade.tool.service.api.YamlService
Serializes any Java value as YAML in the given file.
writeValueToFile(File, Object) - Method in class com.mulesoft.runtime.upgrade.tool.service.DefaultYamlService
Serializes any Java value as YAML in the given file.

Y

YamlService - Interface in com.mulesoft.runtime.upgrade.tool.service.api
Service for marshalling and unmarshalling of values in YAML format.
YES_NO_PROMPT - Static variable in class com.mulesoft.runtime.upgrade.tool.service.DefaultUserInteractionService
 
A B C D E F G H I L M P R S T U V W Y 
Skip navigation links

Copyright © 2021 MuleSoft, Inc.. All rights reserved.